net_2coap_8h_source.html

/*

 * SPDX-FileCopyrightText: 2018 Freie Universität Berlin

 * SPDX-License-Identifier: LGPL-2.1-only

 */


#pragma once


#include <stdbool.h>


#include "bitarithm.h"


#ifdef __cplusplus

extern "C" {

#endif


#define COAP_PORT               (5683)


#define COAPS_PORT              (5684)


#define COAP_V1                 (1)


#define COAP_OPT_IF_MATCH       (1)

#define COAP_OPT_URI_HOST       (3)

#define COAP_OPT_ETAG           (4)

#define COAP_OPT_IF_NONE_MATCH  (5)

#define COAP_OPT_OBSERVE        (6)

#define COAP_OPT_LOCATION_PATH  (8)

#define COAP_OPT_OSCORE         (9)

#define COAP_OPT_URI_PATH       (11)

#define COAP_OPT_CONTENT_FORMAT (12)

#define COAP_OPT_MAX_AGE        (14)

#define COAP_OPT_URI_QUERY      (15)

#define COAP_OPT_HOP_LIMIT      (16)

#define COAP_OPT_ACCEPT         (17)

#define COAP_OPT_Q_BLOCK1       (19)

#define COAP_OPT_LOCATION_QUERY (20)

#define COAP_OPT_EDHOC          (21)

#define COAP_OPT_BLOCK2         (23)

#define COAP_OPT_BLOCK1         (27)

#define COAP_OPT_SIZE2          (28)

#define COAP_OPT_Q_BLOCK2       (31)

#define COAP_OPT_PROXY_URI      (35)

#define COAP_OPT_PROXY_SCHEME   (39)

#define COAP_OPT_SIZE1          (60)

#define COAP_OPT_ECHO           (252)

#define COAP_OPT_NO_RESPONSE    (258)

#define COAP_OPT_REQUEST_TAG    (292)


#define COAP_TYPE_CON           (0)

#define COAP_TYPE_NON           (1)

#define COAP_TYPE_ACK           (2)

#define COAP_TYPE_RST           (3)


#define COAP_CLASS_REQ          (0)


typedef enum {

    COAP_METHOD_GET    = 1,

    COAP_METHOD_POST   = 2,

    COAP_METHOD_PUT    = 3,

    COAP_METHOD_DELETE = 4,

    COAP_METHOD_FETCH  = 5,

    COAP_METHOD_PATCH  = 6,

    COAP_METHOD_IPATCH = 7,

} coap_method_t;


#define COAP_CODE_EMPTY         (0)


#define COAP_CLASS_SUCCESS      (2)

#define COAP_CODE_CREATED      ((2 << 5) | 1)

#define COAP_CODE_DELETED      ((2 << 5) | 2)

#define COAP_CODE_VALID        ((2 << 5) | 3)

#define COAP_CODE_CHANGED      ((2 << 5) | 4)

#define COAP_CODE_204          ((2 << 5) | 4)

#define COAP_CODE_CONTENT      ((2 << 5) | 5)

#define COAP_CODE_205          ((2 << 5) | 5)

#define COAP_CODE_CONTINUE     ((2 << 5) | 31)

#define COAP_CODE_231          ((2 << 5) | 31)


#define COAP_CLASS_CLIENT_FAILURE             (4)

#define COAP_CODE_BAD_REQUEST                ((4 << 5) | 0)

#define COAP_CODE_UNAUTHORIZED               ((4 << 5) | 1)

#define COAP_CODE_BAD_OPTION                 ((4 << 5) | 2)

#define COAP_CODE_FORBIDDEN                  ((4 << 5) | 3)

#define COAP_CODE_PATH_NOT_FOUND             ((4 << 5) | 4)

#define COAP_CODE_404                        ((4 << 5) | 4)

#define COAP_CODE_METHOD_NOT_ALLOWED         ((4 << 5) | 5)

#define COAP_CODE_NOT_ACCEPTABLE             ((4 << 5) | 6)

#define COAP_CODE_REQUEST_ENTITY_INCOMPLETE  ((4 << 5) | 8)

#define COAP_CODE_CONFLICT                   ((4 << 5) | 9)

#define COAP_CODE_PRECONDITION_FAILED        ((4 << 5) | 12)

#define COAP_CODE_REQUEST_ENTITY_TOO_LARGE   ((4 << 5) | 13)

#define COAP_CODE_UNSUPPORTED_CONTENT_FORMAT ((4 << 5) | 15)

#define COAP_CODE_UNPROCESSABLE_ENTITY       ((4 << 5) | 22)

#define COAP_CODE_TOO_MANY_REQUESTS          ((4 << 5) | 29)


#define COAP_CLASS_SERVER_FAILURE             (5)

#define COAP_CODE_INTERNAL_SERVER_ERROR      ((5 << 5) | 0)

#define COAP_CODE_NOT_IMPLEMENTED            ((5 << 5) | 1)

#define COAP_CODE_BAD_GATEWAY                ((5 << 5) | 2)

#define COAP_CODE_SERVICE_UNAVAILABLE        ((5 << 5) | 3)

#define COAP_CODE_GATEWAY_TIMEOUT            ((5 << 5) | 4)

#define COAP_CODE_PROXYING_NOT_SUPPORTED     ((5 << 5) | 5)


#define COAP_FORMAT_TEXT                      (0)

#define COAP_FORMAT_COSE_ENCRYPT0            (16)

#define COAP_FORMAT_COSE_MAC0                (17)

#define COAP_FORMAT_COSE_SIGN1               (18)

#define COAP_FORMAT_ACE_CBOR                 (19)

#define COAP_FORMAT_IMAGE_GIF                (21)

#define COAP_FORMAT_IMAGE_JPEG               (22)

#define COAP_FORMAT_IMAGE_PNG                (23)

#define COAP_FORMAT_LINK                     (40)

#define COAP_FORMAT_XML                      (41)

#define COAP_FORMAT_OCTET                    (42)

#define COAP_FORMAT_EXI                      (47)

#define COAP_FORMAT_JSON                     (50)

#define COAP_FORMAT_JSON_PATCH_JSON          (51)

#define COAP_FORMAT_MERGE_PATCH_JSON         (52)

#define COAP_FORMAT_CBOR                     (60)

#define COAP_FORMAT_CWT                      (61)

#define COAP_FORMAT_MULTIPART_CORE           (62)

#define COAP_FORMAT_CBOR_SEQ                 (63)

#define COAP_FORMAT_COSE_ENCRYPT             (96)

#define COAP_FORMAT_COSE_MAC                 (97)

#define COAP_FORMAT_COSE_SIGN                (98)

#define COAP_FORMAT_COSE_KEY                (101)

#define COAP_FORMAT_COSE_KEY_SET            (102)

#define COAP_FORMAT_SENML_JSON              (110)

#define COAP_FORMAT_SENSML_JSON             (111)

#define COAP_FORMAT_SENML_CBOR              (112)

#define COAP_FORMAT_SENSML_CBOR             (113)

#define COAP_FORMAT_SENML_EXI               (114)

#define COAP_FORMAT_SENSML_EXI              (115)

#define COAP_FORMAT_YANG_DATA_CBOR_SID      (140)

#define COAP_FORMAT_COAP_GROUP_JSON         (256)

#define COAP_FORMAT_PROBLEM_DETAILS_CBOR    (257)

#define COAP_FORMAT_SWID_CBOR               (258)

#define COAP_FORMAT_PKIXCMP                 (259)

#define COAP_FORMAT_DOTS_CBOR               (271)

#define COAP_FORMAT_MISSING_BLOCKS_CBOR_SEQ (272)

#define COAP_FORMAT_PKCS7_MIME_SERVER_GEN   (280)

#define COAP_FORMAT_PKCS7_MIME_CERTS_ONLY   (281)

#define COAP_FORMAT_PKCS8                   (284)

#define COAP_FORMAT_CSRATTRS                (285)

#define COAP_FORMAT_PKCS10                  (286)

#define COAP_FORMAT_PKIX_CERT               (287)

#define COAP_FORMAT_AIF_CBOR                (290)

#define COAP_FORMAT_AIF_JSON                (291)

#define COAP_FORMAT_SENML_XML               (310)

#define COAP_FORMAT_SENSML_XML              (311)

#define COAP_FORMAT_SNML_ETCH_JSON          (320)

#define COAP_FORMAT_SNML_ETCH_CBOR          (322)

#define COAP_FORMAT_YAML_DATA_CBOR          (340)

#define COAP_FORMAT_YAML_DATA_CBOR_ID_NAME  (341)

#define COAP_FORMAT_TD_JSON                 (432)

#define COAP_FORMAT_TM_JSON                 (433)

#define COAP_FORMAT_DNS_MESSAGE             (553)

#define COAP_FORMAT_VOUCER_COSE_CBOR        (836)

#define COAP_FORMAT_VND_OCF_CBOR          (10000)

#define COAP_FORMAT_OSCORE                (10001)

#define COAP_FORMAT_JAVASCRIPT            (10002)

#define COAP_FORMAT_JSON_DEFLATE          (11050)

#define COAP_FORMAT_CBOR_DEFLATE          (11060)

#define COAP_FORMAT_VND_OMA_LWM2M_TLV     (11542)

#define COAP_FORMAT_VND_OMA_LWM2M_JSON    (11543)

#define COAP_FORMAT_VND_OMA_LWM2M_CBOR    (11544)

#define COAP_FORMAT_TEXT_CSS              (20000)

#define COAP_FORMAT_IMAGE_SVG_XML         (30000)


#define COAP_OBS_REGISTER        (0)

#define COAP_OBS_DEREGISTER      (1)

#define COAP_OBS_MAX_VALUE_MASK  (0xffffff)


#define COAP_TOKEN_LENGTH_MAX    (8)


#define COAP_ETAG_LENGTH_MAX     (8U)


#define COAP_PAYLOAD_MARKER      (0xFF)

#define COAP_PAYLOAD_MARKER_SIZE (1U)


#ifndef CONFIG_COAP_ACK_TIMEOUT_MS

#define CONFIG_COAP_ACK_TIMEOUT_MS     (2000)

#endif


#ifndef CONFIG_COAP_RANDOM_FACTOR_1000

#define CONFIG_COAP_RANDOM_FACTOR_1000      (1500)

#endif


#ifndef CONFIG_COAP_SEPARATE_RESPONSE_TIMEOUT_MS

#define CONFIG_COAP_SEPARATE_RESPONSE_TIMEOUT_MS    (10 * MS_PER_SEC)

#endif


#ifndef CONFIG_COAP_MAX_RETRANSMIT

#define CONFIG_COAP_MAX_RETRANSMIT     (4)

#endif


#define COAP_NSTART             (1)

#define COAP_DEFAULT_LEISURE    (5)


#define COAP_BLOCKWISE_NUM_OFF  (4)

#define COAP_BLOCKWISE_NUM_MAX  (0xfffffU)

#define COAP_BLOCKWISE_MORE_OFF (3)

#define COAP_BLOCKWISE_SZX_MASK (0x07)

#define COAP_BLOCKWISE_SZX_MAX  (7)


typedef enum {

    COAP_BLOCKSIZE_16 = 0,

    COAP_BLOCKSIZE_32,

    COAP_BLOCKSIZE_64,

    COAP_BLOCKSIZE_128,

    COAP_BLOCKSIZE_256,

    COAP_BLOCKSIZE_512,

    COAP_BLOCKSIZE_1024,

} coap_blksize_t;


#define COAP_SZX2SIZE(szx) \

    (1U << (4U + (szx)))


static inline unsigned coap_szx2size(coap_blksize_t szx)

{

    if ((unsigned)szx > (unsigned)COAP_BLOCKSIZE_1024) {

        return 0;

    }


    return COAP_SZX2SIZE(szx);

}


static inline coap_blksize_t coap_size2szx(unsigned size)

{

    if (size < 32) {

        return COAP_BLOCKSIZE_16;

    }


    if (size >= 1024) {

        return COAP_BLOCKSIZE_1024;

    }


    return bitarithm_msb(size >> 4);

}


#ifdef __cplusplus

}

