Struct CoapContext

Source

pub struct CoapContext<'a> { /* private fields */ }

Expand description

A CoAP Context — container for general state and configuration information relating to CoAP

The equivalent to the [coap_context_t] type in libcoap.

Implementations§

Source §

impl<'a> CoapContext<'a>

Source

pub fn new() -> Result<CoapContext<'a>, ContextConfigurationError>

Creates a new context.

§Errors

Returns an error if the underlying libcoap library was unable to create a new context (probably an allocation error?).

Source

pub fn set_psk_context( &mut self, psk_context: ServerPskContext<'a>, ) -> Result<(), ContextConfigurationError>

Sets the server-side cryptography information provider.

§Errors

Returns ContextConfigurationError::Unknown if the call to the underlying libcoap library function fails and ContextConfigurationError::CryptoContextAlreadySet if the PSK context has already been set previously.

Source

pub fn set_pki_rpk_context( &mut self, pki_context: impl Into<ServerPkiRpkCryptoContext<'a>>, ) -> Result<(), ContextConfigurationError>

Sets the server-side cryptography information provider.

§Errors

Returns ContextConfigurationError::Unknown if the call to the underlying libcoap library function fails and ContextConfigurationError::CryptoContextAlreadySet if the PSK context has already been set previously.

Source

pub fn set_pki_root_ca_paths( &mut self, ca_file: Option<impl AsRef<Path>>, ca_dir: Option<impl AsRef<Path>>, ) -> Result<(), ContextConfigurationError>

Convenience wrapper around set_pki_root_cas that can be provided with any type that implements AsRef<Path>.

ca_file should be the full path of a PEM-encoded file containing all root CAs to be used or None, ca_dir should be a directory path containing PEM-encoded CA certificates to be used or None.

As not all implementations of [OsString] (which is the basis of Path) provide conversions to non-zero byte sequences, this function is only available on Unix. On other operating systems, perform manual conversion of paths into CString and call set_pki_root_cas directly instead.

See the Rust standard library documentation on FFI conversions and the OsString type for more information.

§Errors

Will return ContextConfigurationError::Unknown if the call to the underlying libcoap function fails (indicating an error in either libcoap or the underlying TLS library).

Source

pub fn set_pki_root_cas( &mut self, ca_file: Option<CString>, ca_dir: Option<CString>, ) -> Result<(), ContextConfigurationError>

Sets the path to a CA certificate file and/or a directory of CA certificate files that should be used as this context’s default root CA information.

ca_file should be the full path of a PEM-encoded file containing all root CAs to be used or None, ca_dir should be a directory path containing PEM-encoded CA certificates to be used or None.

§Errors

Will return ContextConfigurationError::Unknown if the call to the underlying libcoap function fails (indicating an error in either libcoap or the underlying TLS library).

Source §

impl CoapContext<'_>

Source

pub fn shutdown( self, exit_wait_timeout: Option<Duration>, ) -> Result<(), IoProcessError>

Performs a controlled shutdown of the CoAP context.

This will perform all still outstanding IO operations until [coap_can_exit()] confirms that the context has no more outstanding IO and can be dropped without interrupting sessions.

Source

pub fn add_endpoint_udp( &mut self, addr: SocketAddr, ) -> Result<(), EndpointCreationError>

Creates a new UDP endpoint that is bound to the given address.

Source

pub fn add_endpoint_tcp( &mut self, addr: SocketAddr, ) -> Result<(), EndpointCreationError>

Creates a new TCP endpoint that is bound to the given address.

Source

pub fn add_endpoint_dtls( &mut self, addr: SocketAddr, ) -> Result<(), EndpointCreationError>

Creates a new DTLS endpoint that is bound to the given address.

Note that in order to actually connect to DTLS clients, you need to set a crypto provider using CoapContext::set_psk_context and/or CoapContext::set_pki_rpk_context.

Source

pub fn add_resource<D: Any + ?Sized + Debug>(&mut self, res: CoapResource<D>)

Adds the given resource to the resource pool of this context.

Source

pub fn do_io( &mut self, timeout: Option<Duration>, ) -> Result<Duration, IoProcessError>

Performs currently outstanding IO operations, waiting for a maximum duration of timeout.

This is the function where most of the IO operations made using this library are actually executed. It is recommended to call this function in a loop for as long as the CoAP context is used.

Source