Struct AlpineClient 

pub struct AlpineClient { /* private fields */ }

High-level controller client that orchestrates discovery, handshake, streaming, control, and keepalive flows.

Guarantees

• Handshake runs over TimeoutTransport<CborUdpTransport> and fails fast.
• Streaming uses a compiled StreamProfile and cannot change behavior once active.
• Keepalive tasks start after handshake and abort on close().

Implementations

impl AlpineClient

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

Connects to a remote ALPINE device using the provided credentials.

Behavior

• Executes discovery/handshake via CborUdpTransport and TimeoutTransport.
• Spins up a keepalive future that ticks every 5 seconds.
• Builds ControlClient once keys are derived so control_envelope works.

Errors

Returns ClientError::Io for socket failures or missing session material, ClientError::Handshake for protocol errors, and ClientError::Stream for transport issues.

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

Starts streaming with the selected profile; Auto is the default.

Guarantees

• Profiles are validated/normalized; invalid combinations return explicit errors.
• config_id is bound to the session and can’t change once streaming begins.
• Streaming transport is built after the profile is locked.

Errors

Returns ClientError::Io for socket issues or session material that is missing. Returns ClientError::Handshake if the profile cannot be bound or the session rejects it.

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<(), ClientError>

Sends a streaming frame via the high-level helper.

Guarantees

• Validation reuses AlnpStream, so it refuses to send when the session is not ready.
• Applies jitter strategy before encoding.
• Requires start_stream to have bound a profile before calling.

Errors

Returns StreamError wrapped in ClientError::Stream.

pub async fn close(self)

Gracefully closes the client, stopping keepalive tasks.

Behavior

• Transitions the session state to closed.
• Aborts the keepalive background job immediately.

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

Builds an authenticated control envelope ready for transport.

Guarantees

• Seals the payload with a MAC derived from the session keys.
• Does not mutate transport state.

Errors

Propagates the underlying HandshakeError returned while computing MACs.

Trait Implementations

impl Debug for AlpineClient

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

Formats the value using the given formatter.