Struct nng::Listener

pub struct Listener { /* fields omitted */ }

Active listener for incoming connections.

A Listener is the object that is responsible for accepting incoming connections. A given Listener can have many connections to multiple clients simultaneously. Directly creating a listener object is only necessary when one wishes to configure the listener before opening it or if one wants to close the connections without closing the socket. Otherwise, Socket::listen can be used.

Note that the client/server relationship described by a dialer/listener is completely orthogonal to any similar relationship in the protocols. For example, a rep socket may use a dialer to connect to a listener on a req socket. This orthogonality can lead to innovative solutions to otherwise challenging communications problems.

See the NNG documentation for more information.

Implementations

impl Listener

pub fn new(socket: &Socket, url: &str) -> Result<Self>

Creates a new listener object associated with the given socket.

Note that this will immediately start the listener so no configuration will be possible. Use ListenerBuilder to change the listener options before starting it.

Errors

• AddressInUse: The address specified by url is already in use.
• Addressinvalid: An invalid url was specified.
• Closed: The socket is not open.
• OutOfMemory: Insufficient memory is available.

pub fn close(self)

Closes the listener.

This also closes any Pipe objects that have been created by the listener. Once this function returns, the listener has been closed and all of its resources have been deallocated. Therefore, any attempt to utilize the listener (with this or any other handle) will result in an error.

Listeners are implicitly closed when the socket they are associated with is closed. Listeners are not closed when all handles are dropped.

Trait Implementations

impl Clone for Listener

fn clone(&self) -> Listener

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Listener

impl Debug for Listener

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

Formats the value using the given formatter.

impl Eq for Listener

impl GetOpt<BoundPort> for Listener

impl GetOpt<KeepAlive> for Listener

impl GetOpt<LocalAddr> for Listener

impl GetOpt<MaxTtl> for Listener

impl GetOpt<NoDelay> for Listener

impl GetOpt<Protocol> for Listener

impl GetOpt<Raw> for Listener

impl GetOpt<RecvBufferSize> for Listener

impl GetOpt<RecvTimeout> for Listener

impl GetOpt<ResendTime> for Listener

impl GetOpt<SendBufferSize> for Listener

impl GetOpt<SendTimeout> for Listener

impl GetOpt<SocketName> for Listener

impl GetOpt<SurveyTime> for Listener

impl GetOpt<Url> for Listener

impl Hash for Listener

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Listener

fn cmp(&self, other: &Listener) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Listener> for Listener

fn eq(&self, other: &Listener) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Listener> for Listener

fn partial_cmp(&self, other: &Listener) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.