Google is committed to advancing racial equity for Black communities. See how.
Cette page a été traduite par l'API Cloud Translation.
Switch to English

CoAP

Ce module comprend des fonctions qui contrôlent la communication CoAP.

Résumé

Les fonctions de ce module sont disponibles lorsque la fonction API CoAP ( OPENTHREAD_CONFIG_COAP_API_ENABLE ) est activée.

Énumérations

otCoapBlockSize énumération
Exposants de taille de bloc CoAP.
otCoapCode {
OT_COAP_CODE_EMPTY = (((( 0 )&0x7) << 5) | (( 0 )&0x1f)),
OT_COAP_CODE_GET = (((( 0 )&0x7) << 5) | (( 1 )&0x1f)),
OT_COAP_CODE_POST = (((( 0 )&0x7) << 5) | (( 2 )&0x1f)),
OT_COAP_CODE_PUT = (((( 0 )&0x7) << 5) | (( 3 )&0x1f)),
OT_COAP_CODE_DELETE = (((( 0 )&0x7) << 5) | (( 4 )&0x1f)),
OT_COAP_CODE_RESPONSE_MIN = (((( 2 )&0x7) << 5) | (( 0 )&0x1f)),
OT_COAP_CODE_CREATED = (((( 2 )&0x7) << 5) | (( 1 )&0x1f)),
OT_COAP_CODE_DELETED = (((( 2 )&0x7) << 5) | (( 2 )&0x1f)),
OT_COAP_CODE_VALID = (((( 2 )&0x7) << 5) | (( 3 )&0x1f)),
OT_COAP_CODE_CHANGED = (((( 2 )&0x7) << 5) | (( 4 )&0x1f)),
OT_COAP_CODE_CONTENT = (((( 2 )&0x7) << 5) | (( 5 )&0x1f)),
OT_COAP_CODE_CONTINUE = (((( 2 )&0x7) << 5) | (( 31 )&0x1f)),
OT_COAP_CODE_BAD_REQUEST = (((( 4 )&0x7) << 5) | (( 0 )&0x1f)),
OT_COAP_CODE_UNAUTHORIZED = (((( 4 )&0x7) << 5) | (( 1 )&0x1f)),
OT_COAP_CODE_BAD_OPTION = (((( 4 )&0x7) << 5) | (( 2 )&0x1f)),
OT_COAP_CODE_FORBIDDEN = (((( 4 )&0x7) << 5) | (( 3 )&0x1f)),
OT_COAP_CODE_NOT_FOUND = (((( 4 )&0x7) << 5) | (( 4 )&0x1f)),
OT_COAP_CODE_METHOD_NOT_ALLOWED = (((( 4 )&0x7) << 5) | (( 5 )&0x1f)),
OT_COAP_CODE_NOT_ACCEPTABLE = (((( 4 )&0x7) << 5) | (( 6 )&0x1f)),
OT_COAP_CODE_REQUEST_INCOMPLETE = (((( 4 )&0x7) << 5) | (( 8 )&0x1f)),
OT_COAP_CODE_PRECONDITION_FAILED = (((( 4 )&0x7) << 5) | (( 12 )&0x1f)),
OT_COAP_CODE_REQUEST_TOO_LARGE = (((( 4 )&0x7) << 5) | (( 13 )&0x1f)),
OT_COAP_CODE_UNSUPPORTED_FORMAT = (((( 4 )&0x7) << 5) | (( 15 )&0x1f)),
OT_COAP_CODE_INTERNAL_ERROR = (((( 5 )&0x7) << 5) | (( 0 )&0x1f)),
OT_COAP_CODE_NOT_IMPLEMENTED = (((( 5 )&0x7) << 5) | (( 1 )&0x1f)),
OT_COAP_CODE_BAD_GATEWAY = (((( 5 )&0x7) << 5) | (( 2 )&0x1f)),
OT_COAP_CODE_SERVICE_UNAVAILABLE = (((( 5 )&0x7) << 5) | (( 3 )&0x1f)),
OT_COAP_CODE_GATEWAY_TIMEOUT = (((( 5 )&0x7) << 5) | (( 4 )&0x1f)),
OT_COAP_CODE_PROXY_NOT_SUPPORTED = (((( 5 )&0x7) << 5) | (( 5 )&0x1f))
}
énumération
Valeurs du code CoAP.
otCoapOptionContentFormat {
OT_COAP_OPTION_CONTENT_FORMAT_TEXT_PLAIN = 0,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0 = 16,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0 = 17,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1 = 18,
OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT = 40,
OT_COAP_OPTION_CONTENT_FORMAT_XML = 41,
OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM = 42,
OT_COAP_OPTION_CONTENT_FORMAT_EXI = 47,
OT_COAP_OPTION_CONTENT_FORMAT_JSON = 50,
OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON = 51,
OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON = 52,
OT_COAP_OPTION_CONTENT_FORMAT_CBOR = 60,
OT_COAP_OPTION_CONTENT_FORMAT_CWT = 61,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT = 96,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC = 97,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN = 98,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY = 101,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET = 102,
OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON = 110,
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_JSON = 111,
OT_COAP_OPTION_CONTENT_FORMAT_SENML_CBOR = 112,
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_CBOR = 113,
OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI = 114,
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_EXI = 115,
OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON = 256,
OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML = 310,
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_XML = 311
}
énumération
Codes de format de contenu CoAP.
otCoapOptionType {
OT_COAP_OPTION_IF_MATCH = 1,
OT_COAP_OPTION_URI_HOST = 3,
OT_COAP_OPTION_E_TAG = 4,
OT_COAP_OPTION_IF_NONE_MATCH = 5,
OT_COAP_OPTION_OBSERVE = 6,
OT_COAP_OPTION_URI_PORT = 7,
OT_COAP_OPTION_LOCATION_PATH = 8,
OT_COAP_OPTION_URI_PATH = 11,
OT_COAP_OPTION_CONTENT_FORMAT = 12,
OT_COAP_OPTION_MAX_AGE = 14,
OT_COAP_OPTION_URI_QUERY = 15,
OT_COAP_OPTION_ACCEPT = 17,
OT_COAP_OPTION_LOCATION_QUERY = 20,
OT_COAP_OPTION_BLOCK2 = 23,
OT_COAP_OPTION_BLOCK1 = 27,
OT_COAP_OPTION_PROXY_URI = 35,
OT_COAP_OPTION_PROXY_SCHEME = 39,
OT_COAP_OPTION_SIZE1 = 60
}
énumération
Numéros d'option CoAP.
otCoapType {
OT_COAP_TYPE_CONFIRMABLE = 0,
OT_COAP_TYPE_NON_CONFIRMABLE = 1,
OT_COAP_TYPE_ACKNOWLEDGMENT = 2,
OT_COAP_TYPE_RESET = 3
}
énumération
Valeurs de type CoAP (entier non signé 2 bits).

