Struct aether_lib::link::Link

pub struct Link {
    pub private_id: Id,
    pub peer_id: PublicId,
    /* private fields */
}

Represents a single reliable Link to another peer

Fields

private_id: Id

Identity of the user that created this identity

peer_id: PublicId

Public Identity of the other peer

Implementations

impl Link

pub fn new(
    id: Id,
    socket: UdpSocket,
    peer_addr: SocketAddr,
    peer_id: PublicId,
    send_seq: u32,
    recv_seq: u32,
    config: Config
) -> Result<Link, AetherError>

Creates a new Link to another peer

Arguments

• id - Id of the user that is creating this link
• socket - UDP socket used to communicate with the other peer
• peer_addr - Address of the other peer
• peer_id - Public Id of the other peer
• send_seq - Sending Sequence number that the Link needs to be initialised with
• recv_seq - Receiving Sequence number that the Link needs to be initialised with
• config - Configuration for Aether

pub fn start(&mut self)

Starts the Link to the other peer

pub fn enable_encryption(&mut self) -> Result<(), AetherError>

pub fn is_encrypted(&self) -> bool

pub fn stop(&mut self) -> Result<(), AetherError>

Stops the Link to the other peer

pub fn get_addr(&self) -> SocketAddr

Get the SocketAddr of the peer

pub fn send(&self, buf: Vec<u8>) -> Result<(), AetherError>

Sends bytes to the other peer

Arguments

• buf - Buffer containing the bytes to be sent

pub fn send_packet(&self, packet: Packet) -> Result<(), AetherError>

Send a packet to the other peer

This alter’s the packet.sequence number of the packet argument. Rest of the packet is sent as it is

Arguments

• packet - The Packet to be sent

pub fn set_read_timout(&mut self, timeout: Duration)

Sets the read timeout for the Link

Arguments

• timeout - Timeout for receiving packets from the other peer

pub fn recv_timeout(&self, timeout: Duration) -> Result<Vec<u8>, AetherError>

Receive bytes from the other peer or return an error if the timeout is reached

Arguments

• timeout - Timeout to wait for receiving packets

Returns

• Vec<u8> - Buffer containing the received bytes

Errors

• AetherError::RecvTimeout - Timeout reached before receiving any bytes
• AetherError::LinkStopped - Link stopped before receiving any bytes

Other general errors might occur (refer to AetherError)

pub fn recv(&self) -> Result<Vec<u8>, AetherError>

Receive bytes from the other peer

Returns

• Vec<u8> - Buffer containing the received bytes

Errors

• AetherError::LinkStopped - Link stopped before receiving any bytes
• AetherError::LinkTimeout - Link timed out before receiving any bytes

Other general errors might occur (refer to AetherError)

pub fn get_receiver(&self) -> Result<Receiver<Packet>, AetherError>

Returns a [Receiver] to receive packets from the output queue

pub fn is_empty(&self) -> Result<bool, AetherError>

Returns true if no more packets needs to be sent Checks if both primary queue and batch queue are empty

pub fn wait_empty(&self) -> Result<(), AetherError>

Waits and blocks the current thread until the Link is empty

Trait Implementations

impl Debug for Link

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

Formats the value using the given formatter.

impl Drop for Link

fn drop(&mut self)

Executes the destructor for this type.