Struct libcoap_rs::session::client::CoapClientSession

source ·

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

Expand description

Representation of a client-side CoAP session.

Implementations

source

impl CoapClientSession<'_>

source

pub fn connect_dtls<'a, 'b, P: 'static + CoapClientCryptoProvider>(
 ctx: &'b mut CoapContext<'a>,
 addr: SocketAddr,
 crypto_provider: P
) -> Result<CoapClientSession<'a>, SessionCreationError>

Create a new DTLS encrypted session with the given peer.

To supply cryptographic information (like PSK hints or key data), you have to provide a struct implementing CoapClientCryptoProvider.

Errors

Will return a SessionCreationError if libcoap was unable to create a session (most likely because it was not possible to bind to a port).

source

pub fn connect_udp<'a>(
ctx: &mut CoapContext<'a>,
addr: SocketAddr
) -> Result<CoapClientSession<'a>, SessionCreationError>

Create a new unencrypted session with the given peer over UDP.

Errors

Will return a SessionCreationError if libcoap was unable to create a session (most likely because it was not possible to bind to a port).

source

pub fn set_crypto_provider(
&mut self,
crypto_provider: Option<Box<dyn CoapClientCryptoProvider>>
)

Sets the provider for cryptographic information for this session.

Trait Implementations

source

impl<'a> Clone for CoapClientSession<'a>

source

fn clone(&self) -> CoapClientSession<'a>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<'a> Debug for CoapClientSession<'a>

source

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

Formats the value using the given formatter. Read more

source

impl<'a> From<CoapClientSession<'a>> for CoapSession<'a>

source

fn from(session: CoapClientSession<'a>) -> Self

Converts to this type from the input type.

source

impl<'a, T: CoapSessionCommon<'a>> PartialEq<T> for CoapClientSession<'_>

source

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

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

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl Eq for CoapClientSession<'_>

Auto Trait Implementations

impl<'a> !RefUnwindSafe for CoapClientSession<'a>

impl<'a> !Send for CoapClientSession<'a>

impl<'a> !Sync for CoapClientSession<'a>

impl<'a> Unpin for CoapClientSession<'a>

impl<'a> !UnwindSafe for CoapClientSession<'a>

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<'a, T> CoapSessionCommon<'a> for Twhere
T: CoapSessionCommonInternal<'a>,

source

fn app_data<T: Any>(&self) -> Result<Option<Rc<T>>, SessionGetAppDataError>

Returns the application specific data stored alongside this session.

source

fn set_app_data<T: 'static + Any>(&self, value: Option<T>)

Sets the application-specific data stored alongside this session.

source

fn clear_app_data(&self)

Clears the application-specific data stored alongside this session.

source

fn ack_random_factor(&self) -> (u16, u16)

Returns the Ack-Random-Factor used by libcoap. Read more

source

fn set_ack_random_factor(&self, integer_part: u16, fractional_part: u16)

Sets the Ack-Random-Factor used by libcoap.

source

fn ack_timeout(&self) -> (u16, u16)

Returns the current value of the Acknowledgement Timeout for this session (in seconds). Read more

source

fn set_ack_timeout(&self, integer_part: u16, fractional_part: u16)

Sets the value of the Acknowledgement Timeout for this session.

source

fn addr_local(&self) -> SocketAddr

Returns the local address for this session.

source

fn addr_remote(&self) -> SocketAddr

Returns the remote address for this session.

source

fn if_index(&self) -> IfIndex

Returns the interface index for this session.

source

fn max_retransmit(&self) -> MaxRetransmit

Returns the maximum number of retransmissions for this session.

source

fn set_max_retransmit(&mut self, value: MaxRetransmit)

Sets the maximum number of retransmissions for this session.

source

fn proto(&self) -> CoapProtocol

Returns the underlying transport protocol used for this session.

source

fn psk_hint(&self) -> Option<Box<CoapCryptoPskIdentity>>

Returns the current PSK hint for this session.

source

fn psk_identity(&self) -> Option<Box<CoapCryptoPskIdentity>>

Returns the current PSK identity for this session.

source

fn psk_key(&self) -> Option<Box<CoapCryptoPskData>>

Returns the current PSK key for this session.

source

fn state(&self) -> CoapSessionState

Returns the current state of this session.

source

fn init_token(&self, token: &[u8; 8])

Initializes the token value used by libcoap. Read more

source

fn max_pdu_size(&self) -> usize

Returns the maximum size of a PDU for this session.

source

fn set_mtu(&self, mtu: u32)

Sets the maximum size of a PDU for this session.

source

fn next_message_id(&self) -> CoapMessageId

Returns the next message ID that should be used for this session.

source

fn new_token(&mut self, token: &mut [u8; 8]) -> usize

Returns the next token that should be used for requests.

source

fn send_ping(&mut self) -> CoapMessageId

Send a ping message to the remote peer.

source

fn send<P: Into<CoapMessage>>(
&self,
pdu: P
) -> Result<CoapMessageId, MessageConversionError>

Send the given message-like object to the peer. Read more

source

fn send_request(
&self,
req: CoapRequest
) -> Result<CoapRequestHandle, MessageConversionError>

Sends the given CoapRequest, returning a CoapRequestHandle that can be used to poll the request for completion. Read more

source

fn poll_handle(&self, handle: &CoapRequestHandle) -> IntoIter<CoapResponse>

Polls whether the request for the given handle already has pending responses. Read more

source

fn is_waiting_for_token(&self, token: &CoapToken) -> bool

Returns whether this session waits for the provided token.

source

fn remove_handle(&self, handle: CoapRequestHandle)

Stops listening for responses to this request handle. Read more

source

unsafe fn raw_session_mut(&self) -> *mut coap_session_t

Returns a mutable reference to the underlying raw session. Read more

source

unsafe fn raw_session(&self) -> *const coap_session_t

Returns a reference to the underlying raw session. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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 Twhere
T: Clone,

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 for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct libcoap_rs::session::client::CoapClientSession

Implementations

impl CoapClientSession<'_>

pub fn connect_dtls<'a, 'b, P: 'static + CoapClientCryptoProvider>( ctx: &'b mut CoapContext<'a>, addr: SocketAddr, crypto_provider: P) -> Result<CoapClientSession<'a>, SessionCreationError>

pub fn connect_udp<'a>( ctx: &mut CoapContext<'a>, addr: SocketAddr) -> Result<CoapClientSession<'a>, SessionCreationError>