Typedefs

otCoapBlockSize typedef
Exposants de taille de bloc CoAP.
otCoapCode typedef
enum otCoapCode
Valeurs du code CoAP.
otCoapOption typedef
struct otCoapOption
Cette structure représente une option CoAP.
otCoapOptionContentFormat typedef
Codes de format de contenu CoAP.
otCoapOptionIterator typedef
Cette structure agit comme un itérateur pour les options CoAP.
otCoapOptionType typedef
Numéros d'option CoAP.
otCoapRequestHandler )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
void(*
Ce pointeur de fonction est appelé lorsqu'une demande CoAP avec un Uri-Path donné est reçue.
otCoapResource typedef
Cette structure représente une ressource CoAP.
otCoapResponseHandler )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult) typedef
void(*
Ce pointeur de fonction est appelé lorsqu'une réponse CoAP est reçue ou à l'expiration du délai de demande.
otCoapTxParameters typedef
Cette structure représente les paramètres de transmission CoAP.
otCoapType typedef
enum otCoapType
Valeurs de type CoAP (entier non signé 2 bits).

Les fonctions

otCoapAddResource ( otInstance *aInstance, otCoapResource *aResource)
void
Cette fonction ajoute une ressource au serveur CoAP.
otCoapBlockSizeFromExponent ( otCoapBlockSize aSize)
uint16_t
Cette fonction convertit un champ SZX d'option de bloc CoAP en taille de bloc réelle.
otCoapMessageAppendBlock1Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSize aSize)
Cette fonction ajoute une option Block1.
otCoapMessageAppendBlock2Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSize aSize)
Cette fonction ajoute une option Block2.
otCoapMessageAppendContentFormatOption ( otMessage *aMessage, otCoapOptionContentFormat aContentFormat)
Cette fonction ajoute l'option Content Format CoAP comme spécifié dans https://tools.ietf.org/html/rfc7252#page-92 .
otCoapMessageAppendMaxAgeOption ( otMessage *aMessage, uint32_t aMaxAge)
Cette fonction ajoute une option Max-Age.
otCoapMessageAppendObserveOption ( otMessage *aMessage, uint32_t aObserve)
Cette fonction ajoute une option Observer.
otCoapMessageAppendOption ( otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue)
Cette fonction ajoute une option CoAP dans un en-tête.
otCoapMessageAppendProxyUriOption ( otMessage *aMessage, const char *aUriPath)
Cette fonction ajoute une option Proxy-Uri.
otCoapMessageAppendUintOption ( otMessage *aMessage, uint16_t aNumber, uint32_t aValue)
Cette fonction ajoute une option CoAP d'entier non signé comme spécifié dans https://tools.ietf.org/html/rfc7252#section-3.2 .
otCoapMessageAppendUriPathOptions ( otMessage *aMessage, const char *aUriPath)
Cette fonction ajoute une option Uri-Path.
otCoapMessageAppendUriQueryOption ( otMessage *aMessage, const char *aUriQuery)
Cette fonction ajoute une seule option Uri-Query.
otCoapMessageCodeToString (const otMessage *aMessage)
const char *
Cette méthode renvoie le code CoAP sous forme de chaîne lisible par l'homme.
otCoapMessageGenerateToken ( otMessage *aMessage, uint8_t aTokenLength)
void
Cette fonction définit la longueur du jeton et randomise sa valeur.
otCoapMessageGetCode (const otMessage *aMessage)
Cette fonction renvoie la valeur Code.
otCoapMessageGetMessageId (const otMessage *aMessage)
uint16_t
Cette fonction renvoie la valeur de l'ID de message.
otCoapMessageGetToken (const otMessage *aMessage)
const uint8_t *
Cette fonction renvoie un pointeur sur la valeur du jeton.
otCoapMessageGetTokenLength (const otMessage *aMessage)
uint8_t
Cette fonction renvoie la longueur du jeton.
otCoapMessageGetType (const otMessage *aMessage)
Cette fonction renvoie la valeur Type.
otCoapMessageInit ( otMessage *aMessage, otCoapType aType, otCoapCode aCode)
void
Cette fonction initialise l'en-tête CoAP.
otCoapMessageInitResponse ( otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode)
Cette fonction initialise un message de réponse.
otCoapMessageSetPayloadMarker ( otMessage *aMessage)
Cette fonction ajoute un marqueur de charge utile indiquant le début de la charge utile à l'en-tête CoAP.
otCoapMessageSetToken ( otMessage *aMessage, const uint8_t *aToken, uint8_t aTokenLength)
Cette fonction définit la valeur et la longueur du jeton dans un en-tête.
otCoapNewMessage ( otInstance *aInstance, const otMessageSettings *aSettings)
Cette fonction crée un nouveau message CoAP.
otCoapOptionIteratorGetFirstOption ( otCoapOptionIterator *aIterator)
const otCoapOption *
Cette fonction renvoie un pointeur vers la première option.
otCoapOptionIteratorGetFirstOptionMatching ( otCoapOptionIterator *aIterator, uint16_t aOption)
const otCoapOption *
Cette fonction renvoie un pointeur vers la première option correspondant au numéro d'option spécifié.
otCoapOptionIteratorGetNextOption ( otCoapOptionIterator *aIterator)
const otCoapOption *
Cette fonction renvoie un pointeur vers l'option suivante.
otCoapOptionIteratorGetNextOptionMatching ( otCoapOptionIterator *aIterator, uint16_t aOption)
const otCoapOption *
Cette fonction renvoie un pointeur vers l'option suivante correspondant au numéro d'option spécifié.
otCoapOptionIteratorGetOptionUintValue ( otCoapOptionIterator *aIterator, uint64_t *const aValue)
Cette fonction remplit la valeur de l'option actuelle dans aValue supposant que la valeur actuelle est un entier non signé encodé selon https://tools.ietf.org/html/rfc7252#section-3.2 .
otCoapOptionIteratorGetOptionValue ( otCoapOptionIterator *aIterator, void *aValue)
Cette fonction remplit la valeur de l'option actuelle dans aValue .
otCoapOptionIteratorInit ( otCoapOptionIterator *aIterator, const otMessage *aMessage)
Cette fonction initialise un itérateur pour les options du message donné.
otCoapRemoveResource ( otInstance *aInstance, otCoapResource *aResource)
void
Cette fonction supprime une ressource du serveur CoAP.
otCoapSendRequest ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext)
Cette fonction envoie une requête CoAP.
otCoapSendRequestWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters)
Cette fonction envoie une requête CoAP avec des paramètres de transmission personnalisés.
otCoapSendResponse ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo)
Cette fonction envoie une réponse CoAP du serveur.
otCoapSendResponseWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters)
Cette fonction envoie une réponse CoAP du serveur avec des paramètres de transmission personnalisés.
otCoapSetDefaultHandler ( otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext)
void
Cette fonction définit le gestionnaire par défaut pour les demandes CoAP non gérées.
otCoapStart ( otInstance *aInstance, uint16_t aPort)
Cette fonction démarre le serveur CoAP.
otCoapStop ( otInstance *aInstance)
Cette fonction arrête le serveur CoAP.

