Struct smoltcp::socket::SocketSet

pub struct SocketSet<'a, 'b: 'a, 'c: 'a + 'b> { /* fields omitted */ }

An extensible set of sockets.

The lifetimes 'b and 'c are used when storing a Socket<'b, 'c>.

Methods

impl<'a, 'b: 'a, 'c: 'a + 'b> Set<'a, 'b, 'c>

pub fn new<SocketsT>(sockets: SocketsT) -> Set<'a, 'b, 'c> where
    SocketsT: Into<ManagedSlice<'a, Option<Item<'b, 'c>>>>, 

Create a socket set using the provided storage.

pub fn add<T>(&mut self, socket: T) -> Handle where
    T: Into<Socket<'b, 'c>>, 

Add a socket to the set with the reference count 1, and return its handle.

Panics

This function panics if the storage is fixed-size (not a Vec) and is full.

pub fn get<T: AnySocket<'b, 'c>>(&mut self, handle: Handle) -> SocketRef<T>

Get a socket from the set by its handle, as mutable.

Panics

This function may panic if the handle does not belong to this socket set or the socket has the wrong type.

pub fn remove(&mut self, handle: Handle) -> Socket<'b, 'c>

Remove a socket from the set, without changing its state.

Panics

This function may panic if the handle does not belong to this socket set.

pub fn retain(&mut self, handle: Handle)

Increase reference count by 1.

Panics

This function may panic if the handle does not belong to this socket set.

pub fn release(&mut self, handle: Handle)

Decrease reference count by 1.

Panics

This function may panic if the handle does not belong to this socket set, or if the reference count is already zero.

pub fn prune(&mut self)

Prune the sockets in this set.

Pruning affects sockets with reference count 0. Open sockets are closed. Closed sockets are removed and dropped.

Important traits for Iter<'a, 'b, 'c>

impl<'a, 'b: 'a, 'c: 'a + 'b> Iterator for Iter<'a, 'b, 'c> type Item = &'a Socket<'b, 'c>;

pub fn iter<'d>(&'d self) -> Iter<'d, 'b, 'c>

Iterate every socket in this set.

Important traits for IterMut<'a, 'b, 'c>

impl<'a, 'b: 'a, 'c: 'a + 'b> Iterator for IterMut<'a, 'b, 'c> type Item = SocketRef<'a, Socket<'b, 'c>>;

pub fn iter_mut<'d>(&'d mut self) -> IterMut<'d, 'b, 'c>

Iterate every socket in this set, as SocketRef.

Trait Implementations

impl<'a, 'b: 'a, 'c: 'a + 'b> Debug for Set<'a, 'b, 'c>

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

Formats the value using the given formatter.