#endif


bitarithm.h
Helper functions for bit arithmetic.

bitarithm_msb
static unsigned bitarithm_msb(unsigned v)
Returns the number of the highest '1' bit in a value.
Definition bitarithm.h:149

coap_blksize_t
coap_blksize_t
CoAP block-wise-transfer size SZX.
Definition coap.h:632

coap_size2szx
static coap_blksize_t coap_size2szx(unsigned size)
Get the closest blocksize enum for given size.
Definition coap.h:693

coap_szx2size
static unsigned coap_szx2size(coap_blksize_t szx)
Convert a coap_blksize_t constant to a size in bytes.
Definition coap.h:672

COAP_SZX2SIZE
#define COAP_SZX2SIZE(szx)
Convert a coap_blksize_t constant to a size in bytes without error checking.
Definition coap.h:656

coap_method_t
coap_method_t
CoAP method codes used in request.
Definition coap.h:171

COAP_METHOD_GET
@ COAP_METHOD_GET
GET request (no paylod)
Definition coap.h:172

COAP_METHOD_IPATCH
@ COAP_METHOD_IPATCH
iPATCH request (RFC 8132)
Definition coap.h:178

COAP_METHOD_PUT
@ COAP_METHOD_PUT
PUT request (update resource with payload)
Definition coap.h:174

COAP_METHOD_POST
@ COAP_METHOD_POST
POST request (resource processes payload)
Definition coap.h:173

COAP_METHOD_PATCH
@ COAP_METHOD_PATCH
PATCH request (RFC 8132)
Definition coap.h:177

COAP_METHOD_DELETE
@ COAP_METHOD_DELETE
DELETE request (no payload, remove resource)
Definition coap.h:175

COAP_METHOD_FETCH
@ COAP_METHOD_FETCH
FETCH request (RFC 8132)
Definition coap.h:176