Structs

otCoapOption

Cette structure représente une option CoAP.

otCoapOptionIterator

Cette structure agit comme un itérateur pour les options CoAP.

otCoapResource

Cette structure représente une ressource CoAP.

otCoapTxParamètres

Cette structure représente les paramètres de transmission CoAP.

Énumérations

otCoapBlockSize

 otCoapBlockSize

Exposants de taille de bloc CoAP.

otCoapCode

 otCoapCode

Valeurs du code CoAP.

Propriétés
OT_COAP_CODE_BAD_GATEWAY

Mauvaise passerelle.

OT_COAP_CODE_BAD_OPTION

Mauvaise option.

OT_COAP_CODE_BAD_REQUEST

Mauvaise Demande.

OT_COAP_CODE_CHANGED

Modifié.

OT_COAP_CODE_CONTENT

Contenu.

OT_COAP_CODE_CONTINUE

RFC7959 Continuer.

OT_COAP_CODE_CREATED

Établi.

OT_COAP_CODE_DELETE

Supprimer.

OT_COAP_CODE_DELETED

Supprimé.

OT_COAP_CODE_EMPTY

Code de message vide.

OT_COAP_CODE_FORBIDDEN

Interdit.

OT_COAP_CODE_GATEWAY_TIMEOUT

Délai d'expiration de la passerelle.

OT_COAP_CODE_GET

Avoir.

OT_COAP_CODE_INTERNAL_ERROR

Erreur Interne du Serveur.

OT_COAP_CODE_METHOD_NOT_ALLOWED

Méthode Non Autorisée.

OT_COAP_CODE_NOT_ACCEPTABLE

Pas acceptable.

OT_COAP_CODE_NOT_FOUND

Pas trouvé.

OT_COAP_CODE_NOT_IMPLEMENTED

Pas mis en œuvre.

OT_COAP_CODE_POST

Publier.

OT_COAP_CODE_PRECONDITION_FAILED

La condition préalable a échoué.

OT_COAP_CODE_PROXY_NOT_SUPPORTED

Proxying non pris en charge.

OT_COAP_CODE_PUT

Mettre.

OT_COAP_CODE_REQUEST_INCOMPLETE

RFC7959 Entité de demande incomplète.

OT_COAP_CODE_REQUEST_TOO_LARGE

Demande d'entité trop grande.

OT_COAP_CODE_RESPONSE_MIN

2,00

OT_COAP_CODE_SERVICE_UNAVAILABLE

Service indisponible.

OT_COAP_CODE_UNAUTHORIZED

Non autorisé.

OT_COAP_CODE_UNSUPPORTED_FORMAT

Format de contenu non pris en charge.

OT_COAP_CODE_VALID

Valide.

otCoapOptionContentFormat

 otCoapOptionContentFormat

Codes de format de contenu CoAP.

La liste complète est documentée sur https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats

Propriétés
OT_COAP_OPTION_CONTENT_FORMAT_CBOR

application / cbor: [RFC7049]

OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON

application / coap-group + json: [RFC7390]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT

application / cose; cose-type = "cose-encrypt": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0

application / cose; cose-type = "cose-encrypt0": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY

application / cose-key: [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET

application / cose-key-set: [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC

application / cose; cose-type = "cose-mac": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0

application / cose; cose-type = "cose-mac0": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN

application / cose; cose-type = "cose-sign": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1

application / cose; cose-type = "cose-sign1": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_CWT

application / cwt: [RFC8392]

OT_COAP_OPTION_CONTENT_FORMAT_EXI

application / exi: ["Efficient XML Interchange (EXI) Format 1.0 (Second Edition)", février 2014]

OT_COAP_OPTION_CONTENT_FORMAT_JSON

application / json: [RFC7159]

OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON

application / json-patch + json: [RFC6902]

OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT

application / format de lien: [RFC6690]

OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON

application / merge-patch + json: [RFC7396]

OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM

application / flux d'octets: [RFC2045] [RFC2046]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_CBOR

application / senml + cbor: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI

application / senml-exi: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON

application / senml + json: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML

application / senml + xml: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_CBOR

application / sensml + cbor: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_EXI

application / sensml-exi: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_JSON

application / sensml + json: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_XML

application / sensml + xml: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_TEXT_PLAIN

texte simple; charset = utf-8: [RFC2046] [RFC3676] [RFC5147]

OT_COAP_OPTION_CONTENT_FORMAT_XML

application / xml: [RFC3023]

otCoapOptionType

 otCoapOptionType

Numéros d'option CoAP.

Propriétés
OT_COAP_OPTION_ACCEPT

J'accepte.

OT_COAP_OPTION_BLOCK1

Bloc1 (RFC7959)

OT_COAP_OPTION_BLOCK2

Bloc2 (RFC7959)

OT_COAP_OPTION_CONTENT_FORMAT

Format du contenu.

OT_COAP_OPTION_E_TAG

ETag.

OT_COAP_OPTION_IF_MATCH

If-Match.

OT_COAP_OPTION_IF_NONE_MATCH

If-None-Match.

OT_COAP_OPTION_LOCATION_PATH

Emplacement-Chemin.

OT_COAP_OPTION_LOCATION_QUERY

Localisation-Query.

OT_COAP_OPTION_MAX_AGE

Max-Age.

OT_COAP_OPTION_OBSERVE

Observez [RFC7641].

OT_COAP_OPTION_PROXY_SCHEME

Proxy-Scheme.

OT_COAP_OPTION_PROXY_URI

Proxy-Uri.

OT_COAP_OPTION_SIZE1

Taille 1.

OT_COAP_OPTION_URI_HOST

Uri-Host.

OT_COAP_OPTION_URI_PATH

Uri-Path.

OT_COAP_OPTION_URI_PORT

Uri-Port.

OT_COAP_OPTION_URI_QUERY

Uri-Query.

otCoapType

 otCoapType

Valeurs de type CoAP (entier non signé 2 bits).

Propriétés
OT_COAP_TYPE_ACKNOWLEDGMENT

Reconnaissance.

OT_COAP_TYPE_CONFIRMABLE

Confirmable.

OT_COAP_TYPE_NON_CONFIRMABLE

Non confirmable.

OT_COAP_TYPE_RESET

Réinitialiser.

Typedefs

otCoapBlockSize

enum otCoapBlockSize otCoapBlockSize

Exposants de taille de bloc CoAP.

otCoapCode

enum otCoapCode otCoapCode

Valeurs du code CoAP.

otCoapOption

struct otCoapOption otCoapOption

Cette structure représente une option CoAP.

otCoapOptionContentFormat

enum otCoapOptionContentFormat otCoapOptionContentFormat

Codes de format de contenu CoAP.

La liste complète est documentée à https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats

otCoapOptionIterator

struct otCoapOptionIterator otCoapOptionIterator

Cette structure agit comme un itérateur pour les options CoAP.

otCoapOptionType

enum otCoapOptionType otCoapOptionType

Numéros d'option CoAP.

otCoapRequestHandler

void(* otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)

Ce pointeur de fonction est appelé lorsqu'une demande CoAP avec un Uri-Path donné est reçue.

Détails
Paramètres
[in] aContext
Un pointeur vers des informations contextuelles arbitraires.
[in] aMessage
Un pointeur vers le message.
[in] aMessageInfo
Un pointeur vers les informations de message pour un aMessage .

otCoapResource

struct otCoapResource otCoapResource

Cette structure représente une ressource CoAP.

otCoapResponseHandler

void(* otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult)

Ce pointeur de fonction est appelé lorsqu'une réponse CoAP est reçue ou à l'expiration du délai de demande.

Détails
Paramètres
[in] aContext
Un pointeur vers un contexte spécifique à l'application.
[in] aMessage
Un pointeur vers le tampon de messages contenant la réponse. NULL si aucune réponse n'a été reçue.
[in] aMessageInfo
Un pointeur vers les informations de message pour un aMessage . NULL si aucune réponse n'a été reçue.
[in] aResult
Un résultat de la transaction CoAP.
Valeurs de retour
OT_ERROR_NONE
Une réponse a été reçue avec succès.
OT_ERROR_ABORT
Une transaction CoAP a été réinitialisée par l'homologue.
OT_ERROR_RESPONSE_TIMEOUT
Aucune réponse ou accusé de réception pendant la période de temporisation.

otCoapTxParamètres

struct otCoapTxParameters otCoapTxParameters

Cette structure représente les paramètres de transmission CoAP.

otCoapType

enum otCoapType otCoapType

Valeurs de type CoAP (entier non signé 2 bits).

Les fonctions

otCoapAddResource

void otCoapAddResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

Cette fonction ajoute une ressource au serveur CoAP.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aResource
Un pointeur vers la ressource.

otCoapBlockSizeFromExponent

uint16_t otCoapBlockSizeFromExponent(
  otCoapBlockSize aSize
)

Cette fonction convertit un champ SZX d'option de bloc CoAP en taille de bloc réelle.

Détails
Paramètres
[in] aSize
Exposant de taille de bloc.
Retour
La valeur de l'exposant de taille réelle.

otCoapMessageAppendBlock1Option

otError otCoapMessageAppendBlock1Option(
  otMessage *aMessage,
  uint32_t aNum,
  bool aMore,
  otCoapBlockSize aSize
)

Cette fonction ajoute une option Block1.

Détails
Paramètres
[in,out] aMessage
Un pointeur vers le message CoAP.
[in] aNum
Numéro de bloc actuel.
[in] aMore
Boolean pour indiquer que plus de blocs doivent être envoyés.
[in] aSize
Exposant de taille de bloc.
Valeurs de retour
OT_ERROR_NONE
Ajout de l'option avec succès.
OT_ERROR_INVALID_ARGS
Le type d'option n'est pas égal ou supérieur au dernier type d'option.
OT_ERROR_NO_BUFS
La longueur de l'option dépasse la taille de la mémoire tampon.

otCoapMessageAppendBlock2Option

otError otCoapMessageAppendBlock2Option(
  otMessage *aMessage,
  uint32_t aNum,
  bool aMore,
  otCoapBlockSize aSize
)

Cette fonction ajoute une option Block2.

Détails
Paramètres
[in,out] aMessage
Un pointeur vers le message CoAP.
[in] aNum
Numéro de bloc actuel.
[in] aMore
Boolean pour indiquer que plus de blocs doivent être envoyés.
[in] aSize
Exposant de taille de bloc.
Valeurs de retour
OT_ERROR_NONE
Ajout de l'option avec succès.
OT_ERROR_INVALID_ARGS
Le type d'option n'est pas égal ou supérieur au dernier type d'option.
OT_ERROR_NO_BUFS
La longueur de l'option dépasse la taille de la mémoire tampon.

otCoapMessageAppendContentFormatOption

otError otCoapMessageAppendContentFormatOption(
  otMessage *aMessage,
  otCoapOptionContentFormat aContentFormat
)

Cette fonction ajoute l'option Content Format CoAP comme spécifié dans https://tools.ietf.org/html/rfc7252#page-92 .

Cela doit être appelé avant de définir otCoapMessageSetPayloadMarker si une charge utile doit être incluse dans le message.

La fonction est un wrapper pratique autour de otCoapMessageAppendUintOption, et si le code de type de format souhaité n'est pas répertorié dans otCoapOptionContentFormat, cette fonction de base doit être utilisée à la place.

Détails
Paramètres
[in,out] aMessage
Un pointeur vers le message CoAP.
[in] aContentFormat
Un des formats de contenu répertoriés dans otCoapOptionContentFormat ci-dessus.
Valeurs de retour
OT_ERROR_NONE
Ajout de l'option avec succès.
OT_ERROR_INVALID_ARGS
Le type d'option n'est pas égal ou supérieur au dernier type d'option.
OT_ERROR_NO_BUFS
La longueur de l'option dépasse la taille de la mémoire tampon.

otCoapMessageAppendMaxAgeOption

otError otCoapMessageAppendMaxAgeOption(
  otMessage *aMessage,
  uint32_t aMaxAge
)

Cette fonction ajoute une option Max-Age.

Détails
Paramètres
[in,out] aMessage
Un pointeur vers le message CoAP.
[in] aMaxAge
La valeur Max-Age.
Valeurs de retour
OT_ERROR_NONE
Ajout de l'option avec succès.
OT_ERROR_INVALID_ARGS
Le type d'option n'est pas égal ou supérieur au dernier type d'option.
OT_ERROR_NO_BUFS
La longueur de l'option dépasse la taille de la mémoire tampon.

otCoapMessageAppendObserveOption

otError otCoapMessageAppendObserveOption(
  otMessage *aMessage,
  uint32_t aObserve
)

Cette fonction ajoute une option Observer.

Détails
Paramètres
[in,out] aMessage
Un pointeur vers le message CoAP.
[in] aObserve
Observez la valeur du champ.
Valeurs de retour
OT_ERROR_NONE
Ajout de l'option avec succès.
OT_ERROR_INVALID_ARGS
Le type d'option n'est pas égal ou supérieur au dernier type d'option.
OT_ERROR_NO_BUFS
La longueur de l'option dépasse la taille de la mémoire tampon.

otCoapMessageAppendOption

otError otCoapMessageAppendOption(
  otMessage *aMessage,
  uint16_t aNumber,
  uint16_t aLength,
  const void *aValue
)

Cette fonction ajoute une option CoAP dans un en-tête.

Détails
Paramètres
[in,out] aMessage
Un pointeur vers le message CoAP.
[in] aNumber
Le numéro de l'option CoAP.
[in] aLength
La longueur de l'option CoAP.
[in] aValue
Un pointeur vers la valeur CoAP.
Valeurs de retour
OT_ERROR_NONE
Ajout de l'option avec succès.
OT_ERROR_INVALID_ARGS
Le type d'option n'est pas égal ou supérieur au dernier type d'option.
OT_ERROR_NO_BUFS
La longueur de l'option dépasse la taille de la mémoire tampon.

otCoapMessageAppendProxyUriOption

otError otCoapMessageAppendProxyUriOption(
  otMessage *aMessage,
  const char *aUriPath
)

Cette fonction ajoute une option Proxy-Uri.

Détails
Paramètres
[in,out] aMessage
Un pointeur vers le message CoAP.
[in] aUriPath
Un pointeur vers une chaîne terminée par NULL.
Valeurs de retour
OT_ERROR_NONE
Ajout de l'option avec succès.
OT_ERROR_INVALID_ARGS
Le type d'option n'est pas égal ou supérieur au dernier type d'option.
OT_ERROR_NO_BUFS
La longueur de l'option dépasse la taille de la mémoire tampon.

otCoapMessageAppendUintOption

otError otCoapMessageAppendUintOption(
  otMessage *aMessage,
  uint16_t aNumber,
  uint32_t aValue
)

Cette fonction ajoute une option CoAP d'entier non signé comme spécifié dans https://tools.ietf.org/html/rfc7252#section-3.2 .

Détails
Paramètres
[in,out] aMessage
Un pointeur vers le message CoAP.
[in] aNumber
Le numéro de l'option CoAP.
[in] aValue
La valeur entière non signée de l'option CoAP.
Valeurs de retour
OT_ERROR_NONE
Ajout de l'option avec succès.
OT_ERROR_INVALID_ARGS
Le type d'option n'est pas égal ou supérieur au dernier type d'option.
OT_ERROR_NO_BUFS
La longueur de l'option dépasse la taille de la mémoire tampon.
Voir également:
otCoapMessageGetOptionUintValue

otCoapMessageAppendUriPathOptions

otError otCoapMessageAppendUriPathOptions(
  otMessage *aMessage,
  const char *aUriPath
)

Cette fonction ajoute une option Uri-Path.

Détails
Paramètres
[in,out] aMessage
Un pointeur vers le message CoAP.
[in] aUriPath
Un pointeur vers une chaîne terminée par NULL.
Valeurs de retour
OT_ERROR_NONE
Ajout de l'option avec succès.
OT_ERROR_INVALID_ARGS
Le type d'option n'est pas égal ou supérieur au dernier type d'option.
OT_ERROR_NO_BUFS
La longueur de l'option dépasse la taille de la mémoire tampon.

otCoapMessageAppendUriQueryOption

otError otCoapMessageAppendUriQueryOption(
  otMessage *aMessage,
  const char *aUriQuery
)

Cette fonction ajoute une seule option Uri-Query.

Détails
Paramètres
[in,out] aMessage
Un pointeur vers le message CoAP.
[in] aUriQuery
Un pointeur vers une chaîne terminée par NULL, qui doit contenir une seule paire clé = valeur.
Valeurs de retour
OT_ERROR_NONE
Ajout de l'option avec succès.
OT_ERROR_INVALID_ARGS
Le type d'option n'est pas égal ou supérieur au dernier type d'option.
OT_ERROR_NO_BUFS
La longueur de l'option dépasse la taille de la mémoire tampon.

otCoapMessageCodeToString

const char * otCoapMessageCodeToString(
  const otMessage *aMessage
)

Cette méthode renvoie le code CoAP sous forme de chaîne lisible par l'homme.

@ renvoie le code CoAP sous forme de chaîne.

Détails
Paramètres
[in] aMessage
Un pointeur vers le message CoAP.

otCoapMessageGenerateToken

void otCoapMessageGenerateToken(
  otMessage *aMessage,
  uint8_t aTokenLength
)

Cette fonction définit la longueur du jeton et aléatoirement sa valeur.

Détails
Paramètres
[in,out] aMessage
Un pointeur vers le message CoAP.
[in] aTokenLength
La longueur d'un jeton à définir.

otCoapMessageGetCode

otCoapCode otCoapMessageGetCode(
  const otMessage *aMessage
)

Cette fonction renvoie la valeur Code.

Détails
Paramètres
[in] aMessage
Un pointeur vers le message CoAP.
Retour
La valeur Code.

otCoapMessageGetMessageId

uint16_t otCoapMessageGetMessageId(
  const otMessage *aMessage
)

Cette fonction renvoie la valeur de l'ID de message.

Détails
Paramètres
[in] aMessage
Un pointeur vers le message CoAP.
Retour
La valeur de l'ID de message.

otCoapMessageGetToken

const uint8_t * otCoapMessageGetToken(
  const otMessage *aMessage
)

Cette fonction renvoie un pointeur sur la valeur du jeton.

Détails
Paramètres
[in] aMessage
Un pointeur vers le message CoAP.
Retour
Un pointeur vers la valeur du jeton.

otCoapMessageGetTokenLength

uint8_t otCoapMessageGetTokenLength(
  const otMessage *aMessage
)

Cette fonction renvoie la longueur du jeton.

Détails
Paramètres
[in] aMessage
Un pointeur vers le message CoAP.
Retour
La longueur du jeton.

otCoapMessageGetType

otCoapType otCoapMessageGetType(
  const otMessage *aMessage
)

Cette fonction renvoie la valeur Type.

Détails
Paramètres
[in] aMessage
Un pointeur vers le message CoAP.
Retour
La valeur Type.

otCoapMessageInit

void otCoapMessageInit(
  otMessage *aMessage,
  otCoapType aType,
  otCoapCode aCode
)

Cette fonction initialise l'en-tête CoAP.

Détails
Paramètres
[in,out] aMessage
Un pointeur vers le message CoAP à initialiser.
[in] aType
Type de message CoAP.
[in] aCode
Code de message CoAP.

otCoapMessageInitResponse

otError otCoapMessageInitResponse(
  otMessage *aResponse,
  const otMessage *aRequest,
  otCoapType aType,
  otCoapCode aCode
)

Cette fonction initialise un message de réponse.

Détails
Paramètres
[in,out] aResponse
Un pointeur vers le message de réponse CoAP.
[in] aRequest
Un pointeur vers le message de demande CoAP.
[in] aType
Type de message CoAP.
[in] aCode
Code de message CoAP.
Valeurs de retour
OT_ERROR_NONE
Initialisation réussie du message de réponse.
OT_ERROR_NO_BUFS
Tampons de messages insuffisants pour initialiser le message de réponse.

otCoapMessageSetPayloadMarker

otError otCoapMessageSetPayloadMarker(
  otMessage *aMessage
)

Cette fonction ajoute un marqueur de charge utile indiquant le début de la charge utile à l'en-tête CoAP.

Détails
Paramètres
[in,out] aMessage
Un pointeur vers le message CoAP.
Valeurs de retour
OT_ERROR_NONE
Le marqueur de charge utile a bien été ajouté.
OT_ERROR_NO_BUFS
Le marqueur de charge utile d'en-tête dépasse la taille de la mémoire tampon.

otCoapMessageSetToken

otError otCoapMessageSetToken(
  otMessage *aMessage,
  const uint8_t *aToken,
  uint8_t aTokenLength
)

Cette fonction définit la valeur et la longueur du jeton dans un en-tête.

Détails
Paramètres
[in,out] aMessage
Un pointeur vers le message CoAP.
[in] aToken
Un pointeur vers la valeur Token.
[in] aTokenLength
La longueur d'un aToken .
Valeurs de retour
OT_ERROR_NONE
Définissez avec succès la valeur du jeton.
OT_ERROR_NO_BUFS
Tampons insuffisants pour définir la valeur du jeton.

otCoapNewMessage

otMessage * otCoapNewMessage(
  otInstance *aInstance,
  const otMessageSettings *aSettings
)

Cette fonction crée un nouveau message CoAP.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aSettings
Un pointeur vers les paramètres du message ou NULL pour définir les paramètres par défaut.
Retour
Un pointeur vers le tampon de message ou NULL si aucun tampon de message n'est disponible ou si les paramètres ne sont pas valides.

otCoapOptionIteratorGetFirstOption

const otCoapOption * otCoapOptionIteratorGetFirstOption(
  otCoapOptionIterator *aIterator
)

Cette fonction renvoie un pointeur vers la première option.

Détails
Paramètres
[in,out] aIterator
Un pointeur vers l'itérateur de l'option de message CoAP.
Retour
Un pointeur vers la première option. Si aucune option n'est présente, le pointeur NULL est renvoyé.

otCoapOptionIteratorGetFirstOptionMatching

const otCoapOption * otCoapOptionIteratorGetFirstOptionMatching(
  otCoapOptionIterator *aIterator,
  uint16_t aOption
)

Cette fonction renvoie un pointeur vers la première option correspondant au numéro d'option spécifié.

Détails
Paramètres
[in] aIterator
Un pointeur vers l'itérateur de l'option de message CoAP.
[in] aOption
Le numéro d'option recherché.
Retour
Un pointeur vers la première option correspondante. Si aucune option correspondante n'est présente, le pointeur NULL est renvoyé.

otCoapOptionIteratorGetNextOption

const otCoapOption * otCoapOptionIteratorGetNextOption(
  otCoapOptionIterator *aIterator
)

Cette fonction renvoie un pointeur vers l'option suivante.

Détails
Paramètres
[in,out] aIterator
Un pointeur vers l'itérateur de l'option de message CoAP.
Retour
Un pointeur vers l'option suivante. Si aucune autre option n'est présente, le pointeur NULL est renvoyé.

otCoapOptionIteratorGetNextOptionMatching

const otCoapOption * otCoapOptionIteratorGetNextOptionMatching(
  otCoapOptionIterator *aIterator,
  uint16_t aOption
)

Cette fonction renvoie un pointeur vers l'option suivante correspondant au numéro d'option spécifié.

Détails
Paramètres
[in] aIterator
Un pointeur vers l'itérateur de l'option de message CoAP.
[in] aOption
Le numéro d'option recherché.
Retour
Un pointeur vers la prochaine option correspondante. Si aucune autre option correspondante n'est présente, le pointeur NULL est renvoyé.

otCoapOptionIteratorGetOptionUintValue

otError otCoapOptionIteratorGetOptionUintValue(
  otCoapOptionIterator *aIterator,
  uint64_t *const aValue
)

Cette fonction remplit la valeur de l'option actuelle dans aValue supposant que la valeur actuelle est un entier non signé encodé selon https://tools.ietf.org/html/rfc7252#section-3.2 .

Détails
Paramètres
[in,out] aIterator
Un pointeur vers l'itérateur de l'option de message CoAP.
[out] aValue
Un pointeur vers un entier non signé pour recevoir la valeur de l'option.
Valeurs de retour
OT_ERROR_NONE
Valeur remplie avec succès.
OT_ERROR_NOT_FOUND
Aucune option actuelle.
OT_ERROR_NO_BUFS
La valeur est trop longue pour tenir dans un uint64_t.
Voir également:
otCoapMessageAppendUintOption

otCoapOptionIteratorGetOptionValue

otError otCoapOptionIteratorGetOptionValue(
  otCoapOptionIterator *aIterator,
  void *aValue
)

Cette fonction remplit la valeur de l'option actuelle dans aValue .

Détails
Paramètres
[in,out] aIterator
Un pointeur vers l'itérateur de l'option de message CoAP.
[out] aValue
Un pointeur vers un tampon pour recevoir la valeur de l'option.
Valeurs de retour
OT_ERROR_NONE
Valeur remplie avec succès.
OT_ERROR_NOT_FOUND
Aucune option actuelle.

otCoapOptionIteratorInit

otError otCoapOptionIteratorInit(
  otCoapOptionIterator *aIterator,
  const otMessage *aMessage
)

Cette fonction initialise un itérateur pour les options du message donné.

Détails
Paramètres
[in,out] aIterator
Un pointeur vers l'itérateur de l'option de message CoAP.
[in] aMessage
Un pointeur vers le message CoAP.
Valeurs de retour
OT_ERROR_NONE
Initialisé avec succès.
OT_ERROR_PARSE
L'état du message est incohérent.

otCoapRemoveResource

void otCoapRemoveResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

Cette fonction supprime une ressource du serveur CoAP.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aResource
Un pointeur vers la ressource.

otCoapSendRequest

otError otCoapSendRequest(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext
)

Cette fonction envoie une requête CoAP.

Si une réponse à une demande est attendue, les informations relatives à la fonction et au contexte doivent être fournies. Si aucune réponse n'est attendue, ces arguments doivent être des pointeurs NULL.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aMessage
Un pointeur vers le message à envoyer.
[in] aMessageInfo
Un pointeur vers les informations de message associées à un aMessage .
[in] aHandler
Pointeur de fonction qui doit être appelé à la réception d'une réponse ou à l'expiration du délai.
[in] aContext
Un pointeur vers des informations contextuelles arbitraires. Peut être NULL s'il n'est pas utilisé.
Valeurs de retour
OT_ERROR_NONE
Message CoAP envoyé avec succès.
OT_ERROR_NO_BUFS
Échec de l'attribution des données de retransmission.

otCoapSendRequestWithParameters

otError otCoapSendRequestWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext,
  const otCoapTxParameters *aTxParameters
)

Cette fonction envoie une requête CoAP avec des paramètres de transmission personnalisés.

Si une réponse à une demande est attendue, les informations relatives à la fonction et au contexte doivent être fournies. Si aucune réponse n'est attendue, ces arguments doivent être des pointeurs NULL.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aMessage
Un pointeur vers le message à envoyer.
[in] aMessageInfo
Un pointeur vers les informations de message associées à un aMessage .
[in] aHandler
Pointeur de fonction qui doit être appelé à la réception de la réponse ou à l'expiration du délai.
[in] aContext
Un pointeur vers des informations contextuelles arbitraires. Peut être NULL s'il n'est pas utilisé.
[in] aTxParameters
Un pointeur vers les paramètres de transmission pour cette demande. Utilisez NULL pour les valeurs par défaut. Sinon, les paramètres donnés doivent remplir les conditions suivantes:
  1. mMaxRetransmit n'est pas supérieur à OT_COAP_MAX_RETRANSMIT.
  2. mAckRandomFactorNumerator / mAckRandomFactorDenominator ne doit pas être inférieur à 1,0.
  3. La durée de vie de l'échange calculée ne doit pas dépasser uint32_t.
Valeurs de retour
OT_ERROR_INVALID_ARGS
aTxParameters n'est pas valide.
OT_ERROR_NONE
Message CoAP envoyé avec succès.
OT_ERROR_NO_BUFS
Échec de l'attribution des données de retransmission.

otCoapSendResponse

otError otCoapSendResponse(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo
)

Cette fonction envoie une réponse CoAP du serveur.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aMessage
Un pointeur vers la réponse CoAP à envoyer.
[in] aMessageInfo
Un pointeur vers les informations de message associées à aMessage .
Valeurs de retour
OT_ERROR_NONE
Mise en file d'attente réussie du message de réponse CoAP.
OT_ERROR_NO_BUFS
Tampons disponibles insuffisants pour envoyer la réponse CoAP.

otCoapSendResponseWithParameters

otError otCoapSendResponseWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  const otCoapTxParameters *aTxParameters
)

