Struct async_coap::datagram::DatagramLocalEndpoint

pub struct DatagramLocalEndpoint<US: AsyncDatagramSocket> where
    Self: Send + Sync,  { /* fields omitted */ }

Generic, datagram-based CoAP local endpoint implementation.

Methods

impl<US: AsyncDatagramSocket> DatagramLocalEndpoint<US>

pub fn new(socket: US) -> DatagramLocalEndpoint<US>

Creates a new DatagramLocalEndpoint instance with the given AsyncDatagramSocket and the standard scheme (coap:) and default port (5683).

pub fn with_scheme_and_port(
    socket: US,
    scheme: &'static str,
    default_port: u16
) -> DatagramLocalEndpoint<US>

Creates a new DatagramLocalEndpoint instance with the given AsyncDatagramSocket, using the specified scheme and default port.

pub fn socket(&self) -> &US

Borrows a reference to the underlying socket.

Trait Implementations

impl<US: AsyncDatagramSocket> LocalEndpoint for DatagramLocalEndpoint<US>

type SocketAddr = US::SocketAddr

The SocketAddr type to use with this local endpoint. This is usually simply std::net::SocketAddr, but may be different in some cases (like for CoAP-SMS endpoints).

type SocketError = US::Error

The error type associated with errors generated by socket and address-lookup operations. Typically, this is std::io::Error, but it may be different if Self::SocketAddr isn't std::net::SocketAddr.

type DefaultTransParams = StandardCoapConstants

The trait representing the default transmission parameters to use.

type LookupStream = Iter<IntoIter<Self::SocketAddr>>

The concrete return type of the lookup() method.

type RespondableInboundContext = DatagramRespondableInboundContext<Self::SocketAddr>

Type used by closure that is passed into receive(), representing the context for inbound requests.

type InboundContext = DatagramInboundContext<Self::SocketAddr>

Type used by closure that is passed into send(), representing the context for the response.

type RemoteEndpoint = DatagramRemoteEndpoint<US>

The concrete type for a RemoteEndpoint associated with this local endpoint.

fn remote_endpoint<S, H, P>(
    &self,
    addr: S,
    host: Option<H>,
    path: P
) -> Self::RemoteEndpoint where
    S: ToSocketAddrs<SocketAddr = Self::SocketAddr, Error = Self::SocketError>,
    H: Into<String>,
    P: Into<RelRefBuf>, 

Constructs a new RemoteEndpoint instance for the given address, host, and path.

fn remote_endpoint_from_uri(
    &self,
    uri: &Uri
) -> Result<Self::RemoteEndpoint, Error>

Constructs a new RemoteEndpoint instance for the given Uri.

fn send<'a, S, R, SD>(
    &'a self,
    dest: S,
    send_desc: SD
) -> BoxFuture<'a, Result<R, Error>> where
    S: ToSocketAddrs<SocketAddr = Self::SocketAddr, Error = Self::SocketError> + 'a,
    SD: SendDesc<Self::InboundContext, R> + 'a,
    R: Send + 'a, 

Sends a message to remote_addr based on the criteria provided by send_desc.

fn receive<'a, F>(&'a self, handler: F) -> BoxFuture<'a, Result<(), Error>> where
    F: FnMut(&Self::RespondableInboundContext) -> Result<(), Error> + 'a + Send, 

Receives a single request and runs the given handler on it once.

fn scheme(&self) -> &'static str

Returns a string representing the scheme of the underlying transport. For example, this could return "coap", "coaps+sms", etc.

fn default_port(&self) -> u16

Returns the default port to use when the port is unspecified. This value is typically defined by the scheme. Returns zero if port numbers are ignored by the underlying technology.

fn lookup(&self, hostname: &str, port: u16) -> Result<Self::LookupStream, Error>

Method for asynchronously looking up the Self::SocketAddr instances for the given hostname and port.

impl<US: Debug + AsyncDatagramSocket> Debug for DatagramLocalEndpoint<US> where
    Self: Send + Sync, 

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

Formats the value using the given formatter.