prf::coap namespace

Classes

class ControlInterfaceService
Thin CoAP adapter exposing PacketRF control exchange on POST /mgmt.
struct EndpointDescriptor
Static endpoint descriptor consumed by CoAP server.
struct EndpointTableView
Immutable view of one static endpoint table.
struct Request
Parsed request view forwarded to endpoint callback.
struct Response
Endpoint response data returned by callback.
class Server
Minimal CoAP server and router.

Enums

enum class MessageType: uint8_t { Confirmable = 0, NonConfirmable = 1, Acknowledgement = 2, Reset = 3 }
CoAP message type from fixed header.
enum class Method: uint8_t { Get = 1, Post = 2, Put = 3, Delete = 4 }
CoAP request method code subset used by firmware server dispatch.

Typedefs

using EndpointCallback = bool(*)(const Request&request, Response*out_response, void*user_ctx)
Endpoint callback type.

Functions

auto make_code(const uint8_t cls, const uint8_t detail) -> uint8_t constexpr
Helper for building CoAP code byte from class and detail fields.

Variables

size_t kCoapFixedHeaderBytes constexpr
size_t kCoapMaxContentFormatOptionBytes constexpr
size_t kCoapMaxDatagramBytes constexpr
size_t kCoapMaxPayloadBytes constexpr
size_t kCoapMaxPayloadMarkerBytes constexpr
size_t kCoapMaxTokenBytes constexpr
size_t kCoapMaxUriPathBytes constexpr

Enum documentation

enum class prf::coap::MessageType: uint8_t

CoAP message type from fixed header.

enum class prf::coap::Method: uint8_t

CoAP request method code subset used by firmware server dispatch.

Typedef documentation

using prf::coap::EndpointCallback = bool(*)(const Request&request, Response*out_response, void*user_ctx)

Endpoint callback type.

Function documentation

uint8_t prf::coap::make_code(const uint8_t cls, const uint8_t detail) constexpr

Helper for building CoAP code byte from class and detail fields.

Variable documentation

size_t prf::coap::kCoapFixedHeaderBytes constexpr

size_t prf::coap::kCoapMaxContentFormatOptionBytes constexpr

size_t prf::coap::kCoapMaxDatagramBytes constexpr

size_t prf::coap::kCoapMaxPayloadBytes constexpr

size_t prf::coap::kCoapMaxPayloadMarkerBytes constexpr

size_t prf::coap::kCoapMaxTokenBytes constexpr

size_t prf::coap::kCoapMaxUriPathBytes constexpr