coap library

Classes

CoapAbstractLayer
A partial implementation of a layer.
CoapAcknowledgedEvent
Acknowledged event
CoapBlockOption
This class describes the block options of the CoAP messages
CoapBlockwiseLayer
Blockwise layer
CoapBlockwiseStatus
Represents the status of a blockwise transfer of a request or a response.
CoapByteArrayUtil
Utility methods for bytes array.
CoapCancellableAsyncSleep
Cancellable asynchronous sleep support class
CoapCancelledEvent
Cancelled event
CoapChain<TChain, TFilter, TNextFilter>
Implementation of IChain TFilter,TNextFilter
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. [...]
CoapClientMessageDeliverer
Message deliverer
CoapCode
This class describes the CoAP Code Registry as defined in draft-ietf-core-coap-08, section 11.1
CoapCompletedEvent
Completed event
CoapConsoleLogger
Provides logging to the console
CoapConstants
Package wide constants
CoapCropRotationDeduplicator
Crop rotation deduplicator
CoapDatagramReader
This class describes the functionality to read raw network-ordered datagrams on bit-level.
CoapDatagramWriter
This class describes the functionality to write raw network-ordered datagrams on bit-level.
CoapDataReceivedEvent
Data received Event
CoapDeduplicatorFactory
Deduplicator factory
CoapDefinedAddress
Defines standard addresses from RFC7252
CoapDraft03
draft-ietf-core-coap-03
CoapDraft08
draft-ietf-core-coap-08
CoapDraft12
draft-ietf-core-coap-12
CoapDraft13
draft-ietf-core-coap-13
CoapDraft18
draft-ietf-core-coap-18
CoapEmptyMessage
Represents an empty CoAP message. An empty message has either the MessageType ACK or RST.
CoapEndPoint
EndPoint encapsulates the stack that executes the CoAP protocol.
CoapEndpointManager
Endpoint manager
CoapEndpointResource
This class describes the functionality of a CoAP endpoint resource.
CoapEntry<TFilter, TNextFilter>
Represents an entry of filter in the chain.
CoapEventBus
Event bus class
CoapExchange
Represents the complete state of an exchange of one request and one or more responses. The lifecycle of an exchange ends when either the last response has arrived and is acknowledged, when a request or response has been rejected from the remote endpoint, when the request has been canceled, or when a request or response timed out, i.e., has reached the retransmission limit without being acknowledged.
CoapExecutor
Task executor
CoapIChain<TFilter, TNextFilter>
Represents a chain of filters.
CoapIChannel
Represents a channel where bytes data can flow through.
CoapIDeduplicator
Provides methods to detect duplicates. Note that CONs and NONs can be duplicates.
CoapIEndPoint
Events Represents a communication endpoint multiplexing CoAP message exchanges between (potentially multiple) clients and servers.
CoapIEntry<TFilter, TNextFilter>
Represents a name-filter pair that an contains.
CoapIExecutor
Provides methods to execute tasks.
CoapILayer
Represents a layer in the stack.
CoapILogger
Provides methods to log messages.
CoapIMatcher
Interfca efor the Matcher class
CoapIMessageDecoder
Provides methods to parse incoming byte arrays to messages.
CoapIMessageDeliverer
Provides methods for delivering inbound CoAP messages to an appropriate processor.
CoapIMessageEncoder
Provides methods to serialize outgoing messages to byte arrays.
CoapINetwork
Abstract networking class, allows different implementations for UDP, test etc.
CoapINextLayer
Represent a next layer in the stack.
CoapInternetAddress
Internet address
CoapIOutbox
Interface for an Outbox
CoapIResource
Interface for a resource
CoapISpec
Represents a draft version of CoAP specification.
CoapKeyId
Key identifier
CoapKeyToken
Key token
CoapKeyUri
Key URI
CoapLayerStack
Stack of layers.
CoapLinkAttribute
Class for linkformat attributes.
CoapLinkFormat
This class provides link format definitions as specified in draft-ietf-core-link-format-06
CoapLogManager
Allows selection and management of logging for the coap library.
CoapMatcher
Matcher class
CoapMediaType
This class describes the CoAP Media Type Registry as defined in RFC 7252, Section 12.3.
CoapMessage
The class Message models the base class of all CoAP messages. CoAP messages are of type Request, Response or EmptyMessage, each of which has a MessageType, a message identifier, a token (0-8 bytes), a collection of Options and a payload.
CoapMessageDecoder
Base class for message encoders.
CoapMessageDecoder03
Message decoder 03
CoapMessageDecoder08
Message decoder -8
CoapMessageDecoder12
Message decoder 012
CoapMessageDecoder13
Message decoder 013
CoapMessageDecoder18
Message decoder 18
CoapMessageEncoder
Base class for message encoders.
CoapMessageEncoder03
Message encoder 03
CoapMessageEncoder08
Message encoder 8
CoapMessageEncoder12
Message encoder 12
CoapMessageEncoder13
Message encoder 13
CoapMessageEncoder18
Message encoder 18
CoapMessageType
Types of CoAP messages.
CoapNetworkManagement
A network management/caching class, allows already bound endpoints to be reused without instantiating them again.
CoapNetworkUDP
UDP network
CoapNextLayer
The next processing layer
CoapNoopDeduplicator
A dummy implementation that does no deduplication.
CoapNullLogger
Provides logging to null
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.
CoapObserveLayer
Observe layer
CoapObserveNotificationOrderer
This class holds the state of an observe relation such as the timeout of the last notification and the current number.
CoapObserveRelation
Represents a relation between a client endpoint and a resource on this server.
CoapObservingEndpoint
Represents an observing endpoint. It holds all observe relations that the endpoint has to this server. If a confirmable notification timeouts for the maximum times allowed the server assumes the client is no longer reachable and cancels all relations that it has established to resources.
CoapOption
This class describes the options of the CoAP messages.
CoapReceivingEmptyMessageEvent
Occurs when an empty message has been received.
CoapReceivingRequestEvent
Occurs when a request has been received.
CoapReceivingResponseEvent
Occurs when a response has been received.
CoapRejectedEvent
Rejected event
CoapReliabilityLayer
The reliability layer
CoapRemoteResource
This class describes the functionality of a CoAP remote resource.
CoapRequest
This class describes the functionality of a CoAP Request as a subclass of a CoAP Message. It provides: [...]
CoapReregisteringEvent
Registering event
CoapReregistrationContext
Registration context
CoapResourceAttributes
Wraps different attributes that the CoAP protocol defines such as title, resource type or interface description. These attributes will also be included in the link description of the resource they belong to. For example, if a title was specified, the link description for a sensor resource might look like this </sensors>;title="Sensor Index"
CoapRespondEvent
Response event
CoapRespondingEvent
Responding event
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.
CoapScanner
String scanner
CoapSendingEmptyMessageEvent
Occurs when a an empty message is about to be sent.
CoapSendingRequestEvent
Occurs when a request is about to be sent.
CoapSendingResponseEvent
Occurs when a response is about to be sent.
CoapStack
Builds up the stack of CoAP layers that process the CoAP protocol.
CoapStackBottomLayer
Bottom layer
CoapStackTopLayer
Top layer
CoapSweepDeduplicator
Sweep deduplicator
CoapTimedOutEvent
Timed out event
CoapTokenLayer
Doesn't do much yet except for setting a simple token. Notice that empty tokens must be represented as byte array of length 0 (not null).
CoapTransmissionContext
Transmission context
CoapUDPChannel
Channel via UDP protocol.
CoapUtil
Utility methods
This class can be used to programmatically browse a remote CoAP endoint.
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.