pub fn set_crypto_provider( &mut self, crypto_provider: Option<Box<dyn CoapClientCryptoProvider>>)

Trait Implementations

impl<'a> Clone for CoapClientSession<'a>

fn clone(&self) -> CoapClientSession<'a>

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

impl<'a> Debug for CoapClientSession<'a>

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

impl<'a> From<CoapClientSession<'a>> for CoapSession<'a>

fn from(session: CoapClientSession<'a>) -> Self

impl<'a, T: CoapSessionCommon<'a>> PartialEq<T> for CoapClientSession<'_>

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

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

impl Eq for CoapClientSession<'_>

Auto Trait Implementations

impl<'a> !RefUnwindSafe for CoapClientSession<'a>

impl<'a> !Send for CoapClientSession<'a>

impl<'a> !Sync for CoapClientSession<'a>

impl<'a> Unpin for CoapClientSession<'a>

impl<'a> !UnwindSafe for CoapClientSession<'a>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<'a, T> CoapSessionCommon<'a> for Twhere T: CoapSessionCommonInternal<'a>,

fn app_data<T: Any>(&self) -> Result<Option<Rc<T>>, SessionGetAppDataError>

fn set_app_data<T: 'static + Any>(&self, value: Option<T>)

fn clear_app_data(&self)

fn ack_random_factor(&self) -> (u16, u16)

fn set_ack_random_factor(&self, integer_part: u16, fractional_part: u16)

fn ack_timeout(&self) -> (u16, u16)

fn set_ack_timeout(&self, integer_part: u16, fractional_part: u16)

fn addr_local(&self) -> SocketAddr

fn addr_remote(&self) -> SocketAddr

fn if_index(&self) -> IfIndex

fn max_retransmit(&self) -> MaxRetransmit

fn set_max_retransmit(&mut self, value: MaxRetransmit)

fn proto(&self) -> CoapProtocol

fn psk_hint(&self) -> Option<Box<CoapCryptoPskIdentity>>

fn psk_identity(&self) -> Option<Box<CoapCryptoPskIdentity>>

fn psk_key(&self) -> Option<Box<CoapCryptoPskData>>

fn state(&self) -> CoapSessionState

fn init_token(&self, token: &[u8; 8])

fn max_pdu_size(&self) -> usize

fn set_mtu(&self, mtu: u32)

fn next_message_id(&self) -> CoapMessageId

fn new_token(&mut self, token: &mut [u8; 8]) -> usize

fn send_ping(&mut self) -> CoapMessageId

fn send<P: Into<CoapMessage>>( &self, pdu: P) -> Result<CoapMessageId, MessageConversionError>

fn send_request( &self, req: CoapRequest) -> Result<CoapRequestHandle, MessageConversionError>

fn poll_handle(&self, handle: &CoapRequestHandle) -> IntoIter<CoapResponse>

fn is_waiting_for_token(&self, token: &CoapToken) -> bool

fn remove_handle(&self, handle: CoapRequestHandle)

unsafe fn raw_session_mut(&self) -> *mut coap_session_t

unsafe fn raw_session(&self) -> *const coap_session_t

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

pub fn connect_dtls<'a, 'b, P: 'static + CoapClientCryptoProvider>(
ctx: &'b mut CoapContext<'a>,
addr: SocketAddr,
crypto_provider: P
) -> Result<CoapClientSession<'a>, SessionCreationError>

pub fn connect_udp<'a>(
ctx: &mut CoapContext<'a>,
addr: SocketAddr
) -> Result<CoapClientSession<'a>, SessionCreationError>

pub fn set_crypto_provider(
&mut self,
crypto_provider: Option<Box<dyn CoapClientCryptoProvider>>
)

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

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

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

impl<'a, T> CoapSessionCommon<'a> for Twhere
T: CoapSessionCommonInternal<'a>,

fn send<P: Into<CoapMessage>>(
&self,
pdu: P
) -> Result<CoapMessageId, MessageConversionError>

fn send_request(
&self,
req: CoapRequest
) -> Result<CoapRequestHandle, MessageConversionError>

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

impl<T> ToOwned for Twhere
T: Clone,

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

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

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,