Module protocol

This module contains the types and functions used to encode and decode Fast messages. The contents of this module are not needed for normal client or server consumers of this crate, but they are exposed for the special case of someone needing to implement custom client or server code.

Structs

FastMessage

Represents a Fast message including the header and data payload

FastMessageData

Encapsulates the Fast message metadata and the JSON formatted message data.

FastMessageHeader

This type encapsulates the header of a Fast message.

FastMessageId

A data type representing a Fast message id that can safely be shard between threads. The next associated function retrieves the next id value and manages the circular message id space internally.

FastMessageMetaData

Represents the metadata about a FastMessage data payload. This includes a timestamp and an RPC method name.

FastMessageServerError

An error type representing Fast error messages that may be returned from a Fast server.

FastRpc

This type implements the functions necessary for the Fast protocl framing.

Enums

FastMessageStatus

Represents the Status field of a Fast message.

FastMessageType

Represents the Type field of a Fast message. Currently there is only one valid value, JSON.

FastParseError

An error type representing a failure to parse a buffer as a Fast message.

Constants

FP_HEADER_SZ

The size of a Fast message header