Cette fonction envoie une réponse CoAP du serveur avec des paramètres de transmission personnalisés.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aMessage
Un pointeur vers la réponse CoAP à envoyer.
[in] aMessageInfo
Un pointeur vers les informations de message associées à aMessage .
[in] aTxParameters
Un pointeur vers les paramètres de transmission pour cette réponse. Utilisez NULL pour les valeurs par défaut.
Valeurs de retour
OT_ERROR_NONE
Mise en file d'attente réussie du message de réponse CoAP.
OT_ERROR_NO_BUFS
Tampons disponibles insuffisants pour envoyer la réponse CoAP.

otCoapSetDefaultHandler

void otCoapSetDefaultHandler(
  otInstance *aInstance,
  otCoapRequestHandler aHandler,
  void *aContext
)

Cette fonction définit le gestionnaire par défaut pour les demandes CoAP non gérées.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aHandler
Un pointeur de fonction qui doit être appelé lorsqu'une demande non gérée arrive.
[in] aContext
Un pointeur vers des informations contextuelles arbitraires. Peut être NULL s'il n'est pas utilisé.

otCoapStart

otError otCoapStart(
  otInstance *aInstance,
  uint16_t aPort
)

Cette fonction démarre le serveur CoAP.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
[in] aPort
Le port UDP local auquel se connecter.
Valeurs de retour
OT_ERROR_NONE
Démarrage réussi du serveur CoAP.