Constants

optionTypeAccept → const int
C, Sequence of Bytes, 1-n B, -
17
optionTypeBlock1 → const int
27
optionTypeBlock2 → const int
23
optionTypeContentFormat → const int
C, 8-bit uint, 1 B, 0 (text/plain)
12
optionTypeContentType → const int
C, 8-bit uint, 1 B, 0 (text/plain)
12
optionTypeETag → const int
E, sequence of bytes, 1-4 B, -
4
optionTypeFencepostDivisor → const int
no-op for fenceposting
114
optionTypeIfMatch → const int
C, opaque, 0-8 B, -
1
optionTypeIfNoneMatch → const int
5
optionTypeLocationPath → const int
E, String, 1-270 B, -
8
optionTypeLocationQuery → const int
E, String, 1-270 B, -
20
optionTypeMaxAge → const int
E, variable length, 1--4 B, 60 Seconds
14
optionTypeObserve → const int
E, Duration, 1 B, 0
6
optionTypeProxyScheme → const int
39
optionTypeProxyUri → const int
C, String, 1-270 B, "coap"
35
optionTypeReserved → const int
0
optionTypeReserved1 → const int
128
optionTypeReserved2 → const int
132
optionTypeReserved3 → const int
136
optionTypeReserved4 → const int
140
optionTypeSize1 → const int
60
optionTypeSize2 → const int
28
optionTypeToken → const int
C, Sequence of Bytes, 1-2 B, -. NOTE: this option has been replaced with since draft 13. draft-ietf-core-coap-03, draft-ietf-core-coap-12
19
optionTypeUnknown → const int
CoAP option types as defined in RFC 7252, Section 12.2 and other CoAP extensions.
-1
optionTypeUriHost → const int
C, String, 1-270 B, ""
3
optionTypeUriPath → const int
C, String, 1-270 B, ""
11
optionTypeUriPort → const int
C, uint, 0-2 B
7
optionTypeUriQuery → const int
C, String, 1-270 B, ""
15

Enums

CoapOrigin
The origin of an exchange.
FailReason
Request fail reason
optionFormat
CoAP option formats

Typedefs

Action() → void
ActionGeneric<T>(T) → void
HookFunction() → void
TEntryFactoryFunc(TChain a, CoapEntry b, CoapEntry c, String d, TFilter e) CoapEntry
TEqualsFunc(TFilter a, TFilter b) bool
TFilterFactory<TFilter>() → TFilter
TNextFilterFactory<TNextFilter, TFilter>(TFilter v) → TNextFilter