moonbitstack/moonrpc/stream

README
U
BidiHandler
U
CallReply
U
ClientCall
U
ConnectionPool
U
ConnectivityState
U
DnsRecord
U
DnsResponse
U
FieldDescriptor
U
FieldLabel
U
FieldType
U
FileDescriptor
U
H2Client
U
H2Server
U
Handler
U
HealthService
U
HedgingPolicy
U
Keepalive
U
LbPolicy
U
LoadBalancer
U
MessageDescriptor
U
Method
U
MethodDescriptor
U
PbError
U
PbReader
U
PbWriter
U
ReflectionRequest
U
ReflectionResponse
U
ReflectionService
U
RetryPolicy
U
RpcContext
U
ServiceDescriptor
U
ServingStatus
U
SrvStream
U
Status
U
Stream
U
StreamError
U
StreamEvent
U
StreamInterceptor
U
StreamState
U
SubConn
U
UnaryInterceptor
U
WireType
V
decode_file_descriptor_set
V
decode_health_request
V
decode_health_response
V
decode_message
V
decode_reflection_request
V
decode_reflection_response
V
default_max_frame_size
V
default_max_streams
V
default_window_size
V
dns_decode_response
V
dns_encode_query
V
dns_type_a
V
dns_type_aaaa
V
encode_file_descriptor_set
V
encode_grpc_timeout
V
encode_health_request
V
encode_health_response
V
encode_message
V
encode_reflection_request
V
health_check_path
V
health_watch_path
V
is_binary_metadata
V
max_header_list_size
V
max_message_size
V
message_len
V
metadata_value_from_wire
V
metadata_value_to_wire
V
parse_grpc_timeout
V
percent_decode
V
reflection_v1_path
V
reflection_v1alpha_path
V
split_messages
V
stream_id_valid_for_initiator
V
stream_is_client_initiated
V
stream_is_server_initiated

moonbitstack/moonrpc/stream does not have a README file

StreamError

pub suberror StreamError {
  InvalidTransition(String)
} derive(Eq)

An illegal stream transition (RFC 7540 §5.1): a frame not permitted in the current state (typically a STREAM_CLOSED or PROTOCOL_ERROR condition).

impl Show for StreamError

StreamError::equal

source

fn StreamError::equal(StreamError, StreamError) -> Bool

StreamError::not_equal

source

fn StreamError::not_equal(x : StreamError, y : StreamError) -> Bool

StreamError::output

source

fn StreamError::output(self : StreamError, logger : &Logger) -> Unit

StreamError::to_string

source

fn StreamError::to_string(self : StreamError) -> String

BidiHandler

source

pub(all) struct BidiHandler {
  on_message : (Bytes) -> Array[Bytes]
  on_end : () -> Array[Bytes]
}

A live bidirectional call. on_message is invoked once per fully-received request message and returns the reply messages to send right then; on_end runs after the client half-closes and returns the final replies. Both feed the same flow-controlled response stream, so responses interleave with requests.

Handler

source

pub(all) enum Handler {
  Unary((RpcContext, Bytes) -> Bytes)
  ServerStreaming((RpcContext, Bytes) -> Array[Bytes])
  ClientStreaming((RpcContext, Array[Bytes]) -> Bytes)
  Bidi((RpcContext) -> BidiHandler)
}

A registered method, in one of gRPC's four cardinalities. The reply shape mirrors the request shape: streaming handlers produce an ordered Array[Bytes] of messages, each framed as its own length-prefixed gRPC message on the wire.

RpcContext

source

pub(all) struct RpcContext {
  path : String
  metadata : Array[@moonbitstack/moonhttp/header.Header
Header]
  deadline_millis : Int?
  resp_headers : Array[@moonbitstack/moonhttp/header.Header
Header]
  resp_trailers : Array[@moonbitstack/moonhttp/header.Header
Header]
  status_fail : (Int, String)?
  error_details : Array[Bytes]
}

