Struct veilid_tools::AssemblyBuffer

pub struct AssemblyBuffer { /* private fields */ }

Packet reassembly and fragmentation handler

Used to provide, for raw unordered protocols such as UDP, a means to achieve:

• Fragmentation of packets to ensure they are smaller than a common MTU
• Reassembly of fragments upon receipt accounting for:
  • duplication
  • drops
  • overlaps

AssemblyBuffer does not try to replicate TCP or other highly reliable protocols. Here are some of the design limitations to be aware of when using AssemblyBuffer:

• No packet acknowledgment. The sender does not know if a packet was received.
• No flow control. If there are buffering problems or drops, the sender and receiver have no protocol to address this.
• No retries or retransmission.
• No sequencing of packets. Packets may still be delivered to the application out of order, but this guarantees that only whole packets will be delivered if all of their fragments are received.

Implementations

impl AssemblyBuffer

pub fn new() -> Self

pub fn insert_frame( &self, frame: &[u8], remote_addr: SocketAddr ) -> NetworkResult<Option<Vec<u8>>>

Receive a packet chunk and add to the message assembly if a message has been completely, return it

pub async fn split_message<S, F>( &self, data: Vec<u8>, remote_addr: SocketAddr, sender: S ) -> Result<NetworkResult<()>>

where S: FnMut(Vec<u8>, SocketAddr) -> F, F: Future<Output = Result<NetworkResult<()>>>,

Split a message into packets and send them serially, ensuring that they are sent consecutively to a particular remote address, never interleaving packets from one message and another to minimize reassembly problems

Trait Implementations

impl Clone for AssemblyBuffer

fn clone(&self) -> AssemblyBuffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for AssemblyBuffer

fn default() -> Self

Returns the “default value” for a type.