Struct CoapConfig 

pub struct CoapConfig { /* private fields */ }

Connection settings for a CoapTransport.

Construct with CoapConfig::new and refine with the chained setters; every field has a sensible default so only the server address is required.

Implementations

impl CoapConfig

pub fn new(host: impl Into<String>, port: u16) -> Self

Creates a configuration pointing at the given CoAP server.

Arguments

• host - the server hostname or IP address.
• port - the server UDP port, conventionally 5683 for plaintext CoAP.

Returns

A configuration that binds an ephemeral local port, uses confirmable delivery, waits two to three seconds for the first acknowledgment, and retransmits up to four times: RFC 7252’s defaults.

pub fn bind(self, addr: impl Into<String>) -> Self

Sets the local socket address the transport binds to.

Arguments

• addr - the local host:port to bind, for example "0.0.0.0:0" to let the operating system choose a free port.

Returns

The updated configuration, for chaining.

pub fn reliability(self, reliability: Reliability) -> Self

Sets the delivery guarantee applied to sends and subscriptions.

Arguments

• reliability - confirmable (acknowledged) or non-confirmable delivery.

Returns

The updated configuration, for chaining.

pub fn ack_timeout(self, timeout: Duration) -> Self

Sets how long to wait for the first acknowledgment of a confirmable request.

The first wait is drawn between this and one and a half times it, and each wait after it doubles, as RFC 7252 section 4.2 describes. Section 4.8.1 forbids setting it below the default two seconds on a network without congestion control; lower the retransmissions instead to give up sooner.

Arguments

• timeout - the initial acknowledgment timeout.

Returns

The updated configuration, for chaining.

pub fn max_retransmits(self, count: u32) -> Self

Sets how many times a confirmable request is retransmitted before failing.

Arguments

• count - the maximum number of retransmissions after the first send.

Returns

The updated configuration, for chaining.

Trait Implementations

impl Clone for CoapConfig

fn clone(&self) -> CoapConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CoapConfig

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

Formats the value using the given formatter.