The context surfaced to a handler for one RPC call: the invoked :path, the request metadata (custom HEADERS, minus the pseudo- and reserved gRPC headers), the deadline parsed from grpc-timeout (in milliseconds, None when absent), and mutable slots for response initial metadata and trailing metadata the handler can set before it returns.

RpcContext::add_error_detail

source

fn RpcContext::add_error_detail(self : RpcContext, detail : Bytes) -> Unit

Attach a rich-error detail (a serialized google.protobuf.Any) to a failing call. The server packs the status code, message, and every detail into a google.rpc.Status and sends it base64-encoded in the grpc-status-details-bin trailer — gRPC's rich-error channel. Combine with fail, which sets the base grpc-status / grpc-message.

RpcContext::add_header

source

fn RpcContext::add_header(self : RpcContext, name : Bytes, value : Bytes) -> Unit

Add an initial-metadata header to the response. Only takes effect if called before the response HEADERS are flushed (any point inside a unary / server- / client-streaming handler, or inside a bidi factory before the first message).

RpcContext::add_trailer

source

fn RpcContext::add_trailer(self : RpcContext, name : Bytes, value : Bytes) -> Unit

Add a trailing-metadata header, sent in the trailer HEADERS alongside grpc-status.

RpcContext::empty

source

fn RpcContext::empty() -> RpcContext

A context with no path, metadata, or deadline — the placeholder a stream holds until its request HEADERS are decoded.

RpcContext::fail

source

fn RpcContext::fail(self : RpcContext, code : Int, message : String) -> Unit

End the call with a non-OK gRPC status. A handler calls this (e.g. ctx.fail(Status::code(NotFound), "user 42 does not exist")) instead of returning a normal reply; the server sends the grpc-status / grpc-message trailer and drops the reply message. The five common codes have named helpers on [Status]; any code is accepted.

RpcContext::metadata_get

source

fn RpcContext::metadata_get(self : RpcContext, name : Bytes) -> Bytes?

The value of request metadata name, or None. Names are matched byte-for-byte (gRPC lowercases header names on the wire), so binary -bin metadata works too.

Stream

source

pub(all) struct Stream {
  id : Int
  state : StreamState
}

A mutable stream: its identifier and current lifecycle state. send/recv advance the state in place, raising on an illegal transition.

Stream::new

source

fn Stream::new(id : Int) -> Stream

A fresh idle stream with the given identifier.

Stream::recv

source

fn Stream::recv(self : Stream, ev : StreamEvent) -> StreamState raise StreamError

Advance this stream by receiving ev, returning the new state.

Stream::send

source

fn Stream::send(self : Stream, ev : StreamEvent) -> StreamState raise StreamError

Advance this stream by sending ev, returning the new state.

StreamEvent

source

pub(all) enum StreamEvent {
  Headers(end_stream~ : Bool)
  Data(end_stream~ : Bool)
  Reserve
  RstStream
} derive(Eq)

A state-changing stream event: the arrival or departure of the frames that drive §5.1 transitions. Headers/Data carry the END_STREAM flag; Reserve is a PUSH_PROMISE reserving this (promised) stream. Frames that never change stream state (PRIORITY, WINDOW_UPDATE, SETTINGS, PING) are intentionally absent.

StreamEvent::equal

source

fn StreamEvent::equal(StreamEvent, StreamEvent) -> Bool

StreamEvent::not_equal

source

fn StreamEvent::not_equal(x : StreamEvent, y : StreamEvent) -> Bool

StreamState

source

