coap_common.h File Reference

Definitions common to CoAP client and server. More...

#include "core/net.h"

Go to the source code of this file.

Macros

#define COAP_PORT   5683
 
#define COAPS_PORT   5684
 
#define COAP_MAX_TOKEN_LEN   8
 
#define COAP_PAYLOAD_MARKER   0xFF
 
#define COAP_CODE(c, d)   ((((c) & 0x07U) << 5U) | ((d) & 0x1FU))
 
#define COAP_GET_CODE_CLASS(code)   (((code) >> 5U) & 0x07U)
 
#define COAP_GET_CODE_SUBCLASS(code)   ((code) & 0x1FU)
 

Typedefs

struct {
   char_t   type
 
   uint32_t   dataStart
 
   uint32_t   dataLength
 
   uint8_t   nameLength
 
   char_t   name []
 
   uint8_t   tokenLen: 4
 
   uint8_t   type: 2
 
   uint8_t   version: 2
 
   uint8_t   code
 
   uint16_t   mid
 
   uint8_t   token []
 
   union {
      uint8_t   b [6]
 
      uint16_t   w [3]
 
   } 
 
   uint16_t   srcPort
 
   uint16_t   destPort
 
   uint32_t   seqNum
 
   uint32_t   ackNum
 
   uint8_t   reserved1: 4
 
   uint8_t   dataOffset: 4
 
   uint8_t   flags: 6
 
   uint8_t   reserved2: 2
 
   uint16_t   window
 
   uint16_t   checksum
 
   uint16_t   urgentPointer
 
   uint8_t   options []
 
   uint16_t   length
 
   uint8_t   data []
 
   uint8_t   op
 
   uint8_t   htype
 
   uint8_t   hlen
 
   uint8_t   hops
 
   uint32_t   xid
 
   uint16_t   secs
 
   uint16_t   flags
 
   Ipv4Addr   ciaddr
 
   Ipv4Addr   yiaddr
 
   Ipv4Addr   siaddr
 
   Ipv4Addr   giaddr
 
   MacAddr   chaddr
 
   uint8_t   unused [10]
 
   uint8_t   sname [64]
 
   uint8_t   file [128]
 
   uint32_t   magicCookie
 
   uint16_t   type
 
   uint16_t   hardwareType
 
   uint32_t   time
 
   MacAddr   linkLayerAddr
 
   uint16_t   id
 
   uint8_t   rd: 1
 
   uint8_t   tc: 1
 
   uint8_t   aa: 1
 
   uint8_t   opcode: 4
 
   uint8_t   qr: 1
 
   uint8_t   rcode: 4
 
   uint8_t   z: 3
 
   uint8_t   ra: 1
 
   uint16_t   qdcount
 
   uint16_t   ancount
 
   uint16_t   nscount
 
   uint16_t   arcount
 
   uint8_t   questions []
 
   uint16_t   controlWord
 
   uint16_t   byteCount
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint16_t   bcdUsb
 
   uint8_t   bDeviceClass
 
   uint8_t   bDeviceSubClass
 
   uint8_t   bDeviceProtocol
 
   uint8_t   bMaxPacketSize0
 
   uint16_t   idVendor
 
   uint16_t   idProduct
 
   uint16_t   bcdDevice
 
   uint8_t   iManufacturer
 
   uint8_t   iProduct
 
   uint8_t   iSerialNumber
 
   uint8_t   bNumConfigurations
 
   uint16_t   hrd
 
   uint16_t   pro
 
   uint8_t   hln
 
   uint8_t   pln
 
   uint16_t   op
 
   MacAddr   sha
 
   Ipv4Addr   spa
 
   MacAddr   tha
 
   Ipv4Addr   tpa
 
   uint8_t   maxRespTime
 
   Ipv4Addr   groupAddr
 
   uint8_t   length
 
   uint8_t   value []
 
   uint16_t   first
 
   uint16_t   last
 
   uint16_t   next
 
   union {
      uint8_t   b [16]
 
      uint16_t   w [8]
 
      uint32_t   dw [4]
 
   } 
 
   uint16_t   maxRespDelay
 
   uint16_t   reserved
 
   Ipv6Addr   multicastAddr
 
   uint32_t   reserved
 
   uint8_t   t: 1
 
   uint8_t   c: 1
 
   union {
      int32_t   integer
 
      uint8_t   octetString [1]
 
      uint8_t   oid [1]
 
      uint8_t   ipAddr [4]
 
      uint32_t   counter32
 
      uint32_t   gauge32
 
      uint32_t   unsigned32
 
      uint32_t   timeTicks
 
