Enum VCLEvent 

pub enum VCLEvent {
    Connected,
    Disconnected,
    PacketReceived {
        sequence: u64,
        size: usize,
    },
    PingReceived,
    PongReceived {
        latency: Duration,
    },
    KeyRotated,
    Error(String),
}

Events emitted by a VCLConnection.

Received via the mpsc::Receiver<VCLEvent> returned by VCLConnection::subscribe().

Example

use vcl_protocol::{VCLEvent, connection::VCLConnection};

#[tokio::main]
async fn main() {
    let mut conn = VCLConnection::bind("127.0.0.1:0").await.unwrap();
    let mut events = conn.subscribe();

    tokio::spawn(async move {
        while let Some(event) = events.recv().await {
            match event {
                VCLEvent::Connected => println!("Ready!"),
                VCLEvent::PongReceived { latency } =>
                    println!("Latency: {:?}", latency),
                VCLEvent::Disconnected => break,
                _ => {}
            }
        }
    });
}

Variants

Connected

Handshake completed — the connection is ready to send and receive data.

Disconnected

close() was called — connection is now shut down.

PacketReceived

A data packet was successfully received and decrypted.

Fields

sequence: u64

Sequence number of the received packet.

size: usize

Size of the decrypted payload in bytes.

PingReceived

The peer sent a Ping — a Pong was sent back automatically.

PongReceived

A Pong was received in response to our ping() call.

Fields

latency: Duration

Measured round-trip time from ping() to pong receipt.

KeyRotated

Mid-session key rotation completed — both sides now use the new shared secret.

Error(String)

A non-fatal internal error occurred.

Trait Implementations

impl Clone for VCLEvent

fn clone(&self) -> VCLEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VCLEvent

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

Formats the value using the given formatter.