pub(all) enum StreamState {
  Idle
  ReservedLocal
  ReservedRemote
  Open
  HalfClosedLocal
  HalfClosedRemote
  Closed
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The lifecycle state of a single HTTP/2 stream (RFC 7540 §5.1).

impl Show for StreamState

StreamState::equal

source

fn StreamState::equal(StreamState, StreamState) -> Bool

StreamState::not_equal

source

fn StreamState::not_equal(x : StreamState, y : StreamState) -> Bool

StreamState::on_recv

source

fn StreamState::on_recv(self : StreamState, ev : StreamEvent) -> StreamState raise StreamError

The next state after receiving ev in this state (RFC 7540 §5.1, remote side — the mirror of on_send). Raises InvalidTransition on an illegal frame.

StreamState::on_send

source

fn StreamState::on_send(self : StreamState, ev : StreamEvent) -> StreamState raise StreamError

The next state after sending ev from this state (RFC 7540 §5.1, local side). Raises InvalidTransition for a frame illegal in the current state.

StreamState::output

source

fn StreamState::output(self : StreamState, logger : &Logger) -> Unit

StreamState::to_repr

source

fn StreamState::to_repr(StreamState) -> @moonbitlang/core/debug.Repr
Repr

StreamState::to_string

source

fn StreamState::to_string(self : StreamState) -> String

parse_grpc_timeout

source

fn parse_grpc_timeout(v : Bytes) -> Int?

Parse a grpc-timeout value (RFC: up to 8 ASCII digits then a unit — H/M/S/m/u/n) to whole milliseconds, flooring sub-millisecond units. None for a malformed value.

stream_id_valid_for_initiator

source

fn stream_id_valid_for_initiator(id : Int, by_client~ : Bool) -> Bool

Whether a peer that is a client (by_client = true) or server may legally open stream id: clients use odd ids, servers use even ids, and 0 is the connection control stream, openable by neither (RFC 7540 §5.1.1).

stream_is_client_initiated

source

fn stream_is_client_initiated(id : Int) -> Bool

Whether id is a client-initiated stream: a non-zero odd identifier.

stream_is_server_initiated

source

fn stream_is_server_initiated(id : Int) -> Bool

Whether id is a server-initiated (pushed) stream: a non-zero even identifier.

Source Files

Install

Download zip

Real gRPC for MoonBit over HTTP/2: all four call kinds, metadata, deadlines, rich errors, health checking, server reflection, retries, hedging and load balancing, with pure client and server engines that run on every backend.

grpcrpcprotobufhttp2moonbit

moonbitstack

Apache-2.0

github.com/moonbitstack/moonrpc

Updated 2 days ago

568 downloads

Site source Report issue Packages Build queue Skills Statistics

#StreamError

#StreamError::equal

#StreamError::not_equal

#StreamError::output

#StreamError::to_string

#BidiHandler

#Handler

#RpcContext

#RpcContext::add_error_detail

#RpcContext::add_header

#RpcContext::add_trailer

#RpcContext::empty

#RpcContext::fail

#RpcContext::metadata_get

#Stream

#Stream::new

#Stream::recv

#Stream::send

#StreamEvent

#StreamEvent::equal

#StreamEvent::not_equal

#StreamState

#StreamState::equal

#StreamState::not_equal

#StreamState::on_recv

#StreamState::on_send

#StreamState::output

#StreamState::to_repr

#StreamState::to_string

#parse_grpc_timeout

#stream_id_valid_for_initiator

#stream_is_client_initiated

#stream_is_server_initiated

Source Files

StreamError

StreamError::equal

StreamError::not_equal

StreamError::output

StreamError::to_string

BidiHandler

Handler

RpcContext

RpcContext::add_error_detail

RpcContext::add_header

RpcContext::add_trailer

RpcContext::empty

RpcContext::fail

RpcContext::metadata_get

Stream

Stream::new

Stream::recv

Stream::send

StreamEvent

StreamEvent::equal

StreamEvent::not_equal

StreamState

StreamState::equal

StreamState::not_equal

StreamState::on_recv

StreamState::on_send

StreamState::output

StreamState::to_repr

StreamState::to_string

parse_grpc_timeout

stream_id_valid_for_initiator

stream_is_client_initiated

stream_is_server_initiated