Skip to content

UURLabZmqRpcTransport

ZMQ REQ/REP adapter. Owned by UURLabBridgeServer; binds a

REP socket on StepEndpoint and runs a polling worker thread. Wire framing only — dispatcher lookup + encoding live on the base.

Attribute Value
Kind Class
UE Macro UCLASS
Inherits UURLabRpcTransport

Properties

Public Properties

Property Type Description
StepEndpoint FString
PollTimeoutMs int32 Polling interval for the REP socket in milliseconds.

StepEndpoint

  • Type: FString
  • Editor: ✏️ EditAnywhere
  • Blueprint: 🔵 ReadWrite
  • Category: ZMQ

PollTimeoutMs

Polling interval for the REP socket in milliseconds.

  • Type: int32
  • Editor: ✏️ EditAnywhere
  • Blueprint: 🔵 ReadWrite
  • Category: ZMQ

Functions

Public Functions

General

Function Returns Description
AcceptsEditorOps() bool ZMQ accepts every op; SHM is the only transport that refuses.
SetOwningBridge() void Bridge that owns this transport. Set once at construction by the
TransportInit() bool Bind sockets / mmap regions / start the worker thread. Returns
TransportShutdown() void Stop the worker thread, release handles. Idempotent.
GetTransportName() FString Human-readable transport name for logs ("zmq" / "shm" / future
ProcessRequestBytes() bool Shared request handler. Concrete transports call this from their
ResolveDispatcher() FURLabRpcDispatcher* Resolve the live dispatcher. Always goes through the owning
AcceptsEditorOps

ZMQ accepts every op; SHM is the only transport that refuses.

  • Signature: AcceptsEditorOps()
  • Returns: bool
SetOwningBridge

Bridge that owns this transport. Set once at construction by the

TransportInit

Bind sockets / mmap regions / start the worker thread. Returns

  • Signature: TransportInit()
  • Returns: bool
TransportShutdown

Stop the worker thread, release handles. Idempotent.

  • Signature: TransportShutdown()
GetTransportName

Human-readable transport name for logs ("zmq" / "shm" / future

  • Signature: GetTransportName()
  • Returns: FString
ProcessRequestBytes

Shared request handler. Concrete transports call this from their

  • Signature: ProcessRequestBytes(const TArray<uint8>& InBytes, TArray<uint8>& OutReplyBytes)
  • Returns: bool
ResolveDispatcher

Resolve the live dispatcher. Always goes through the owning

Private Functions

General

Function Returns Description
RunPollLoop() void Worker thread loop. Runs zmq_poll on the REP socket and forwards each
RunPollLoop

Worker thread loop. Runs zmq_poll on the REP socket and forwards each

  • Signature: RunPollLoop()