pub struct Endpoint {Show 13 fields
role: Role,
session: SessionStateMachine,
request_ids: RequestIdAllocator,
advertised_max_id: u64,
subscriptions: HashMap<u64, SubscriptionStateMachine>,
fetches: HashMap<u64, FetchStateMachine>,
subscribe_namespaces: HashMap<u64, SubscribeNamespaceStateMachine>,
publish_namespaces: HashMap<u64, PublishNamespaceStateMachine>,
track_statuses: HashMap<u64, TrackStatusStateMachine>,
publishes: HashMap<u64, PublishStateMachine>,
negotiated_version: Option<VarInt>,
offered_versions: Vec<VarInt>,
goaway_uri: Option<Vec<u8>>,
}Expand description
Unified MoQT endpoint wrapping session lifecycle, request ID allocation, and all per-request state machines (subscriptions, fetches, namespaces).
Fields§
§role: Role§session: SessionStateMachine§request_ids: RequestIdAllocator§advertised_max_id: u64Tracks the MAX_REQUEST_ID we have advertised to the peer (for monotonic enforcement).
subscriptions: HashMap<u64, SubscriptionStateMachine>§fetches: HashMap<u64, FetchStateMachine>§subscribe_namespaces: HashMap<u64, SubscribeNamespaceStateMachine>§publish_namespaces: HashMap<u64, PublishNamespaceStateMachine>§track_statuses: HashMap<u64, TrackStatusStateMachine>§publishes: HashMap<u64, PublishStateMachine>§negotiated_version: Option<VarInt>§offered_versions: Vec<VarInt>§goaway_uri: Option<Vec<u8>>Implementations§
Source§impl Endpoint
impl Endpoint
Sourcepub fn session_state(&self) -> SessionState
pub fn session_state(&self) -> SessionState
Returns the current session state.
Sourcepub fn negotiated_version(&self) -> Option<VarInt>
pub fn negotiated_version(&self) -> Option<VarInt>
Returns the negotiated MoQT version, if setup is complete.
Sourcepub fn goaway_uri(&self) -> Option<&[u8]>
pub fn goaway_uri(&self) -> Option<&[u8]>
Returns the URI from a received GOAWAY message, if any.
Sourcepub fn is_blocked(&self) -> bool
pub fn is_blocked(&self) -> bool
Returns whether this endpoint is blocked on request ID allocation.
Sourcepub fn active_subscription_count(&self) -> usize
pub fn active_subscription_count(&self) -> usize
Returns the number of active subscription state machines.
Sourcepub fn active_fetch_count(&self) -> usize
pub fn active_fetch_count(&self) -> usize
Returns the number of active fetch state machines.
Sourcepub fn active_subscribe_namespace_count(&self) -> usize
pub fn active_subscribe_namespace_count(&self) -> usize
Returns the number of active subscribe-namespace state machines.
Sourcepub fn active_publish_namespace_count(&self) -> usize
pub fn active_publish_namespace_count(&self) -> usize
Returns the number of active publish-namespace state machines.
Sourcepub fn active_track_status_count(&self) -> usize
pub fn active_track_status_count(&self) -> usize
Returns the number of active track status state machines.
Sourcepub fn active_publish_count(&self) -> usize
pub fn active_publish_count(&self) -> usize
Returns the number of active publish state machines.
Sourcepub fn connect(&mut self) -> Result<(), EndpointError>
pub fn connect(&mut self) -> Result<(), EndpointError>
Transition from Connecting to SetupExchange.
Sourcepub fn close(&mut self) -> Result<(), EndpointError>
pub fn close(&mut self) -> Result<(), EndpointError>
Close the session (Active or Draining -> Closed).
Sourcepub fn send_client_setup(
&mut self,
versions: Vec<VarInt>,
parameters: Vec<KeyValuePair>,
) -> Result<ControlMessage, EndpointError>
pub fn send_client_setup( &mut self, versions: Vec<VarInt>, parameters: Vec<KeyValuePair>, ) -> Result<ControlMessage, EndpointError>
Generate a CLIENT_SETUP message (client-side).
Sourcepub fn receive_server_setup(
&mut self,
msg: &ServerSetup,
) -> Result<(), EndpointError>
pub fn receive_server_setup( &mut self, msg: &ServerSetup, ) -> Result<(), EndpointError>
Process a SERVER_SETUP message (client-side). Transitions to Active. If the server includes a MAX_REQUEST_ID parameter (key 0x02), the request ID allocator is initialized with that value.
Sourcepub fn receive_client_setup_and_respond(
&mut self,
client_setup: &ClientSetup,
selected_version: VarInt,
) -> Result<ControlMessage, EndpointError>
pub fn receive_client_setup_and_respond( &mut self, client_setup: &ClientSetup, selected_version: VarInt, ) -> Result<ControlMessage, EndpointError>
Process CLIENT_SETUP and generate SERVER_SETUP (server-side).
Sourcepub fn receive_max_request_id(
&mut self,
msg: &MaxRequestId,
) -> Result<(), EndpointError>
pub fn receive_max_request_id( &mut self, msg: &MaxRequestId, ) -> Result<(), EndpointError>
Process an incoming MAX_REQUEST_ID message.
Sourcepub fn send_max_request_id(
&mut self,
max_id: VarInt,
) -> Result<ControlMessage, EndpointError>
pub fn send_max_request_id( &mut self, max_id: VarInt, ) -> Result<ControlMessage, EndpointError>
Generate a MAX_REQUEST_ID message (typically server-side). The value must strictly increase over previous sends.
Sourcepub fn send_requests_blocked(&self) -> Result<ControlMessage, EndpointError>
pub fn send_requests_blocked(&self) -> Result<ControlMessage, EndpointError>
Generate a REQUESTS_BLOCKED message indicating that this endpoint wants to create a new request but is blocked by the current MAX_REQUEST_ID. Per draft-14 §6.3.2.
Sourcepub fn receive_requests_blocked(
&self,
_msg: &RequestsBlocked,
) -> Result<(), EndpointError>
pub fn receive_requests_blocked( &self, _msg: &RequestsBlocked, ) -> Result<(), EndpointError>
Process an incoming REQUESTS_BLOCKED message from the peer. This signals that the peer wants to issue new requests but is limited by the MAX_REQUEST_ID we advertised.
Sourcepub fn receive_goaway(&mut self, msg: &GoAway) -> Result<(), EndpointError>
pub fn receive_goaway(&mut self, msg: &GoAway) -> Result<(), EndpointError>
Process an incoming GOAWAY message. Transitions to Draining.
fn require_active_or_err(&self) -> Result<(), EndpointError>
Sourcepub fn subscribe(
&mut self,
track_namespace: TrackNamespace,
track_name: Vec<u8>,
subscriber_priority: u8,
group_order: GroupOrder,
filter_type: FilterType,
) -> Result<(VarInt, ControlMessage), EndpointError>
pub fn subscribe( &mut self, track_namespace: TrackNamespace, track_name: Vec<u8>, subscriber_priority: u8, group_order: GroupOrder, filter_type: FilterType, ) -> Result<(VarInt, ControlMessage), EndpointError>
Send a SUBSCRIBE message. Allocates a request ID and creates a subscription state machine.
Sourcepub fn receive_subscribe_ok(
&mut self,
msg: &SubscribeOk,
) -> Result<(), EndpointError>
pub fn receive_subscribe_ok( &mut self, msg: &SubscribeOk, ) -> Result<(), EndpointError>
Process an incoming SUBSCRIBE_OK.
Sourcepub fn receive_subscribe_error(
&mut self,
msg: &SubscribeError,
) -> Result<(), EndpointError>
pub fn receive_subscribe_error( &mut self, msg: &SubscribeError, ) -> Result<(), EndpointError>
Process an incoming SUBSCRIBE_ERROR.
Sourcepub fn unsubscribe(
&mut self,
request_id: VarInt,
) -> Result<ControlMessage, EndpointError>
pub fn unsubscribe( &mut self, request_id: VarInt, ) -> Result<ControlMessage, EndpointError>
Send an UNSUBSCRIBE message for an active subscription.
Sourcepub fn receive_subscribe_update(
&mut self,
msg: &SubscribeUpdate,
) -> Result<(), EndpointError>
pub fn receive_subscribe_update( &mut self, msg: &SubscribeUpdate, ) -> Result<(), EndpointError>
Process an incoming SUBSCRIBE_UPDATE.
Sourcepub fn receive_publish_done(
&mut self,
msg: &PublishDone,
) -> Result<(), EndpointError>
pub fn receive_publish_done( &mut self, msg: &PublishDone, ) -> Result<(), EndpointError>
Process an incoming PUBLISH_DONE (subscriber side — publisher finished).
Sourcepub fn fetch(
&mut self,
track_namespace: TrackNamespace,
track_name: Vec<u8>,
start_group: VarInt,
start_object: VarInt,
) -> Result<(VarInt, ControlMessage), EndpointError>
pub fn fetch( &mut self, track_namespace: TrackNamespace, track_name: Vec<u8>, start_group: VarInt, start_object: VarInt, ) -> Result<(VarInt, ControlMessage), EndpointError>
Send a FETCH message. Allocates a request ID and creates a fetch state machine.
Sourcepub fn receive_fetch_ok(&mut self, msg: &FetchOk) -> Result<(), EndpointError>
pub fn receive_fetch_ok(&mut self, msg: &FetchOk) -> Result<(), EndpointError>
Process an incoming FETCH_OK.
Sourcepub fn receive_fetch_error(
&mut self,
msg: &FetchError,
) -> Result<(), EndpointError>
pub fn receive_fetch_error( &mut self, msg: &FetchError, ) -> Result<(), EndpointError>
Process an incoming FETCH_ERROR.
Sourcepub fn fetch_cancel(
&mut self,
request_id: VarInt,
) -> Result<ControlMessage, EndpointError>
pub fn fetch_cancel( &mut self, request_id: VarInt, ) -> Result<ControlMessage, EndpointError>
Send a FETCH_CANCEL message.
Sourcepub fn on_fetch_stream_fin(
&mut self,
request_id: VarInt,
) -> Result<(), EndpointError>
pub fn on_fetch_stream_fin( &mut self, request_id: VarInt, ) -> Result<(), EndpointError>
Notify that a fetch data stream received FIN.
Sourcepub fn on_fetch_stream_reset(
&mut self,
request_id: VarInt,
) -> Result<(), EndpointError>
pub fn on_fetch_stream_reset( &mut self, request_id: VarInt, ) -> Result<(), EndpointError>
Notify that a fetch data stream was reset.
Sourcepub fn subscribe_namespace(
&mut self,
track_namespace: TrackNamespace,
) -> Result<(VarInt, ControlMessage), EndpointError>
pub fn subscribe_namespace( &mut self, track_namespace: TrackNamespace, ) -> Result<(VarInt, ControlMessage), EndpointError>
Send a SUBSCRIBE_NAMESPACE message.
Sourcepub fn receive_subscribe_namespace_ok(
&mut self,
msg: &SubscribeNamespaceOk,
) -> Result<(), EndpointError>
pub fn receive_subscribe_namespace_ok( &mut self, msg: &SubscribeNamespaceOk, ) -> Result<(), EndpointError>
Process an incoming SUBSCRIBE_NAMESPACE_OK.
Sourcepub fn receive_subscribe_namespace_error(
&mut self,
msg: &SubscribeNamespaceError,
) -> Result<(), EndpointError>
pub fn receive_subscribe_namespace_error( &mut self, msg: &SubscribeNamespaceError, ) -> Result<(), EndpointError>
Process an incoming SUBSCRIBE_NAMESPACE_ERROR.
Sourcepub fn unsubscribe_namespace(
&mut self,
request_id: VarInt,
_track_namespace: TrackNamespace,
) -> Result<ControlMessage, EndpointError>
pub fn unsubscribe_namespace( &mut self, request_id: VarInt, _track_namespace: TrackNamespace, ) -> Result<ControlMessage, EndpointError>
Send an UNSUBSCRIBE_NAMESPACE message.
Sourcepub fn publish_namespace(
&mut self,
track_namespace: TrackNamespace,
) -> Result<(VarInt, ControlMessage), EndpointError>
pub fn publish_namespace( &mut self, track_namespace: TrackNamespace, ) -> Result<(VarInt, ControlMessage), EndpointError>
Send a PUBLISH_NAMESPACE message.
Sourcepub fn receive_publish_namespace_ok(
&mut self,
msg: &PublishNamespaceOk,
) -> Result<(), EndpointError>
pub fn receive_publish_namespace_ok( &mut self, msg: &PublishNamespaceOk, ) -> Result<(), EndpointError>
Process an incoming PUBLISH_NAMESPACE_OK.
Sourcepub fn receive_publish_namespace_error(
&mut self,
msg: &PublishNamespaceError,
) -> Result<(), EndpointError>
pub fn receive_publish_namespace_error( &mut self, msg: &PublishNamespaceError, ) -> Result<(), EndpointError>
Process an incoming PUBLISH_NAMESPACE_ERROR.
Sourcepub fn receive_publish_namespace_done(
&mut self,
_msg: &PublishNamespaceDone,
) -> Result<(), EndpointError>
pub fn receive_publish_namespace_done( &mut self, _msg: &PublishNamespaceDone, ) -> Result<(), EndpointError>
Process an incoming PUBLISH_NAMESPACE_DONE.
Draft-14 PUBLISH_NAMESPACE_DONE is keyed by track_namespace
rather than a request ID, so the endpoint advances every
currently tracked publish-namespace state machine. Callers that
need per-namespace tracking should match on msg.track_namespace
directly.
Sourcepub fn publish_namespace_cancel(
&mut self,
request_id: VarInt,
reason_phrase: Vec<u8>,
) -> Result<ControlMessage, EndpointError>
pub fn publish_namespace_cancel( &mut self, request_id: VarInt, reason_phrase: Vec<u8>, ) -> Result<ControlMessage, EndpointError>
Send a PUBLISH_NAMESPACE_CANCEL message.
Sourcepub fn track_status(
&mut self,
track_namespace: TrackNamespace,
track_name: Vec<u8>,
) -> Result<(VarInt, ControlMessage), EndpointError>
pub fn track_status( &mut self, track_namespace: TrackNamespace, track_name: Vec<u8>, ) -> Result<(VarInt, ControlMessage), EndpointError>
Send a TRACK_STATUS message. Allocates a request ID.
Sourcepub fn receive_track_status_ok(
&mut self,
msg: &TrackStatusOk,
) -> Result<(), EndpointError>
pub fn receive_track_status_ok( &mut self, msg: &TrackStatusOk, ) -> Result<(), EndpointError>
Process an incoming TRACK_STATUS_OK.
Sourcepub fn receive_track_status_error(
&mut self,
msg: &TrackStatusError,
) -> Result<(), EndpointError>
pub fn receive_track_status_error( &mut self, msg: &TrackStatusError, ) -> Result<(), EndpointError>
Process an incoming TRACK_STATUS_ERROR.
Sourcepub fn publish(
&mut self,
track_namespace: TrackNamespace,
track_name: Vec<u8>,
forward: Forward,
) -> Result<(VarInt, ControlMessage), EndpointError>
pub fn publish( &mut self, track_namespace: TrackNamespace, track_name: Vec<u8>, forward: Forward, ) -> Result<(VarInt, ControlMessage), EndpointError>
Send a PUBLISH message (publisher side). Allocates a request ID.
Sourcepub fn receive_publish_ok(
&mut self,
msg: &PublishOk,
) -> Result<(), EndpointError>
pub fn receive_publish_ok( &mut self, msg: &PublishOk, ) -> Result<(), EndpointError>
Process an incoming PUBLISH_OK (publisher side).
Sourcepub fn send_publish_done(
&mut self,
request_id: VarInt,
status_code: VarInt,
reason_phrase: Vec<u8>,
) -> Result<ControlMessage, EndpointError>
pub fn send_publish_done( &mut self, request_id: VarInt, status_code: VarInt, reason_phrase: Vec<u8>, ) -> Result<ControlMessage, EndpointError>
Send a PUBLISH_DONE message (publisher finishing).
Sourcepub fn send_publish_error(
&self,
request_id: VarInt,
error_code: VarInt,
reason_phrase: Vec<u8>,
) -> Result<ControlMessage, EndpointError>
pub fn send_publish_error( &self, request_id: VarInt, error_code: VarInt, reason_phrase: Vec<u8>, ) -> Result<ControlMessage, EndpointError>
Generate a PUBLISH_ERROR message (draft-14 §6.5.3). Used by the server/relay to reject a publish request.
Sourcepub fn receive_publish_error(
&mut self,
msg: &PublishError,
) -> Result<(), EndpointError>
pub fn receive_publish_error( &mut self, msg: &PublishError, ) -> Result<(), EndpointError>
Process an incoming PUBLISH_ERROR (draft-14 §6.5.3). Checks publisher-side publishes first, then subscriber-side subscriptions, then silently ignores unknown IDs.
Sourcepub fn receive_message(
&mut self,
msg: ControlMessage,
) -> Result<(), EndpointError>
pub fn receive_message( &mut self, msg: ControlMessage, ) -> Result<(), EndpointError>
Dispatch an incoming control message to the appropriate handler.