use std::collections::HashMap;
use crate::draft15::fetch::{FetchError, FetchStateMachine};
use crate::draft15::namespace::{
NamespaceError, PublishNamespaceStateMachine, SubscribeNamespaceStateMachine,
};
use crate::draft15::publish::{PublishError as PublishFlowError, PublishStateMachine};
use crate::draft15::session::request_id::{RequestIdAllocator, RequestIdError, Role};
use crate::draft15::session::setup::{self, SetupError};
use crate::draft15::session::state::{SessionError, SessionState, SessionStateMachine};
use crate::draft15::subscription::{SubscriptionError, SubscriptionStateMachine};
use crate::draft15::track_status::{TrackStatusError, TrackStatusStateMachine};
use moqtap_codec::draft15::message::{
self, ClientSetup, ControlMessage, Fetch, FetchCancel, FetchPayload, FetchType, GoAway,
MaxRequestId, PublishDone, PublishNamespace, PublishNamespaceCancel, PublishNamespaceDone,
RequestError, RequestOk, RequestsBlocked, ServerSetup, Subscribe, SubscribeNamespace,
SubscribeOk, SubscribeUpdate, Unsubscribe, UnsubscribeNamespace,
};
use moqtap_codec::kvp::{KeyValuePair, KvpValue};
use moqtap_codec::types::*;
use moqtap_codec::varint::VarInt;
#[derive(Debug, thiserror::Error)]
pub enum EndpointError {
#[error("session error: {0}")]
Session(#[from] SessionError),
#[error("request ID error: {0}")]
RequestId(#[from] RequestIdError),
#[error("subscription error: {0}")]
Subscription(#[from] SubscriptionError),
#[error("fetch error: {0}")]
Fetch(#[from] FetchError),
#[error("namespace error: {0}")]
Namespace(#[from] NamespaceError),
#[error("track status error: {0}")]
TrackStatus(#[from] TrackStatusError),
#[error("publish flow error: {0}")]
PublishFlow(#[from] PublishFlowError),
#[error("setup error: {0}")]
Setup(#[from] SetupError),
#[error("unknown request ID: {0}")]
UnknownRequest(u64),
#[error("session not active")]
NotActive,
#[error("session is draining, no new requests allowed")]
Draining,
}
pub struct Endpoint {
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>,
publish_namespace_namespaces: HashMap<u64, TrackNamespace>,
track_statuses: HashMap<u64, TrackStatusStateMachine>,
publishes: HashMap<u64, PublishStateMachine>,
goaway_uri: Option<Vec<u8>>,
}
impl Endpoint {
pub fn new(role: Role) -> Self {
Self {
role,
session: SessionStateMachine::new(),
request_ids: RequestIdAllocator::new(role),
advertised_max_id: 0,
subscriptions: HashMap::new(),
fetches: HashMap::new(),
subscribe_namespaces: HashMap::new(),
publish_namespaces: HashMap::new(),
publish_namespace_namespaces: HashMap::new(),
track_statuses: HashMap::new(),
publishes: HashMap::new(),
goaway_uri: None,
}
}
pub fn role(&self) -> Role {
self.role
}
pub fn session_state(&self) -> SessionState {
self.session.state()
}
pub fn goaway_uri(&self) -> Option<&[u8]> {
self.goaway_uri.as_deref()
}
pub fn is_blocked(&self) -> bool {
self.request_ids.is_blocked()
}
pub fn active_subscription_count(&self) -> usize {
self.subscriptions.len()
}
pub fn active_fetch_count(&self) -> usize {
self.fetches.len()
}
pub fn active_subscribe_namespace_count(&self) -> usize {
self.subscribe_namespaces.len()
}
pub fn active_publish_namespace_count(&self) -> usize {
self.publish_namespaces.len()
}
pub fn active_track_status_count(&self) -> usize {
self.track_statuses.len()
}
pub fn active_publish_count(&self) -> usize {
self.publishes.len()
}
pub fn connect(&mut self) -> Result<(), EndpointError> {
self.session.on_connect()?;
Ok(())
}
pub fn close(&mut self) -> Result<(), EndpointError> {
self.session.on_close()?;
Ok(())
}
pub fn send_client_setup(
&mut self,
parameters: Vec<KeyValuePair>,
) -> Result<ControlMessage, EndpointError> {
let msg = ClientSetup { parameters };
setup::validate_client_setup(&msg)?;
Ok(ControlMessage::ClientSetup(msg))
}
pub fn receive_server_setup(&mut self, msg: &ServerSetup) -> Result<(), EndpointError> {
setup::validate_server_setup(msg)?;
self.session.on_setup_complete()?;
for param in &msg.parameters {
if param.key == VarInt::from_u64(0x02).unwrap() {
if let KvpValue::Varint(v) = ¶m.value {
self.request_ids.update_max(v.into_inner())?;
}
}
}
Ok(())
}
pub fn receive_client_setup_and_respond(
&mut self,
client_setup: &ClientSetup,
) -> Result<ControlMessage, EndpointError> {
setup::validate_client_setup(client_setup)?;
self.session.on_setup_complete()?;
let msg = ServerSetup { parameters: vec![] };
Ok(ControlMessage::ServerSetup(msg))
}
pub fn receive_max_request_id(&mut self, msg: &MaxRequestId) -> Result<(), EndpointError> {
self.request_ids.update_max(msg.request_id.into_inner())?;
Ok(())
}
pub fn send_max_request_id(&mut self, max_id: VarInt) -> Result<ControlMessage, EndpointError> {
let new_val = max_id.into_inner();
if new_val <= self.advertised_max_id && self.advertised_max_id > 0 {
return Err(EndpointError::RequestId(RequestIdError::Decreased(
self.advertised_max_id,
new_val,
)));
}
self.advertised_max_id = new_val;
Ok(ControlMessage::MaxRequestId(MaxRequestId { request_id: max_id }))
}
pub fn send_requests_blocked(&self) -> Result<ControlMessage, EndpointError> {
let max_id = self.request_ids.max_id();
Ok(ControlMessage::RequestsBlocked(RequestsBlocked {
maximum_request_id: VarInt::from_u64(max_id).unwrap(),
}))
}
pub fn receive_requests_blocked(&self, _msg: &RequestsBlocked) -> Result<(), EndpointError> {
Ok(())
}
pub fn receive_goaway(&mut self, msg: &GoAway) -> Result<(), EndpointError> {
self.session.on_goaway()?;
self.goaway_uri = Some(msg.new_session_uri.clone());
Ok(())
}
fn require_active_or_err(&self) -> Result<(), EndpointError> {
match self.session.state() {
SessionState::Active => Ok(()),
SessionState::Draining => Err(EndpointError::Draining),
_ => Err(EndpointError::NotActive),
}
}
pub fn subscribe(
&mut self,
track_namespace: TrackNamespace,
track_name: Vec<u8>,
parameters: Vec<KeyValuePair>,
) -> Result<(VarInt, ControlMessage), EndpointError> {
self.require_active_or_err()?;
let req_id = self.request_ids.allocate()?;
let mut sm = SubscriptionStateMachine::new();
sm.on_subscribe_sent()?;
self.subscriptions.insert(req_id.into_inner(), sm);
let msg = ControlMessage::Subscribe(Subscribe {
request_id: req_id,
track_namespace,
track_name,
parameters,
});
Ok((req_id, msg))
}
pub fn receive_subscribe_ok(&mut self, msg: &SubscribeOk) -> Result<(), EndpointError> {
let id = msg.request_id.into_inner();
let sm = self.subscriptions.get_mut(&id).ok_or(EndpointError::UnknownRequest(id))?;
sm.on_subscribe_ok()?;
Ok(())
}
pub fn unsubscribe(&mut self, request_id: VarInt) -> Result<ControlMessage, EndpointError> {
let id = request_id.into_inner();
let sm = self.subscriptions.get_mut(&id).ok_or(EndpointError::UnknownRequest(id))?;
sm.on_unsubscribe()?;
Ok(ControlMessage::Unsubscribe(Unsubscribe { request_id }))
}
pub fn receive_subscribe_update(&mut self, msg: &SubscribeUpdate) -> Result<(), EndpointError> {
let id = msg.subscription_request_id.into_inner();
let sm = self.subscriptions.get_mut(&id).ok_or(EndpointError::UnknownRequest(id))?;
sm.on_subscribe_update()?;
Ok(())
}
pub fn receive_publish_done(&mut self, msg: &PublishDone) -> Result<(), EndpointError> {
let id = msg.request_id.into_inner();
let sm = self.subscriptions.get_mut(&id).ok_or(EndpointError::UnknownRequest(id))?;
sm.on_publish_done()?;
Ok(())
}
pub fn fetch(
&mut self,
track_namespace: TrackNamespace,
track_name: Vec<u8>,
start_group: VarInt,
start_object: VarInt,
end_group: VarInt,
end_object: VarInt,
) -> Result<(VarInt, ControlMessage), EndpointError> {
self.require_active_or_err()?;
let req_id = self.request_ids.allocate()?;
let mut sm = FetchStateMachine::new();
sm.on_fetch_sent()?;
self.fetches.insert(req_id.into_inner(), sm);
let msg = ControlMessage::Fetch(Fetch {
request_id: req_id,
fetch_type: FetchType::Standalone,
fetch_payload: FetchPayload::Standalone {
track_namespace,
track_name,
start_group,
start_object,
end_group,
end_object,
},
parameters: vec![],
});
Ok((req_id, msg))
}
pub fn joining_fetch(
&mut self,
joining_request_id: VarInt,
joining_start: VarInt,
) -> Result<(VarInt, ControlMessage), EndpointError> {
self.require_active_or_err()?;
let req_id = self.request_ids.allocate()?;
let mut sm = FetchStateMachine::new();
sm.on_fetch_sent()?;
self.fetches.insert(req_id.into_inner(), sm);
let msg = ControlMessage::Fetch(Fetch {
request_id: req_id,
fetch_type: FetchType::RelativeJoining,
fetch_payload: FetchPayload::Joining { joining_request_id, joining_start },
parameters: vec![],
});
Ok((req_id, msg))
}
pub fn receive_fetch_ok(&mut self, msg: &message::FetchOk) -> Result<(), EndpointError> {
let id = msg.request_id.into_inner();
let sm = self.fetches.get_mut(&id).ok_or(EndpointError::UnknownRequest(id))?;
sm.on_fetch_ok()?;
Ok(())
}
pub fn fetch_cancel(&mut self, request_id: VarInt) -> Result<ControlMessage, EndpointError> {
let id = request_id.into_inner();
let sm = self.fetches.get_mut(&id).ok_or(EndpointError::UnknownRequest(id))?;
sm.on_fetch_cancel()?;
Ok(ControlMessage::FetchCancel(FetchCancel { request_id }))
}
pub fn on_fetch_stream_fin(&mut self, request_id: VarInt) -> Result<(), EndpointError> {
let id = request_id.into_inner();
let sm = self.fetches.get_mut(&id).ok_or(EndpointError::UnknownRequest(id))?;
sm.on_stream_fin()?;
Ok(())
}
pub fn on_fetch_stream_reset(&mut self, request_id: VarInt) -> Result<(), EndpointError> {
let id = request_id.into_inner();
let sm = self.fetches.get_mut(&id).ok_or(EndpointError::UnknownRequest(id))?;
sm.on_stream_reset()?;
Ok(())
}
pub fn subscribe_namespace(
&mut self,
namespace_prefix: TrackNamespace,
parameters: Vec<KeyValuePair>,
) -> Result<(VarInt, ControlMessage), EndpointError> {
self.require_active_or_err()?;
let req_id = self.request_ids.allocate()?;
let mut sm = SubscribeNamespaceStateMachine::new();
sm.on_subscribe_namespace_sent()?;
self.subscribe_namespaces.insert(req_id.into_inner(), sm);
let msg = ControlMessage::SubscribeNamespace(SubscribeNamespace {
request_id: req_id,
namespace_prefix,
parameters,
});
Ok((req_id, msg))
}
pub fn unsubscribe_namespace(
&mut self,
request_id: VarInt,
) -> Result<ControlMessage, EndpointError> {
let id = request_id.into_inner();
let sm = self.subscribe_namespaces.get_mut(&id).ok_or(EndpointError::UnknownRequest(id))?;
sm.on_unsubscribe_namespace()?;
Ok(ControlMessage::UnsubscribeNamespace(UnsubscribeNamespace { request_id }))
}
pub fn publish_namespace(
&mut self,
track_namespace: TrackNamespace,
parameters: Vec<KeyValuePair>,
) -> Result<(VarInt, ControlMessage), EndpointError> {
self.require_active_or_err()?;
let req_id = self.request_ids.allocate()?;
let mut sm = PublishNamespaceStateMachine::new();
sm.on_publish_namespace_sent()?;
self.publish_namespaces.insert(req_id.into_inner(), sm);
self.publish_namespace_namespaces.insert(req_id.into_inner(), track_namespace.clone());
let msg = ControlMessage::PublishNamespace(PublishNamespace {
request_id: req_id,
track_namespace,
parameters,
});
Ok((req_id, msg))
}
pub fn receive_publish_namespace_done(
&mut self,
msg: &PublishNamespaceDone,
) -> Result<(), EndpointError> {
for (id, sm) in self.publish_namespaces.iter_mut() {
if let Some(ns) = self.publish_namespace_namespaces.get(id) {
if *ns == msg.track_namespace {
sm.on_publish_namespace_done()?;
return Ok(());
}
}
}
Ok(())
}
pub fn publish_namespace_cancel(
&mut self,
track_namespace: TrackNamespace,
error_code: VarInt,
reason_phrase: Vec<u8>,
) -> Result<ControlMessage, EndpointError> {
let req_id = self
.publish_namespace_namespaces
.iter()
.find(|(_, ns)| **ns == track_namespace)
.map(|(id, _)| *id)
.ok_or(EndpointError::UnknownRequest(0))?;
let sm = self
.publish_namespaces
.get_mut(&req_id)
.ok_or(EndpointError::UnknownRequest(req_id))?;
sm.on_publish_namespace_cancel()?;
Ok(ControlMessage::PublishNamespaceCancel(PublishNamespaceCancel {
track_namespace,
error_code,
reason_phrase,
}))
}
pub fn track_status(
&mut self,
track_namespace: TrackNamespace,
track_name: Vec<u8>,
parameters: Vec<KeyValuePair>,
) -> Result<(VarInt, ControlMessage), EndpointError> {
self.require_active_or_err()?;
let req_id = self.request_ids.allocate()?;
let mut sm = TrackStatusStateMachine::new();
sm.on_track_status_sent()?;
self.track_statuses.insert(req_id.into_inner(), sm);
let msg = ControlMessage::TrackStatus(message::TrackStatus {
request_id: req_id,
track_namespace,
track_name,
parameters,
});
Ok((req_id, msg))
}
pub fn publish(
&mut self,
track_namespace: TrackNamespace,
track_name: Vec<u8>,
track_alias: VarInt,
parameters: Vec<KeyValuePair>,
) -> Result<(VarInt, ControlMessage), EndpointError> {
self.require_active_or_err()?;
let req_id = self.request_ids.allocate()?;
let mut sm = PublishStateMachine::new();
sm.on_publish_sent()?;
self.publishes.insert(req_id.into_inner(), sm);
let msg = ControlMessage::Publish(message::Publish {
request_id: req_id,
track_namespace,
track_name,
track_alias,
parameters,
});
Ok((req_id, msg))
}
pub fn receive_publish_ok(&mut self, msg: &message::PublishOk) -> Result<(), EndpointError> {
let id = msg.request_id.into_inner();
let sm = self.publishes.get_mut(&id).ok_or(EndpointError::UnknownRequest(id))?;
sm.on_publish_ok()?;
Ok(())
}
pub fn send_publish_done(
&mut self,
request_id: VarInt,
status_code: VarInt,
stream_count: VarInt,
reason_phrase: Vec<u8>,
) -> Result<ControlMessage, EndpointError> {
let id = request_id.into_inner();
let sm = self.publishes.get_mut(&id).ok_or(EndpointError::UnknownRequest(id))?;
sm.on_publish_done_sent()?;
Ok(ControlMessage::PublishDone(PublishDone {
request_id,
status_code,
stream_count,
reason_phrase,
}))
}
pub fn receive_request_ok(&mut self, msg: &RequestOk) -> Result<(), EndpointError> {
let id = msg.request_id.into_inner();
if let Some(sm) = self.subscribe_namespaces.get_mut(&id) {
sm.on_subscribe_namespace_ok()?;
return Ok(());
}
if let Some(sm) = self.publish_namespaces.get_mut(&id) {
sm.on_publish_namespace_ok()?;
return Ok(());
}
if let Some(sm) = self.track_statuses.get_mut(&id) {
sm.on_track_status_ok()?;
return Ok(());
}
Err(EndpointError::UnknownRequest(id))
}
pub fn receive_request_error(&mut self, msg: &RequestError) -> Result<(), EndpointError> {
let id = msg.request_id.into_inner();
if let Some(sm) = self.subscriptions.get_mut(&id) {
sm.on_subscribe_error()?;
return Ok(());
}
if let Some(sm) = self.fetches.get_mut(&id) {
sm.on_fetch_error()?;
return Ok(());
}
if let Some(sm) = self.publishes.get_mut(&id) {
sm.on_publish_error()?;
return Ok(());
}
if let Some(sm) = self.subscribe_namespaces.get_mut(&id) {
sm.on_subscribe_namespace_error()?;
return Ok(());
}
if let Some(sm) = self.publish_namespaces.get_mut(&id) {
sm.on_publish_namespace_error()?;
return Ok(());
}
if let Some(sm) = self.track_statuses.get_mut(&id) {
sm.on_track_status_error()?;
return Ok(());
}
Ok(())
}
pub fn receive_message(&mut self, msg: ControlMessage) -> Result<(), EndpointError> {
match msg {
ControlMessage::GoAway(ref m) => self.receive_goaway(m),
ControlMessage::MaxRequestId(ref m) => self.receive_max_request_id(m),
ControlMessage::RequestsBlocked(ref m) => self.receive_requests_blocked(m),
ControlMessage::SubscribeOk(ref m) => self.receive_subscribe_ok(m),
ControlMessage::SubscribeUpdate(ref m) => self.receive_subscribe_update(m),
ControlMessage::PublishDone(ref m) => self.receive_publish_done(m),
ControlMessage::PublishOk(ref m) => self.receive_publish_ok(m),
ControlMessage::FetchOk(ref m) => self.receive_fetch_ok(m),
ControlMessage::RequestOk(ref m) => self.receive_request_ok(m),
ControlMessage::RequestError(ref m) => self.receive_request_error(m),
ControlMessage::PublishNamespaceDone(ref m) => self.receive_publish_namespace_done(m),
_ => Ok(()),
}
}
}