      uint64_t   counter64
 
   } 
 
   uint16_t   transactionId
 
   uint16_t   protocolId
 
   uint8_t   unitId
 
   uint8_t   pdu []
 
   uint8_t   retain: 1
 
   uint8_t   qos: 2
 
   uint8_t   dup: 1
 
   union {
      uint8_t   all
 
      struct {
         uint8_t   topicIdType: 2
 
         uint8_t   cleanSession: 1
 
         uint8_t   will: 1
 
         uint8_t   retain: 1
 
         uint8_t   qos: 2
 
         uint8_t   dup: 1
 
      } 
 
   } 
 
   uint8_t   b: 1
 
   uint8_t   identifier
 
   uint8_t   valueSize
 
   Ipv4Addr   srcIpAddr
 
   Ipv4Addr   destIpAddr
 
   Eui64   interfaceId
 
   uint16_t   mru
 
   uint8_t   peerIdLength
 
   uint8_t   peerId []
 
   uint32_t   seconds
 
   uint32_t   fraction
 
   uint16_t   opcode
 
   char_t   filename []
 
   uint8_t   reserved: 3
 
   uint8_t   fin: 1
 
   uint8_t   payloadLen: 7
 
   uint8_t   mask: 1
 
   uint8_t   extPayloadLen []
 
   uint32_t   length
 
   uint8_t   payload []
 
   uint32_t   packetLen
 
   uint8_t   paddingLen
 
   uint8_t   protocolVersionId
 
   uint8_t   bpduType
 
   StpBridgeId   rootId
 
   uint32_t   rootPathCost
 
   StpBridgeId   bridgeId
 
   uint16_t   portId
 
   uint16_t   messageAge
 
   uint16_t   maxAge
 
   uint16_t   helloTime
 
   uint16_t   forwardDelay
 
   uint8_t   version1Length
 
   uint16_t   priority
 
   MacAddr   addr
 
CoapMessageHeader
 CoAP message format. More...
 
struct {
   char_t   type
 
   uint32_t   dataStart
 
   uint32_t   dataLength
 
   uint8_t   nameLength
 
   uint8_t   length: 4
 
   uint8_t   delta: 4
 
   union {
      uint8_t   b [8]
 
      uint16_t   w [4]
 
      uint32_t   dw [2]
 
   } 
 
   uint8_t   kind
 
   uint8_t   value []
 
   uint8_t   code
 
   uint16_t   type
 
   uint32_t   enterpriseNumber
 
   uint8_t   identifier []
 
   uint16_t   qtype
 
   uint16_t   qclass
 
   uint16_t   statusWord
 
   uint16_t   byteCount
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint16_t   wTotalLength
 
   uint8_t   bNumInterfaces
 
   uint8_t   bConfigurationValue
 
   uint8_t   iConfiguration
 
   uint8_t   bmAttributes
 
   uint8_t   bMaxPower
 
   uint8_t   type
 
   uint16_t   checksum
 
   uint8_t   parameter
 
   uint8_t   unused [3]
 
   uint8_t   data []
 
   uint32_t   parameter
 
   uint8_t   nextHeader
 
   uint8_t   hdrExtLen
 
   uint8_t   options []
 
   uint8_t   curHopLimit
 
   uint8_t   reserved: 2
 
   uint8_t   p: 1
 
   uint8_t   prf: 2
 
   uint8_t   h: 1
 
   uint8_t   o: 1
 
   uint8_t   m: 1
 
   uint16_t   routerLifetime
 
   uint32_t   reachableTime
 
   uint32_t   retransTimer
 
   uint8_t   functionCode
 
   uint16_t   startingAddr
 
   uint16_t   quantityOfCoils
 
   uint16_t   length
 
   uint8_t   msgType
 
   uint16_t   flags
 
   Ipv4Addr   addr
 
   uint8_t   valueSize
 
   uint16_t   protocol
 
   uint32_t   accm
 
   uint8_t   msgLength
 
   uint8_t   message []
 
   uint8_t   mode: 3
 
   uint8_t   vn: 3
 
   uint8_t   li: 2
 
   uint8_t   stratum
 
   uint8_t   poll
 
   int8_t   precision
 
   uint32_t   rootDelay
 
   uint32_t   rootDispersion
 
   uint32_t   referenceId
 
   NtpTimestamp   referenceTimestamp
 
   NtpTimestamp   originateTimestamp
 
   NtpTimestamp   receiveTimestamp
 
   NtpTimestamp   transmitTimestamp
 
   uint16_t   opcode
 
   char_t   filename []
 
   uint16_t   value []
 
