cpp-msgpack-rpc 0.2.0
An RPC library implementing MessagePack RPC.
Loading...
Searching...
No Matches
msgpack_rpc::messages Namespace Reference

Namespace of messages. More...

Namespaces

namespace  impl
 Namespace of internal implementations.

Classes

class  BufferView
 Class of buffers without memory management. More...
class  CallResult
 Class of results of methods. More...
class  MessageParser
 Class to parse messages. More...
class  MessageSerializer
 Class to serialize messages. More...
class  MethodName
 Class of method names. More...
class  MethodNameView
 Class of method names. More...
class  ParsedNotification
 Class of parsed notification. More...
class  ParsedParameters
 Class of parsed parameters. More...
class  ParsedRequest
 Class of parsed requests. More...
class  ParsedResponse
 Class of parsed responses. More...
class  SerializedMessage
 Class of serialized message data. More...

Typedefs

using MessageID = std::uint32_t
 Type of message IDs.
using ParsedMessage
 Type of parsed messages.

Enumerations

enum class  MessageType : std::uint8_t { REQUEST = 0 , RESPONSE = 1 , NOTIFICATION = 2 }
 Enumeration of message types. More...

Functions

std::string_view format_message_type (MessageType type) noexcept
 Format a message type.
bool operator!= (const MethodName &left, const MethodName &right) noexcept
 Compare two method names.
bool operator!= (MethodNameView left, MethodNameView right) noexcept
 Compare two method names.
bool operator== (const MethodName &left, const MethodName &right) noexcept
 Compare two method names.
bool operator== (MethodNameView left, MethodNameView right) noexcept
 Compare two method names.

Detailed Description

Namespace of messages.

Typedef Documentation

◆ MessageID

using msgpack_rpc::messages::MessageID = std::uint32_t

Type of message IDs.

Definition at line 27 of file message_id.h.

◆ ParsedMessage

Initial value:
std::variant<ParsedRequest, ParsedResponse, ParsedNotification>

Type of parsed messages.

Definition at line 33 of file parsed_message.h.

Enumeration Type Documentation

◆ MessageType

enum class msgpack_rpc::messages::MessageType : std::uint8_t
strong

Enumeration of message types.

Note
Values are same as values in MessagePack-RPC specification.
Enumerator
REQUEST 

Request.

RESPONSE 

Response.

NOTIFICATION 

Notification.

Definition at line 34 of file message_type.h.

Function Documentation

◆ format_message_type()

std::string_view msgpack_rpc::messages::format_message_type ( MessageType type)
nodiscardnoexcept

Format a message type.

Parameters
[in]typeMessage type.
Returns
Formatted string.

Definition at line 24 of file message_type.cpp.

◆ operator!=() [1/2]

bool msgpack_rpc::messages::operator!= ( const MethodName & left,
const MethodName & right )
inlinenodiscardnoexcept

Compare two method names.

Parameters
[in]leftLeft-hand-side object.
[in]rightRight-hand-side object.
Return values
trueTwo names are different.
falseTwo names are equal.

Definition at line 127 of file method_name.h.

◆ operator!=() [2/2]

bool msgpack_rpc::messages::operator!= ( MethodNameView left,
MethodNameView right )
inlinenodiscardnoexcept

Compare two method names.

Parameters
[in]leftLeft-hand-side object.
[in]rightRight-hand-side object.
Return values
trueTwo names are different.
falseTwo names are equal.

Definition at line 150 of file method_name_view.h.

◆ operator==() [1/2]

bool msgpack_rpc::messages::operator== ( const MethodName & left,
const MethodName & right )
inlinenodiscardnoexcept

Compare two method names.

Parameters
[in]leftLeft-hand-side object.
[in]rightRight-hand-side object.
Return values
trueTwo names are equal.
falseTwo names are different.

Definition at line 114 of file method_name.h.

◆ operator==() [2/2]

bool msgpack_rpc::messages::operator== ( MethodNameView left,
MethodNameView right )
inlinenodiscardnoexcept

Compare two method names.

Parameters
[in]leftLeft-hand-side object.
[in]rightRight-hand-side object.
Return values
trueTwo names are equal.
falseTwo names are different.

Definition at line 137 of file method_name_view.h.