otCoapStop

otError otCoapStop(
  otInstance *aInstance
)

Cette fonction arrête le serveur CoAP.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance d'OpenThread.
Valeurs de retour
OT_ERROR_NONE
Arrêt réussi du serveur CoAP.

Macros

OT_COAP_CODE

 OT_COAP_CODE ((((c)&0x7) << 5) | ((d)&0x1f))

Macro d'aide pour définir les valeurs du code CoAP.

OT_COAP_DEFAULT_TOKEN_LENGTH

 OT_COAP_DEFAULT_TOKEN_LENGTH 2

Longueur de jeton par défaut.

OT_COAP_MAX_RETRANSMIT

 OT_COAP_MAX_RETRANSMIT 20

Retransmission maximale prise en charge par OpenThread.

OT_COAP_MAX_TOKEN_LENGTH

 OT_COAP_MAX_TOKEN_LENGTH 8

Longueur maximale du jeton comme spécifié (RFC 7252).

OT_COAP_MIN_ACK_TIMEOUT

 OT_COAP_MIN_ACK_TIMEOUT 1000

Délai d'expiration ACK minimal en millisecondes pris en charge par OpenThread.

OT_DEFAULT_COAP_PORT

 OT_DEFAULT_COAP_PORT 5683

Port CoAP par défaut, comme spécifié dans la RFC 7252.