Skip to main content

CoapConfig

Struct CoapConfig 

Source
pub struct CoapConfig { /* private fields */ }
Expand description

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§

Source§

impl CoapConfig

Source

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 seconds for the first acknowledgement, and retransmits up to four times.

Source

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.

Source

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.

Source

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

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

The wait doubles for each retransmission, following the CoAP backoff.

§Arguments
  • timeout - the initial acknowledgement timeout.
§Returns

The updated configuration, for chaining.

Source

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§

Source§

impl Clone for CoapConfig

Source§

fn clone(&self) -> CoapConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CoapConfig

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.