Module honk_rpc

Source

Structs§

Session
The object that handles the communication between two endpoints using the Honk-RPC protocol. Provides methods for setting and getting configuration parameters, reading and processing message documents, and handling API requests and responses.

Enums§

Error
The error type for the Session type.
ErrorCode
Represents various error codes that can be present in a Honk-RPC error_section
Response
Represents the response to a client request.

Constants§

DEFAULT_MAX_MESSAGE_SIZE
The default maximum allowed Honk-RPC message (4096 bytes)
DEFAULT_MAX_WAIT_TIME
The default maximum allowed duration between Honk-RPC (60 seconds)

Traits§

ApiSet
The ApiSet trait represents a set of APIs that can be remotely invoked by a connecting Honk-RPC client.

Functions§

get_error_section_size
Computes the required size of a Honk-RPC error section in bytes.
get_message_overhead
Computes the overhead of the Honk-RPC message type. This method in conjunction with the other get_*_section_size(..) functions can be used to compute the size of a Honk-RPC message with exactly one section.
get_request_section_size
Computes the required size of a Honk-RPC requests section in bytes.
get_response_section_size
Computes the required size of a Honk-RPC response section in bytes.

Type Aliases§

RequestCookie
A type alias for the cookie used to track client requests.