Skip to main content

Module framing

Module framing 

Source

Structs§

RequestFrame
Decoded request whose body remains borrowed from the FIN-delimited frame.
RequestPrelude
Decoded request prelude used before a streaming body is consumed.

Enums§

FrameError
Malformed or oversized hosted-call framing.
ResponseFrame
Decoded unary response outcome.
StreamFrame
One length-delimited item within a server or bidirectional stream.

Constants§

MAX_CALL_CONTEXT
Largest encoded call context accepted before dispatch.
MAX_CONTROL_BODY
Largest protobuf control body carried in a FIN-delimited frame.
MAX_METHOD_PATH
Largest fully-qualified method path accepted by the hosted-call protocol.
MAX_RAW_BODY
Largest raw pack/index phase declared on one operation stream.

Functions§

decode_request_frame
Decodes a complete FIN-delimited request frame.
decode_request_prelude
Incrementally decodes the method and typed context at an operation-stream start.
decode_response_frame
Decodes a complete FIN-delimited unary response frame.
decode_stream_frame
Decodes one item from a streaming receive buffer.
encode_failure_response
Encodes a contract-owned unary failure; stream FIN delimits the envelope.
encode_failure_response_into
Reuses frame for a contract-owned unary failure.
encode_request_frame
Encodes method_len:u16be | context_len:u32be | method | context | body. The operation stream FIN is the outer delimiter.
encode_request_prelude
Encodes the method and typed context that precede a streaming body.
encode_stream_failure
Encodes one terminal failure for a streaming operation.
encode_stream_failure_into
Reuses frame for one terminal stream failure.
encode_stream_message
Encodes one protobuf message for a streaming operation.
encode_stream_message_into
Reuses frame for one protobuf stream message.
encode_stream_raw_body
Encodes a raw-body header. Exactly length uninterpreted bytes follow it before the next framed stream item.
encode_stream_raw_body_into
Reuses frame for a raw-body header.
encode_success_response
Encodes a successful unary response; stream FIN delimits the body.
encode_success_response_into
Reuses frame for a successful unary response.