   uint16_t   group
 
   uint8_t   keyExchange []
 
   uint32_t   id
 
   uint32_t   dataLen
 
CoapOptionHeader
 CoAP option format. More...
 

Enumerations

enum  CoapProtocolLevel { COAP_VERSION_1 = 1 }
 CoAP version numbers. More...
 
enum  CoapTransportProtocol { COAP_TRANSPORT_PROTOCOL_UDP = 1, COAP_TRANSPORT_PROTOCOL_DTLS = 2 }
 CoAP transport protocols. More...
 
enum  CoapMessageType { COAP_TYPE_CON = 0, COAP_TYPE_NON = 1, COAP_TYPE_ACK = 2, COAP_TYPE_RST = 3 }
 CoAP message types. More...
 
enum  CoapCodeClass { COAP_CODE_CLASS_SUCCESS = 2, COAP_CODE_CLASS_CLIENT_ERROR = 4, COAP_CODE_CLASS_SERVER_ERROR = 5 }
 CoAP code classes. More...
 
enum  CoapCode {
  COAP_CODE_EMPTY = COAP_CODE(0, 0), COAP_CODE_GET = COAP_CODE(0, 1), COAP_CODE_POST = COAP_CODE(0, 2), COAP_CODE_PUT = COAP_CODE(0, 3),
  COAP_CODE_DELETE = COAP_CODE(0, 4), COAP_CODE_FETCH = COAP_CODE(0, 5), COAP_CODE_PATCH = COAP_CODE(0, 6), COAP_CODE_IPATCH = COAP_CODE(0, 7),
  COAP_CODE_CREATED = COAP_CODE(2, 1), COAP_CODE_DELETED = COAP_CODE(2, 2), COAP_CODE_VALID = COAP_CODE(2, 3), COAP_CODE_CHANGED = COAP_CODE(2, 4),
  COAP_CODE_CONTENT = COAP_CODE(2, 5), COAP_CODE_CONTINUE = COAP_CODE(2, 31), COAP_CODE_BAD_REQUEST = COAP_CODE(4, 0), COAP_CODE_UNAUTHOZED = COAP_CODE(4, 1),
  COAP_CODE_BAD_OPTION = COAP_CODE(4, 2), COAP_CODE_FORBIDDEN = COAP_CODE(4, 3), COAP_CODE_NOT_FOUND = COAP_CODE(4, 4), COAP_CODE_METHOD_NOT_ALLOWED = COAP_CODE(4, 5),
  COAP_CODE_NOT_ACCEPTABLE = COAP_CODE(4, 6), COAP_CODE_REQUEST_ENTITY_INCOMPLETE = COAP_CODE(4, 8), COAP_CODE_CONFLICT = COAP_CODE(4, 9), COAP_CODE_PRECONDITION_FAILED = COAP_CODE(4, 12),
  COAP_CODE_REQUEST_ENTITY_TO_LARGE = COAP_CODE(4, 13), COAP_CODE_UNSUPPORTED_CONTENT_FORMAT = COAP_CODE(4, 15), COAP_CODE_UNPROCESSABLE_ENTITY = COAP_CODE(4, 22), COAP_CODE_INTERNAL_SERVER = COAP_CODE(5, 0),
  COAP_CODE_NOT_IMPLEMENTED = COAP_CODE(5, 1), COAP_CODE_BAD_GATEWAY = COAP_CODE(5, 2), COAP_CODE_SERVICE_UNAVAILABLE = COAP_CODE(5, 3), COAP_CODE_GATEWAY_TIMEOUT = COAP_CODE(5, 4),
  COAP_CODE_PROXYING_NOT_SUPPORTED = COAP_CODE(5, 5), COAP_CODE_CSM = COAP_CODE(7, 1), COAP_CODE_PING = COAP_CODE(7, 2), COAP_CODE_PONG = COAP_CODE(7, 3),
  COAP_CODE_RELEASE = COAP_CODE(7, 4), COAP_CODE_ABORT = COAP_CODE(7, 5)
}
 CoAP method and response codes. More...
 

Detailed Description

Definitions common to CoAP client and server.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2020 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
2.0.0

Definition in file coap_common.h.

Macro Definition Documentation

◆ COAP_CODE

#define COAP_CODE (   c,
 
)    ((((c) & 0x07U) << 5U) | ((d) & 0x1FU))

Definition at line 49 of file coap_common.h.

◆ COAP_GET_CODE_CLASS

#define COAP_GET_CODE_CLASS (   code)    (((code) >> 5U) & 0x07U)

Definition at line 52 of file coap_common.h.

◆ COAP_GET_CODE_SUBCLASS

#define COAP_GET_CODE_SUBCLASS (   code)    ((code) & 0x1FU)

Definition at line 54 of file coap_common.h.

◆ COAP_MAX_TOKEN_LEN

#define COAP_MAX_TOKEN_LEN   8

Definition at line 43 of file coap_common.h.

◆ COAP_PAYLOAD_MARKER

#define COAP_PAYLOAD_MARKER   0xFF

Definition at line 46 of file coap_common.h.

◆ COAP_PORT

#define COAP_PORT   5683

Definition at line 38 of file coap_common.h.

◆ COAPS_PORT

#define COAPS_PORT   5684

Definition at line 40 of file coap_common.h.

Typedef Documentation

◆ CoapMessageHeader

typedef { ... } CoapMessageHeader

CoAP message format.

◆ CoapOptionHeader

typedef { ... } CoapOptionHeader

CoAP option format.

Enumeration Type Documentation

◆ CoapCode

enum CoapCode

CoAP method and response codes.

Enumerator
COAP_CODE_EMPTY 
COAP_CODE_GET 
COAP_CODE_POST 
COAP_CODE_PUT 
COAP_CODE_DELETE 
COAP_CODE_FETCH 
COAP_CODE_PATCH 
COAP_CODE_IPATCH 
COAP_CODE_CREATED 
COAP_CODE_DELETED 
COAP_CODE_VALID 
COAP_CODE_CHANGED 
COAP_CODE_CONTENT 
COAP_CODE_CONTINUE 
COAP_CODE_BAD_REQUEST 
COAP_CODE_UNAUTHOZED 
COAP_CODE_BAD_OPTION 
COAP_CODE_FORBIDDEN 
COAP_CODE_NOT_FOUND 
COAP_CODE_METHOD_NOT_ALLOWED 
COAP_CODE_NOT_ACCEPTABLE 
COAP_CODE_REQUEST_ENTITY_INCOMPLETE 
COAP_CODE_CONFLICT 
COAP_CODE_PRECONDITION_FAILED 
COAP_CODE_REQUEST_ENTITY_TO_LARGE 
COAP_CODE_UNSUPPORTED_CONTENT_FORMAT 
COAP_CODE_UNPROCESSABLE_ENTITY 
COAP_CODE_INTERNAL_SERVER 
COAP_CODE_NOT_IMPLEMENTED 
COAP_CODE_BAD_GATEWAY 
COAP_CODE_SERVICE_UNAVAILABLE 
COAP_CODE_GATEWAY_TIMEOUT 
COAP_CODE_PROXYING_NOT_SUPPORTED 
COAP_CODE_CSM 
COAP_CODE_PING 
COAP_CODE_PONG 
COAP_CODE_RELEASE 
COAP_CODE_ABORT 

Definition at line 110 of file coap_common.h.

◆ CoapCodeClass

CoAP code classes.

Enumerator
COAP_CODE_CLASS_SUCCESS 
COAP_CODE_CLASS_CLIENT_ERROR 
COAP_CODE_CLASS_SERVER_ERROR 

Definition at line 98 of file coap_common.h.

◆ CoapMessageType

CoAP message types.

Enumerator
COAP_TYPE_CON 

Confirmable message.

COAP_TYPE_NON 

Non-confirmable message.

COAP_TYPE_ACK 

Acknowledgment message.

COAP_TYPE_RST 

Reset message.

Definition at line 85 of file coap_common.h.

◆ CoapProtocolLevel

CoAP version numbers.

Enumerator
COAP_VERSION_1 

CoAP version 1.

Definition at line 66 of file coap_common.h.

◆ CoapTransportProtocol

CoAP transport protocols.

Enumerator
COAP_TRANSPORT_PROTOCOL_UDP 

UDP protocol.

COAP_TRANSPORT_PROTOCOL_DTLS 

DTLS protocol.

Definition at line 75 of file coap_common.h.

Variable Documentation

◆ code

uint8_t code

Definition at line 174 of file coap_common.h.

◆ delta

uint8_t delta

Definition at line 191 of file coap_common.h.

◆ length

uint8_t length

Definition at line 190 of file coap_common.h.

◆ mid

uint16_t mid

Definition at line 175 of file coap_common.h.

◆ token

uint8_t token[]

Definition at line 176 of file coap_common.h.

◆ tokenLen

uint8_t tokenLen

Definition at line 170 of file coap_common.h.

◆ type

uint8_t type

Definition at line 171 of file coap_common.h.

◆ version

uint8_t version

Definition at line 172 of file coap_common.h.