Preview of the proposed up-rust native-frame-model branch (up-rust b6b99c6d, up-spec f0e9b17) — not released documentation. branch · write-up

Module communication

Source
Expand description

Traits representing uProtocol’s Communication Layer API for publishing and subscribing to topics and for invoking RPC methods. Also contains default implementations of the traits employing uProtocol’s Transport & Session Layer API.

Modules§

owned
Owned native-frame communication-layer facade.
zero_copy
Zero-copy communication-layer facade.

Structs§

CallOptions
General options that clients might want to specify when sending a uProtocol message.
InMemoryRpcClient
An RpcClient which keeps all information about pending requests in memory.
InMemoryRpcServer
An RpcServer which keeps all information about registered endpoints in memory.
InMemorySubscriber
A Subscriber which keeps all information about registered subscription change handlers in memory.
MockNotifier
A client for sending Notification messages to a uEntity.
MockRequestHandler
A handler for processing incoming RPC requests.
MockRpcClient
A client for performing Remote Procedure Calls (RPC) on (other) uEntities.
MockRpcServerImpl
This extra struct is necessary in order to comply with mockall’s requirements regarding the parameter lifetimes see https://github.com/asomers/mockall/issues/571
MockSubscriptionChangeHandler
Callback invoked when a subscription’s status changes.
SimpleNotifier
A Notifier that uses the uProtocol Transport Layer API to send and receive notifications to/from (other) uEntities.
SimplePublisher
A Publisher that uses the uProtocol Transport Layer API for publishing events to topics.
UPayload
A wrapper around (raw) message payload data and the corresponding payload format.

Enums§

NotificationError
An error indicating a problem with sending a notification to another uEntity.
PubSubError
An error indicating a problem with publishing a message to a topic.
RegistrationError
An error indicating a problem with registering or unregistering a message listener.
ServiceInvocationError
An error indicating a problem with invoking a (remote) service operation.
SubscriptionStatus
The current status of a client’s subscription to a topic.

Traits§

Notifier
A client for sending Notification messages to a uEntity.
Publisher
A client for publishing messages to a topic.
RequestHandler
A handler for processing incoming RPC requests.
RpcClient
A client for performing Remote Procedure Calls (RPC) on (other) uEntities.
RpcServer
A server for exposing Remote Procedure Call (RPC) endpoints.
Subscriber
A client for subscribing to topics.
SubscriptionChangeHandler
Callback invoked when a subscription’s status changes.