Package-level declarations
Types
The value of a Block1 or Block2 option (RFC 7959 §2.2): block number, more flag and size exponent. Size exponent 7 is BERT, defined only for reliable transports (RFC 8323 §6).
A CoAP message (RFC 7252 §3): header fields, token, options and payload. Immutable; derive changed copies with toBuilder.
Message types of CoAP over UDP (RFC 7252 §3). Reliable transports have no type (RFC 8323 §3.2).
One option in a message: a number and its raw value (RFC 7252 §5.4). The meaning of the number, if registered, is in definition.
Options from RFC 7252 and the extensions this library targets.
A request as the client application states it: method, target URI, further options and the whole body. The client turns the URI into Uri-* options (RFC 7252 §6.4), splits a large body into Block1 transfers and assigns token and Message ID. Immutable; build one with Builder or the client's method shortcuts. Two requests are equal when method, URI, options, body (by content) and isConfirmable are, as two CoapResponses are by their parts.
A response as the application sees it: code, options and the whole body. Block-wise transfers are already reassembled, and the messaging-layer fields (type, Message ID, token) are not part of it.
Content-Format identifiers (IANA "CoAP Content-Formats", RFC 7252 §12.3) used across kcoap.
The CoRE Link Format of RFC 6690, application/link-format (ContentFormat.LINK_FORMAT), as served by /.well-known/core.
A registered CoAP option. Critical / Unsafe / NoCacheKey are derived from the option number (RFC 7252 §5.4.6), so they cannot drift from the registry.
Option value formats, RFC 7252 §3.2.
The options of a message, kept in ascending number order as they are encoded. Repeated options keep their relative order, which matters for Uri-Path and the like (RFC 7252 §5.4.5).
How OSCORE protects an option, RFC 8613 §4.1. Some options may appear both as Inner and Outer.
A Signaling Option (RFC 8323 §5.2, §11.2). Signaling option numbers are scoped to their signaling code: 2 is Max-Message-Size in a CSM, Custody in a Ping or Pong, Alternative-Address in a Release and Bad-CSM-Option in an Abort. They share no number space with the request and response options of CoapOptions. Critical or elective follows from the number as in RFC 7252 §5.4.6.
The CoAP Signaling Option Numbers registry of RFC 8323 §11.2.