coap library
Classes
- AcceptOption
- Block1Option
- Block2Option
- CoapBlockOption
- This class describes the block options of the CoAP messages
- CoapClient
- Provides convenient methods for accessing CoAP resources. This class provides a fairly high level interface for the majority of simple CoAP requests but because of this is fairly coarsely grained. Much finer control of a request can be achieved by direct construction and manipulation of a CoapRequest itself, however this is more involved, for most cases the API in this class should suffice.
- CoapCode
- Models CoAP codes as described in RFC 7252, section 3.
- CoapConfigAll
- Configuration loading class. The config file itself is a YAML file. The configuration items below are marked as optional to allow the config file to contain only those entries that override the defaults. The file can't be empty, so version must as a minimum be present.
- CoapConfigDefault
- Configuration loading class. The config file itself is a YAML file. The configuration items below are marked as optional to allow the config file to contain only those entries that override the defaults. The file can't be empty, so version must as a minimum be present.
- CoapConstants
- Package wide constants
- CoapLinkAttribute
- Class for linkformat attributes.
- CoapLinkFormat
- This class provides link format definitions as specified in RFC 6690.
- CoapMulticastResponseHandler
- Response event handler for multicast responses
- CoapObserveClientRelation
- Represents a CoAP observe relation between a CoAP client and a resource on a server. Provides a simple API to check whether a relation has successfully established and to cancel or refresh the relation.
- CoapRequest
- This class describes the functionality of a CoAP Request as a subclass of a CoAP Message. It provides:
- CoapResource
- Interface for a resource
- CoapResponse
- Represents a CoAP response to a CoAP request. A response is either a piggy-backed response with type ACK or a separate response with type CON or NON.
- CoapWebLink
- This class can be used to programmatically browse a remote CoAP endoint.
- ContentFormatOption
- CropRotationDeduplicator
- Crop rotation deduplicator
- Deduplicator
- Provides methods to detect duplicates. Note that CONs and NONs can be duplicates.
- DefaultCoapConfig
- Configuration loading class. The config file itself is a YAML file. The configuration items below are marked as optional to allow the config file to contain only those entries that override the defaults. The file can't be empty, so version must as a minimum be present.
- EchoOption
- The Echo Option provides a lightweight challenge-response mechanism for CoAP that enables a CoAP server to verify the freshness of a request.
- EdhocOption
- EmptyOption
- ETagOption
- HopLimitOption
- IfMatchOption
- IfNoneMatchOption
- IntegerOption
- Option format for non-negative integer values represented in network byte order.
- LocationPathOption
- LocationQueryOption
- MaxAgeOption
- NoopDeduplicator
- A dummy implementation that does no deduplication.
- NoResponseOption
- ObserveOption
- Option for observing resources with CoAP.
- OcfAcceptContentFormatVersion
- OcfContentFormatVersion
- OcfVersionOption
- Base class for the OCF options OcfAcceptContentFormatVersion and OcfContentFormatVersion.
- OpaqueOption
-
Option<
T> - This class describes the options of the CoAP messages.
- OscoreOption
- OscoreOptionValue
- PathOption
- ProxySchemeOption
- ProxyUriOption
- PskCredentials
- Credentials used for PSK Cipher Suites consisting of an identity and a preSharedKey.
- QBlock1Option
- QBlock2Option
- QueryOption
- RequestTagOption
- The Request-Tag Option can be used for identifying request bodies, similar to the ETagOption , but ephemeral and set by the CoAP client.
- Size1Option
- Size2Option
- StringOption
- SweepDeduplicator
- Sweep deduplicator
- UriHostOption
- UriPathOption
- UriPortOption
- UriQueryOption
Enums
- BlockOptionType
- BlockSize
- Enum representing the valid SZX values of CoapBlockOptions.
- CoapMediaType
- This enum describes the CoAP Media Type Registry as defined in RFC 7252, Section 12.3.
- CoapMessageType
- Types of CoAP messages.
- LinkFormatParameter
- LinkFormatParameterType
- The strategy applied for conditional requsts.
- MulticastAddress
- Defines well-known multicast addresses from RFC 7252 and RFC 9176.
- ObserveRegistration
- Models the legal values for including the ObserveOption an a CoAP GET request.
- RequestMethod
- Enumerates the currently specified values for request method codes.
- ResponseCode
- Enumerates the currently specified values for response codes (indicating success, a client error, or a server error).
- SignalingCode
- Enumerates the currently specified values for signaling codes (see RFC 8323, section 5.1).
Mixins
- OscoreOptionClassE
- Mixin for an Oscore class E option (encrypted and integrity protected). See RFC 8613, section 4.1.1.
- OscoreOptionClassI
- Interface for an Oscore class I option (integrity protected only). See RFC 8613, section 4.1.2.
- OscoreOptionClassU
- Mixin for an Oscore class U option (unprotected). See RFC 8613, section 4.1.2.
Typedefs
- PskCredentialsCallback = PskCredentials Function(String? identityHint)
- Function signature for a callback function for retrieving/generating PskCredentials.
Exceptions / Errors
- CoapRequestCancellationException
- This Exception is thrown when a CoAP request has timed out.
- CoapRequestException
- Generic class for Exceptions that are thrown when a CoAP request fails.
- CoapRequestTimeoutException
- This Exception is thrown when a CoAP request has timed out.