Struct SocketSpecification 

pub struct SocketSpecification { /* private fields */ }

Specification for a general-purpose network listener.

Creates a Listener, which handles both connection-oriented and connectionless address families.

Only the listen address identifies the resource. Tuning – the UDP socket count, the receive buffer size, the accept backoff – is applied when the listener is first created and has no effect on a later acquisition of the same address, since the sockets are already bound. The registry logs a warning if a subsequent specification disagrees.

Implementations

impl SocketSpecification

pub fn new(address: ListenAddress) -> Self

Creates a specification for the given listen address.

pub fn with_udp_streams(self, udp_streams: Option<NonZeroUsize>) -> Self

Sets how many UDP sockets to bind to the address.

Each socket is bound independently with SO_REUSEPORT so the kernel load-balances incoming datagrams across them, and the listener yields one stream per socket. Ignored for non-UDP addresses. See Listener::from_listen_address for the platform caveats.

pub fn with_receive_buffer_size( self, receive_buffer_size: Option<usize>, ) -> Self

Sets the receive buffer size applied to streams accepted from this listener.

None keeps the operating system default.

pub fn with_accept_backoff( self, accept_backoff: Option<ExponentialBackoff>, ) -> Self

Sets how long the listener waits between accepts when the system is out of resources.

None keeps the listener’s default. See Listener::with_accept_backoff.

pub fn listen_address(&self) -> &ListenAddress

Returns the listen address this specification names.

Trait Implementations

impl Clone for SocketSpecification

fn clone(&self) -> SocketSpecification

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SocketSpecification

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

Formats the value using the given formatter.

impl From<ListenAddress> for SocketSpecification

fn from(address: ListenAddress) -> Self

Converts to this type from the input type.

impl ResourceSpecification for SocketSpecification

const KIND: ResourceKind = ResourceKind::Socket

Kind of the resource this specification names.

type Resource = Listener

Type of the resource this specification creates.

fn key(&self) -> MetaString

Returns the key for the resource this specification names.

fn create<'life0, 'async_trait>( &'life0 self, subleases: Subleases, ) -> Pin<Box<dyn Future<Output = Result<Self::Resource, GenericError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates the resource.

fn reset(listener: &mut Self::Resource)

Prepares a returning resource for its next holder.