Struct AlpineClient 

pub struct AlpineClient { /* private fields */ }

High-level client that wraps the ALPINE protocol primitives.

Implementations

impl AlpineClient

pub async fn connect( local_addr: SocketAddr, remote_addr: SocketAddr, identity: DeviceIdentity, capabilities: CapabilitySet, credentials: NodeCredentials, ) -> Result<Self, AlpineSdkError>

Opens a session with the provided device identity and capabilities.

pub fn start_stream( &mut self, profile: StreamProfile, ) -> Result<String, AlpineSdkError>

Starts streaming with the supplied profile and returns the generated config id.

pub fn send_frame( &self, channel_format: ChannelFormat, channels: Vec<u16>, priority: u8, groups: Option<HashMap<String, Vec<u16>>>, metadata: Option<HashMap<String, Value>>, ) -> Result<(), AlpineSdkError>

Sends a streaming frame over the active session.

pub async fn close(self)

Stops keep-alive and shuts down the session.

pub fn control_envelope( &self, seq: u64, op: ControlOp, payload: Value, ) -> Result<ControlEnvelope, HandshakeError>

Builds a signed control envelope for the active session.

Trait Implementations

impl Debug for AlpineClient

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

Formats the value using the given formatter.