Skip to main content

ConstrainedEngine

Struct ConstrainedEngine 

Source
pub struct ConstrainedEngine { /* private fields */ }
Expand description

The constrained protocol engine

Manages multiple connections and provides a simple API for sending/receiving data.

Implementations§

Source§

impl ConstrainedEngine

Source

pub fn new(config: EngineConfig) -> Self

Create a new constrained protocol engine

Source

pub fn with_defaults() -> Self

Create with default configuration

Source

pub fn connection_count(&self) -> usize

Number of active connections

Source

pub fn can_accept_connection(&self) -> bool

Check if we can accept more connections

Source

pub fn connect( &mut self, remote_addr: SocketAddr, ) -> Result<(ConnectionId, Vec<u8>), ConstrainedError>

Initiate a connection to a remote address

Returns the connection ID and a SYN packet to transmit.

Source

pub fn process_incoming( &mut self, remote_addr: SocketAddr, data: &[u8], ) -> Result<Vec<(SocketAddr, Vec<u8>)>, ConstrainedError>

Process an incoming packet

Returns any response packets that need to be transmitted.

Source

pub fn send( &mut self, connection_id: ConnectionId, data: &[u8], ) -> Result<Vec<(SocketAddr, Vec<u8>)>, ConstrainedError>

Send data on a connection

Source

pub fn recv(&mut self, connection_id: ConnectionId) -> Option<Vec<u8>>

Receive data from a connection

Source

pub fn close( &mut self, connection_id: ConnectionId, ) -> Result<Vec<(SocketAddr, Vec<u8>)>, ConstrainedError>

Close a connection gracefully

Source

pub fn reset( &mut self, connection_id: ConnectionId, ) -> Result<Vec<(SocketAddr, Vec<u8>)>, ConstrainedError>

Reset a connection immediately

Source

pub fn poll(&mut self) -> Vec<(SocketAddr, Vec<u8>)>

Poll the engine for maintenance tasks

This should be called periodically. Returns packets that need to be transmitted.

Source

pub fn next_event(&mut self) -> Option<EngineEvent>

Get next pending event

Source

pub fn has_connection(&self, connection_id: ConnectionId) -> bool

Check if a connection exists

Source

pub fn connection_for_addr(&self, addr: &SocketAddr) -> Option<ConnectionId>

Get connection by remote address

Source

pub fn active_connections(&self) -> Vec<ConnectionId>

Get list of active connection IDs

Source

pub fn connection_state( &self, connection_id: ConnectionId, ) -> Option<ConnectionState>

Get the state of a specific connection

Trait Implementations§

Source§

impl Debug for ConstrainedEngine

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more