The protocol namespace contains classes that define the framework for implementing and accessing Wisp service protocols. More...
Namespaces |
|
| detail | |
| The protocol::detail namespace defines implementation-specific structures that are not intended for use by library client code. |
|
Classes |
|
| class | Caller |
| class | CallException |
| A CallException is thrown when a call cannot complete because of an unexpected condition. More... |
|
| struct | CallHeader |
| Every call is described by a CallHeader followed by a message. More... |
|
| struct | CallTraits |
| The three-parameter CallTraits template defines all the type information characterizing a TwoWay call. More... |
|
| struct | CallTraits< CallerType, ParameterType, detail::VoidReturnType > |
| The two-parameter CallTraits template defines all the type information characterizing a OneWay call. More... |
|
| struct | MessageInfo |
| Stores all information associated with a received call, including the raw message data. More... |
|
Typedefs |
|
| typedef std::uint32_t | wisp_call_token |
| The type of a call token. More... |
|
| typedef std::uint8_t | wisp_call_role |
| The type used by the CallHeader to store the CallRole of the call being made. More... |
|
| typedef std::shared_ptr< MessageInfo > | message_info_ptr |
Enumerations |
|
| enum | CallType { OneWay, TwoWay } |
| CallType defines allowable messaging call types. More... |
|
| enum | CallRole { OneWayRequest, TwoWayRequest, TwoWayResponse } |
| The role of a call being made. More... |
|
Variables |
|
| const Message::Service | DefaultMessageServiceType = Message::SafeSelfDiscard |
| Wisp calls can request a Spread message service type if desired. More... |
|
| const bool | GroupMembershipEnable = true |
| const bool | GroupMembershipDisable = false |
Detailed Description
The protocol namespace contains classes that define the framework for implementing and accessing Wisp service protocols.
Typedef Documentation
§ message_info_ptr
| typedef std::shared_ptr<MessageInfo> ssrc::wisp::protocol::message_info_ptr |
§ wisp_call_role
| typedef std::uint8_t ssrc::wisp::protocol::wisp_call_role |
The type used by the CallHeader to store the CallRole of the call being made.
§ wisp_call_token
| typedef std::uint32_t ssrc::wisp::protocol::wisp_call_token |
Enumeration Type Documentation
§ CallRole
The role of a call being made.
This is similar to CallType, but is used in the CallHeader to identify the role of a message participating in a call.
| Enumerator | |
|---|---|
| OneWayRequest |
The message is part of a OneWay call. |
| TwoWayRequest |
The message is initiating a TwoWay call. |
| TwoWayResponse |
The message is completing a TwoWay call. |
§ CallType
CallType defines allowable messaging call types.
Currently only one-way and two-way calls are supported. In the future, a multi-way call type may be added, involving a single request and multiple responses (from different responder). A streaming call may also be added, where a single request results in a stream of responses from a single responder.
| Enumerator | |
|---|---|
| OneWay |
A fire and forget invocation. No return value is expected. |
| TwoWay |
Requires a single request and a single response. |
Variable Documentation
§ DefaultMessageServiceType
| const Message::Service ssrc::wisp::protocol::DefaultMessageServiceType = Message::SafeSelfDiscard |
Wisp calls can request a Spread message service type if desired.
If not specified, DefaultMessageServiceType is used.
Definition at line 50 of file Caller.h.
Referenced by ssrc::wisp::protocol::Caller< PT >::call().
§ GroupMembershipDisable
| const bool ssrc::wisp::protocol::GroupMembershipDisable = false |
§ GroupMembershipEnable