KoAP

KoAP/com.juul.koap/Message/Option

Option

sealed class Option

CoAP Option Numbers:

No.	Name	Format	Length	Proposed Standard
1	If-Match	opaque	0-8	RFC 7252 CoAP 5.10.8.1
3	Uri-Host	string	1-255	RFC 7252 CoAP 5.10.1
4	ETag	opaque	1-8	RFC 7252 CoAP 5.10.6
5	If-None-Match	empty	0	RFC 7252 CoAP 5.10.8.2
6	Observe	uint	0-3	RFC 7641 Observing Resources 2
7	Uri-Port	uint	0-2	RFC 7252 CoAP 5.10.1
8	Location-Path	string	0-255	RFC 7252 CoAP 5.10.7
9	OSCORE	opaque	0-255	RFC 8613 OSCORE 2
11	Uri-Path	string	0-255	RFC 7252 CoAP 5.10.1
12	Content-Format	uint	0-2	RFC 7252 CoAP 5.10.3
14	Max-Age	uint	0-4	RFC 7252 CoAP 5.10.5
15	Uri-Query	string	0-255	RFC 7252 CoAP 5.10.1
16	Hop-Limit	uint	1	RFC 8768 Hop-Limit 3
17	Accept	uint	0-2	RFC 7252 CoAP 5.10.4
19	Q-Block1	uint	0-3	RFC 9177 Block-Wise Robust 4
20	Location-Query	string	0-255	RFC 7252 CoAP 5.10.7
21	EDHOC	empty	0	RFC 9668 EDHOC 3.1
23	Block2	uint	0-3	RFC 7959 Block-Wise 2.1
27	Block1	uint	0-3	RFC 7959 Block-Wise 2.1
28	Size2	uint	0-4	RFC 7959 Block-Wise 4
31	Q-Block2	uint	0-3	RFC 9177 Block-Wise Robust 4
35	Proxy-Uri	string	1-1034	RFC 7252 CoAP 5.10.2
39	Proxy-Scheme	string	1-255	RFC 7252 CoAP 5.10.2
60	Size1	uint	0-4	RFC 7959 Block-Wise 4 (and CoAP 5.10.9)
252	Echo	opaque	1-40	RFC 9175 Echo, Request-Tag 2.2.1
258	No-Response	uint	0-1	RFC 7967 No Server Response 2
292	Request-Tag	opaque	0-8	RFC 9175 Echo, Request-Tag 3.2.1

Inheritors

Types

data class Accept(val format: Long) : Message.Option

RFC 7252 5.10.4. Accept

interface Block

data class Block1(val number: Int, val more: Boolean, val size: Message.Option.Block.Size) : Message.Option, Message.Option.Block

RFC 7959 2.1. The Block2 and Block1 Options

data class Block2(val number: Int, val more: Boolean, val size: Message.Option.Block.Size) : Message.Option, Message.Option.Block

RFC 7959 2.1. The Block2 and Block1 Options

data class ContentFormat(val format: Long) : Message.Option

RFC 7252 5.10.3. Content-Format

data class Echo(val value: ByteArray) : Message.Option

RFC 9175 2.2.1. Echo

object Edhoc : Message.Option

RFC 9668 3.1. EDHOC

data class ETag(val etag: ByteArray) : Message.Option

RFC 7252 5.10.6. ETag

ExperimentalUse

data class ExperimentalUse(val number: Int, val value: ByteArray) : Message.Option

RFC 7252 12.2. CoAP Option Numbers Registry, Table 8, Experimental use

sealed class Format : Message.Option

RFC 7252 3.1. Option Format

data class HopLimit(val hops: Long) : Message.Option

RFC 8768 3. Hop-Limit

data class IfMatch(val etag: ByteArray) : Message.Option

RFC 7252 5.10.8.1. If-Match

object IfNoneMatch : Message.Option

RFC 7252 5.10.8.2. If-None-Match

data class LocationPath(val uri: String) : Message.Option

RFC 7252 5.10.7. Location-Path and Location-Query

data class LocationQuery(val uri: String) : Message.Option

RFC 7252 5.10.7. Location-Path and Location-Query

data class MaxAge(val seconds: Long) : Message.Option

RFC 7252 5.10.5. Max-Age

data class NoResponse(val value: Long) : Message.Option

RFC 7967 2. Option Definition for no server response.

data class Observe(val value: Long) : Message.Option

RFC 7641 2. The Observe Option

data class Oscore(val value: ByteArray) : Message.Option

RFC 8613 2. OSCORE

data class ProxyScheme(val uri: String) : Message.Option

RFC 7252 5.10.2. Proxy-Uri and Proxy-Scheme

data class ProxyUri(val uri: String) : Message.Option

RFC 7252 5.10.2. Proxy-Uri and Proxy-Scheme

data class QBlock1(val number: Int, val more: Boolean, val size: Message.Option.Block.Size) : Message.Option, Message.Option.Block

RFC 9177 4. The Q-Block1 and Q-Block2 Options

data class QBlock2(val number: Int, val more: Boolean, val size: Message.Option.Block.Size) : Message.Option, Message.Option.Block

RFC 9177 4. The Q-Block1 and Q-Block2 Options

data class RequestTag(val tag: ByteArray) : Message.Option

RFC 9175 3.2.1. Request-Tag

data class Reserved : Message.Option

RFC 7252 5.10.7. Location-Path and Location-Query reserved option numbers, and zero

data class Size1(val bytes: Long) : Message.Option

RFC 7252 5.10.9. Size1 Option

data class Size2(val bytes: Long) : Message.Option

RFC 7959 4. The Size2 and Size1 Options

data class Unassigned : Message.Option

data class UriHost(val uri: String) : Message.Option

RFC 7252 5.10.1. Uri-Host, Uri-Port, Uri-Path, and Uri-Query

data class UriPath(val uri: String) : Message.Option

RFC 7252 5.10.1. Uri-Host, Uri-Port, Uri-Path, and Uri-Query

data class UriPort(val port: Long) : Message.Option

RFC 7252 5.10.1. Uri-Host, Uri-Port, Uri-Path, and Uri-Query

data class UriQuery(val uri: String) : Message.Option

RFC 7252 5.10.1. Uri-Host, Uri-Port, Uri-Path, and Uri-Query