CoAP
Ten moduł zawiera funkcje, które kontrolują komunikację CoAP.
Podsumowanie
Funkcje w tym module są dostępne po włączeniu interfejsu CoAP API (OPENTHREAD_CONFIG_COAP_API_ENABLE
).
Typedefs |
|
---|---|
otCoapBlockSzx
|
typedefenum otCoapBlockSzx
Wykładniki bloków CoAP. |
otCoapBlockwiseReceiveHook)(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength)
|
typedefotError(*
Wskaźnik jest wywoływany po odebraniu wiadomości CoAP z opcją przenoszenia blokowania. |
otCoapBlockwiseResource
|
typedefstruct otCoapBlockwiseResource
Reprezentuje zasób CoAP z transferem blokowym. |
otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore)
|
typedefotError(*
Wskaźnik jest wywoływany przed wysłaniem następnego bloku w transferze blokowym. |
otCoapCode
|
typedefenum otCoapCode
wartości kodów CoAP. |
otCoapOption
|
typedefstruct otCoapOption
Reprezentuje opcję CoAP. |
otCoapOptionContentFormat
|
typedef Kody formatu treści CoAP. |
otCoapOptionIterator
|
typedefstruct otCoapOptionIterator
Działa jako iterator opcji CoAP. |
otCoapOptionType
|
typedefenum otCoapOptionType
Numery opcji CoAP. |
otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)
|
typedefvoid(*
Wskaźnik jest wywoływany po odebraniu żądania CoAP z określoną ścieżką identyfikatora URI. |
otCoapResource
|
typedefstruct otCoapResource
Reprezentuje zasób CoAP. |
otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult)
|
typedefvoid(*
Wskaźnik jest wywoływany po odebraniu odpowiedzi CoAP lub po upływie czasu oczekiwania na żądanie. |
otCoapTxParameters
|
typedefstruct otCoapTxParameters
Reprezentuje parametry transmisji CoAP. |
otCoapType
|
typedefenum otCoapType
Wartości typu CoAP (2-bitowa liczba całkowita bez znaku). |
Funkcje |
|
---|---|
otCoapAddBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource)
|
void
Dodaje zasób blokowy do serwera CoAP.
|
otCoapAddResource(otInstance *aInstance, otCoapResource *aResource)
|
void
Dodaje zasób do serwera CoAP.
|
otCoapBlockSizeFromExponent(otCoapBlockSzx aSize)
|
uint16_t
Konwertuje pole SZX opcji bloku CoAP na rzeczywisty rozmiar bloku.
|
otCoapMessageAppendBlock1Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
|
Dodaje opcję Block1.
|
otCoapMessageAppendBlock2Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
|
Dodaje opcję Block2.
|
otCoapMessageAppendContentFormatOption(otMessage *aMessage, otCoapOptionContentFormat aContentFormat)
|
Dołącza opcję formatu treści CoAP zgodnie z opisem w https://tools.ietf.org/html/rfc7252#page-92.
|
otCoapMessageAppendMaxAgeOption(otMessage *aMessage, uint32_t aMaxAge)
|
Dodaje opcję Max-Age.
|
otCoapMessageAppendObserveOption(otMessage *aMessage, uint32_t aObserve)
|
Dodaje opcję Obserwuj.
|
otCoapMessageAppendOption(otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue)
|
Dodaje w nagłówku opcję CoAP.
|
otCoapMessageAppendProxyUriOption(otMessage *aMessage, const char *aUriPath)
|
Dodaje opcję identyfikatora serwera proxy.
|
otCoapMessageAppendUintOption(otMessage *aMessage, uint16_t aNumber, uint32_t aValue)
|
Dołącza opcję CoAP niepodpisanej liczby całkowitej zgodnie z opisem w https://tools.ietf.org/html/rfc7252#section-3.2.
|
otCoapMessageAppendUriPathOptions(otMessage *aMessage, const char *aUriPath)
|
Dodaje opcję ścieżki Uri.
|
otCoapMessageAppendUriQueryOption(otMessage *aMessage, const char *aUriQuery)
|
Dodaje pojedynczą opcję zapytania z identyfikatorem URI.
|
otCoapMessageCodeToString(const otMessage *aMessage)
|
const char *
Zwraca kod CoAP w postaci zrozumiałego dla człowieka ciągu znaków.
|
otCoapMessageGenerateToken(otMessage *aMessage, uint8_t aTokenLength)
|
void
Ustawia długość tokena i losowo wybiera jego wartość.
|
otCoapMessageGetCode(const otMessage *aMessage)
|
Zwraca wartość kodu.
|
otCoapMessageGetMessageId(const otMessage *aMessage)
|
uint16_t
Zwraca wartość identyfikatora wiadomości.
|
otCoapMessageGetToken(const otMessage *aMessage)
|
const uint8_t *
Zwraca wskaźnik do wartości tokena.
|
otCoapMessageGetTokenLength(const otMessage *aMessage)
|
uint8_t
Zwraca długość tokena.
|
otCoapMessageGetType(const otMessage *aMessage)
|
Zwraca wartość Typ.
|
otCoapMessageInit(otMessage *aMessage, otCoapType aType, otCoapCode aCode)
|
void
Inicjuje nagłówek CoAP.
|
otCoapMessageInitResponse(otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode)
|
Inicjuje wiadomość z odpowiedzią.
|
otCoapMessageSetCode(otMessage *aMessage, otCoapCode aCode)
|
void
Ustawia wartość Kod.
|
otCoapMessageSetPayloadMarker(otMessage *aMessage)
|
Dodaje do nagłówka CoAP znacznik ładunku wskazujący początek ładunku.
|
otCoapMessageSetToken(otMessage *aMessage, const uint8_t *aToken, uint8_t aTokenLength)
|
Ustawia wartość i długość tokena w nagłówku.
|
otCoapNewMessage(otInstance *aInstance, const otMessageSettings *aSettings)
|
Tworzy nową wiadomość CoAP.
|
otCoapOptionIteratorGetFirstOption(otCoapOptionIterator *aIterator)
|
const otCoapOption *
Zwraca wskaźnik do pierwszej opcji.
|
otCoapOptionIteratorGetFirstOptionMatching(otCoapOptionIterator *aIterator, uint16_t aOption)
|
const otCoapOption *
Zwraca wskaźnik do pierwszej opcji pasującej do podanego numeru.
|
otCoapOptionIteratorGetNextOption(otCoapOptionIterator *aIterator)
|
const otCoapOption *
Zwraca wskaźnik do następnej opcji.
|
otCoapOptionIteratorGetNextOptionMatching(otCoapOptionIterator *aIterator, uint16_t aOption)
|
const otCoapOption *
Zwraca wskaźnik do następnej opcji pasującej do podanego numeru.
|
otCoapOptionIteratorGetOptionUintValue(otCoapOptionIterator *aIterator, uint64_t *aValue)
|
Wypełnia bieżącą wartość opcji w polu
aValue przy założeniu, że bieżąca wartość jest niepodpisaną liczbą całkowitą zakodowaną zgodnie z wytycznymi https://tools.ietf.org/html/rfc7252#section-3.2. |
otCoapOptionIteratorGetOptionValue(otCoapOptionIterator *aIterator, void *aValue)
|
Podaje bieżącą wartość opcji w ciągu
aValue . |
otCoapOptionIteratorInit(otCoapOptionIterator *aIterator, const otMessage *aMessage)
|
Inicjuje iterator dla opcji w danej wiadomości.
|
otCoapRemoveBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource)
|
void
Usuwa zasób blokowy z serwera CoAP.
|
otCoapRemoveResource(otInstance *aInstance, otCoapResource *aResource)
|
void
Usuwa zasób z serwera CoAP.
|
otCoapSendRequest(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext)
|
Wysyła żądanie dotyczące CoAP.
|
otCoapSendRequestBlockWise(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)
|
Wysyła żądanie CoAP w trybie bloku.
|
otCoapSendRequestBlockWiseWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)
|
Wysyła żądanie CoAP blokowo z niestandardowymi parametrami transmisji.
|
otCoapSendRequestWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters)
|
Wysyła żądanie CoAP z niestandardowymi parametrami transmisji.
|
otCoapSendResponse(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo)
|
Wysyła odpowiedź CoAP z serwera.
|
otCoapSendResponseBlockWise(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)
|
Wysyła odpowiedź CoAP z serwera w trybie bloku.
|
otCoapSendResponseBlockWiseWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)
|
Wysyła z serwera odpowiedź CoAP z niestandardowymi parametrami transmisji.
|
otCoapSendResponseWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters)
|
Wysyła z serwera odpowiedź CoAP z niestandardowymi parametrami transmisji.
|
otCoapSetDefaultHandler(otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext)
|
void
Ustawia domyślny moduł obsługi nieobsłużonych żądań CoAP.
|
otCoapStart(otInstance *aInstance, uint16_t aPort)
|
Uruchamia serwer CoAP.
|
otCoapStop(otInstance *aInstance)
|
Zatrzymuje serwer CoAP.
|
Struktura |
|
---|---|
otCoapBlockwiseResource |
Reprezentuje zasób CoAP z transferem blokowym. |
otCoapOption |
Reprezentuje opcję CoAP. |
otCoapOptionIterator |
Działa jako iterator opcji CoAP. |
otCoapResource, |
Reprezentuje zasób CoAP. |
OTCoapTxParameters |
Reprezentuje parametry transmisji CoAP. |
Wyliczenia
OTCoapBlockSzx
otCoapBlockSzx
Wykładniki bloków CoAP.
Kod CoapCode
otCoapCode
wartości kodów CoAP.
otCoapOptionContentFormat
otCoapOptionContentFormat
Kody formatu treści CoAP.
Pełną listę znajdziesz na stronie https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats.
Właściwości | |
---|---|
OT_COAP_OPTION_CONTENT_FORMAT_CBOR
|
aplikacja/cbor: [RFC7049] |
OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON
|
aplikacja/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
|
aplikacja/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)”, luty 2014 r.] |
OT_COAP_OPTION_CONTENT_FORMAT_JSON
|
aplikacja/json: [RFC7159] |
OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON
|
application/json-patch+json: [RFC6902] |
OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT
|
aplikacja/format linku: [RFC6690] |
OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON
|
application/merge-patch+json: [RFC7396] |
OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM
|
application/octet-stream: [RFC2045][RFC2046] |
OT_COAP_OPTION_CONTENT_FORMAT_SENML_CBOR
|
aplikacja/senml+cbor: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI
|
application/senml-exi: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON
|
aplikacja/senml+json: [RFC8428], |
OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML
|
aplikacja/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
|
text/plain; charset=utf-8: [RFC2046][RFC3676][RFC5147] |
OT_COAP_OPTION_CONTENT_FORMAT_XML
|
aplikacja/xml: [RFC3023] |
Typ opcji otCoap
otCoapOptionType
Numery opcji CoAP.
Właściwości | |
---|---|
OT_COAP_OPTION_ACCEPT
|
Akceptuj. |
OT_COAP_OPTION_BLOCK1
|
Block1 (RFC7959) |
OT_COAP_OPTION_BLOCK2
|
Block2 (RFC7959) |
OT_COAP_OPTION_CONTENT_FORMAT
|
Content-Format. |
OT_COAP_OPTION_E_TAG
|
ETag. |
OT_COAP_OPTION_IF_MATCH
|
„If-Match”. |
OT_COAP_OPTION_IF_NONE_MATCH
|
Jeśli-brak-dopasowania. |
OT_COAP_OPTION_LOCATION_PATH
|
Lokalizacja-ścieżka. |
OT_COAP_OPTION_LOCATION_QUERY
|
Zapytanie o lokalizację. |
OT_COAP_OPTION_MAX_AGE
|
Max-Age. |
OT_COAP_OPTION_OBSERVE
|
Zapoznaj się z dokumentem [RFC7641]. |
OT_COAP_OPTION_PROXY_SCHEME
|
Schemat serwera proxy. |
OT_COAP_OPTION_PROXY_URI
|
Proxy-Uri. |
OT_COAP_OPTION_SIZE1
|
Rozmiar1. |
OT_COAP_OPTION_SIZE2
|
Rozmiar2 (RFC7959) |
OT_COAP_OPTION_URI_HOST
|
Uri-Host. |
OT_COAP_OPTION_URI_PATH
|
Ścieżka identyfikatora URI. |
OT_COAP_OPTION_URI_PORT
|
Port Uri. |
OT_COAP_OPTION_URI_QUERY
|
Zapytanie dotyczące identyfikatora URI. |
Typ CoapType
otCoapType
Wartości typu CoAP (2-bitowa liczba całkowita bez znaku).
Właściwości | |
---|---|
OT_COAP_TYPE_ACKNOWLEDGMENT
|
Potwierdzenie |
OT_COAP_TYPE_CONFIRMABLE
|
Potwierdzenie. |
OT_COAP_TYPE_NON_CONFIRMABLE
|
Nie można potwierdzić. |
OT_COAP_TYPE_RESET
|
Zresetuj. |
Typedefs
otCoapBlockwiseOdbierzHook
otError(* otCoapBlockwiseReceiveHook)(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength)
Wskaźnik jest wywoływany po odebraniu wiadomości CoAP z opcją przenoszenia blokowania.
Jest dostępna, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.
Szczegóły | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||||||
Zwracane wartości |
|
otCoapBlockwiseResource
struct otCoapBlockwiseResource otCoapBlockwiseResource
Reprezentuje zasób CoAP z transferem blokowym.
otCoapBlockwiseTransmitHook
otError(* otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore)
Wskaźnik jest wywoływany przed wysłaniem następnego bloku w transferze blokowym.
Jest dostępna, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.
Gdy zmienisz wartość aBlockLength, renegocjowany jest rozmiar bloku całej wymiany. Warto to zrobić po pierwszej blokadzie, ponieważ późniejsze zmiany mogą powodować problemy z innymi implementacjami CoAP.
Szczegóły | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||||
Zwracane wartości |
|
otCoapOptionContentFormat
enum otCoapOptionContentFormat otCoapOptionContentFormat
Kody formatu treści CoAP.
Pełną listę znajdziesz na stronie https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats.
otCoapOptionIterator
struct otCoapOptionIterator otCoapOptionIterator
Działa jako iterator opcji CoAP.
otCoapRequestHandler
void(* otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)
Wskaźnik jest wywoływany po odebraniu żądania CoAP z określoną ścieżką identyfikatora URI.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
otCoapResponseHandler
void(* otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult)
Wskaźnik jest wywoływany po odebraniu odpowiedzi CoAP lub po upływie czasu oczekiwania na żądanie.
Szczegóły | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||
Zwracane wartości |
|
Parametry otCoapTx
struct otCoapTxParameters otCoapTxParameters
Reprezentuje parametry transmisji CoAP.
Funkcje
otCoapAddBlockWiseResource
void otCoapAddBlockWiseResource( otInstance *aInstance, otCoapBlockwiseResource *aResource )
Dodaje zasób blokowy do serwera CoAP.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
otCoapAddResource
void otCoapAddResource( otInstance *aInstance, otCoapResource *aResource )
Dodaje zasób do serwera CoAP.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
OTCoapBlockSizeFromExponent
uint16_t otCoapBlockSizeFromExponent( otCoapBlockSzx aSize )
Konwertuje pole SZX opcji bloku CoAP na rzeczywisty rozmiar bloku.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Wartość wykładnika rzeczywistego rozmiaru.
|
otCoapMessageJoinBlock1Option
otError otCoapMessageAppendBlock1Option( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize )
Dodaje opcję Block1.
Szczegóły | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||
Zwracane wartości |
|
otCoapMessageJoinBlock2Option
otError otCoapMessageAppendBlock2Option( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize )
Dodaje opcję Block2.
Szczegóły | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||
Zwracane wartości |
|
otCoapMessageJoinContentFormatOption
otError otCoapMessageAppendContentFormatOption( otMessage *aMessage, otCoapOptionContentFormat aContentFormat )
Dołącza opcję formatu treści CoAP zgodnie z opisem w https://tools.ietf.org/html/rfc7252#page-92.
Jeśli wiadomość ma zawierać ładunek, należy wywołać tę metodę przed ustawieniem otCoapMessageSetPayloadMarker.
Ta funkcja jest wygodnym opakowaniem wokół elementu otCoapMessageAttachUintOption. Jeśli kod żądanego typu formatu nie jest wymieniony w otCoapOptionContentFormat, należy użyć tej funkcji podstawowej.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otCoapMessageJoinMaxAgeOption
otError otCoapMessageAppendMaxAgeOption( otMessage *aMessage, uint32_t aMaxAge )
Dodaje opcję Max-Age.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otCoapMessageJoinObserveOption
otError otCoapMessageAppendObserveOption( otMessage *aMessage, uint32_t aObserve )
Dodaje opcję Obserwuj.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otCoapMessageJoinOption
otError otCoapMessageAppendOption( otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue )
Dodaje w nagłówku opcję CoAP.
Szczegóły | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||
Zwracane wartości |
|
otCoapMessageRequireProxyUriOption
otError otCoapMessageAppendProxyUriOption( otMessage *aMessage, const char *aUriPath )
Dodaje opcję identyfikatora serwera proxy.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otCoapMessageJoinUintOption
otError otCoapMessageAppendUintOption( otMessage *aMessage, uint16_t aNumber, uint32_t aValue )
Dołącza opcję CoAP niepodpisanej liczby całkowitej zgodnie z opisem w https://tools.ietf.org/html/rfc7252#section-3.2.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otCoapMessageGetOptionUintValue
otCoapMessageJoinUriPathOptions
otError otCoapMessageAppendUriPathOptions( otMessage *aMessage, const char *aUriPath )
Dodaje opcję ścieżki Uri.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otCoapMessageJoinUriQueryOption
otError otCoapMessageAppendUriQueryOption( otMessage *aMessage, const char *aUriQuery )
Dodaje pojedynczą opcję zapytania z identyfikatorem URI.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otCoapMessageCodeToString
const char * otCoapMessageCodeToString( const otMessage *aMessage )
Zwraca kod CoAP w postaci zrozumiałego dla człowieka ciągu znaków.
@ zwraca kod CoAP w postaci ciągu znaków.
Szczegóły | |||
---|---|---|---|
Parametry |
|
otCoapMessageWygenerujToken
void otCoapMessageGenerateToken( otMessage *aMessage, uint8_t aTokenLength )
Ustawia długość tokena i losowo wybiera jego wartość.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
otCoapMessageGetCode
otCoapCode otCoapMessageGetCode( const otMessage *aMessage )
Zwraca wartość kodu.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Wartość Kod.
|
Identyfikator otCoapMessageGetMessage
uint16_t otCoapMessageGetMessageId( const otMessage *aMessage )
Zwraca wartość identyfikatora wiadomości.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Wartość identyfikatora wiadomości.
|
otCoapMessageGetToken
const uint8_t * otCoapMessageGetToken( const otMessage *aMessage )
Zwraca wskaźnik do wartości tokena.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Wskaźnik wartości tokena.
|
otCoapMessageGetTokenLength
uint8_t otCoapMessageGetTokenLength( const otMessage *aMessage )
Zwraca długość tokena.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Długość tokena.
|
OTCoapMessageGetType
otCoapType otCoapMessageGetType( const otMessage *aMessage )
Zwraca wartość Typ.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Wartość Typ.
|
otCoapMessageInit
void otCoapMessageInit( otMessage *aMessage, otCoapType aType, otCoapCode aCode )
Inicjuje nagłówek CoAP.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
otCoapMessageInitResponse
otError otCoapMessageInitResponse( otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode )
Inicjuje wiadomość z odpowiedzią.
Szczegóły | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||
Zwracane wartości |
|
otCoapMessageSetCode
void otCoapMessageSetCode( otMessage *aMessage, otCoapCode aCode )
Ustawia wartość Kod.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
otCoapMessageSetPayloadMarker
otError otCoapMessageSetPayloadMarker( otMessage *aMessage )
Dodaje do nagłówka CoAP znacznik ładunku wskazujący początek ładunku.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwracane wartości |
|
otCoapMessageSetToken
otError otCoapMessageSetToken( otMessage *aMessage, const uint8_t *aToken, uint8_t aTokenLength )
Ustawia wartość i długość tokena w nagłówku.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
Nowa wiadomość
otMessage * otCoapNewMessage( otInstance *aInstance, const otMessageSettings *aSettings )
Tworzy nową wiadomość CoAP.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwroty |
Wskaźnik do bufora wiadomości lub wartości NULL, jeśli nie są dostępne żadne bufory wiadomości lub parametry są nieprawidłowe.
|
otCoapOptionIteratorGetFirstOption
const otCoapOption * otCoapOptionIteratorGetFirstOption( otCoapOptionIterator *aIterator )
Zwraca wskaźnik do pierwszej opcji.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Wskaźnik pierwszej opcji. Jeśli nie ma żadnej opcji, zwracany jest wskaźnik NULL.
|
otCoapOptionIteratorGetFirstOptionMatching
const otCoapOption * otCoapOptionIteratorGetFirstOptionMatching( otCoapOptionIterator *aIterator, uint16_t aOption )
Zwraca wskaźnik do pierwszej opcji pasującej do podanego numeru.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwroty |
Wskaźnik pierwszej opcji dopasowania. Jeśli nie ma odpowiedniej opcji, zwracany jest wskaźnik NULL.
|
otCoapOptionIteratorGetNextOption
const otCoapOption * otCoapOptionIteratorGetNextOption( otCoapOptionIterator *aIterator )
Zwraca wskaźnik do następnej opcji.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Wskaźnik do następnej opcji. Jeśli nie ma więcej opcji, zwracany jest wskaźnik NULL.
|
otCoapOptionIteratorGetNextOptionMatching
const otCoapOption * otCoapOptionIteratorGetNextOptionMatching( otCoapOptionIterator *aIterator, uint16_t aOption )
Zwraca wskaźnik do następnej opcji pasującej do podanego numeru.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwroty |
Wskaźnik do następnej opcji dopasowania. Jeśli nie będzie odpowiedniej opcji dopasowania, zwracany jest wskaźnik NULL.
|
otCoapOptionIteratorGetOptionUintValue
otError otCoapOptionIteratorGetOptionUintValue( otCoapOptionIterator *aIterator, uint64_t *aValue )
Wypełnia bieżącą wartość opcji w polu aValue
przy założeniu, że bieżąca wartość jest niepodpisaną liczbą całkowitą zakodowaną zgodnie z wytycznymi https://tools.ietf.org/html/rfc7252#section-3.2.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otCoapMessageJoinUintOption
otCoapOptionIteratorGetOptionValue
otError otCoapOptionIteratorGetOptionValue( otCoapOptionIterator *aIterator, void *aValue )
Podaje bieżącą wartość opcji w ciągu aValue
.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwracane wartości |
|
otCoapOptionIteratorInit
otError otCoapOptionIteratorInit( otCoapOptionIterator *aIterator, const otMessage *aMessage )
Inicjuje iterator dla opcji w danej wiadomości.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwracane wartości |
|
otCoapRemoveBlockWiseResource
void otCoapRemoveBlockWiseResource( otInstance *aInstance, otCoapBlockwiseResource *aResource )
Usuwa zasób blokowy z serwera CoAP.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
otCoapRemoveResource
void otCoapRemoveResource( otInstance *aInstance, otCoapResource *aResource )
Usuwa zasób z serwera CoAP.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
Żądanie wysyłania żądań otCoap
otError otCoapSendRequest( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext )
Wysyła żądanie dotyczące CoAP.
Jeśli oczekiwana jest odpowiedź na żądanie, należy podać odpowiednie informacje o funkcji i kontekście. Jeśli nie oczekujesz odpowiedzi, te argumenty powinny zawierać wskaźniki NULL.
Szczegóły | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||||
Zwracane wartości |
|
otCoapSendRequestBlockWise
otError otCoapSendRequestBlockWise( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook )
Wysyła żądanie CoAP w trybie bloku.
Jest dostępna, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.
Jeśli oczekiwana jest odpowiedź na żądanie, należy podać odpowiednie informacje o funkcji i kontekście. Jeśli oczekiwano, że odpowiedź dotyczy bloku, należy podać odpowiednią funkcję hooka. Jeśli nie oczekujesz odpowiedzi, te argumenty powinny zawierać wskaźniki NULL.
Szczegóły | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||||||||
Zwracane wartości |
|
otCoapSendRequestBlockWiseWithParameters
otError otCoapSendRequestBlockWiseWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook )
Wysyła żądanie CoAP blokowo z niestandardowymi parametrami transmisji.
Jest dostępna, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.
Jeśli oczekiwana jest odpowiedź na żądanie, należy podać odpowiednie informacje o funkcji i kontekście. Jeśli oczekiwano, że odpowiedź dotyczy bloku, należy podać odpowiednią funkcję hooka. Jeśli nie oczekujesz odpowiedzi, te argumenty powinny zawierać wskaźniki NULL.
Szczegóły | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||||||||||
Zwracane wartości |
|
otCoapSendRequestWithParameters
otError otCoapSendRequestWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters )
Wysyła żądanie CoAP z niestandardowymi parametrami transmisji.
Jeśli oczekiwana jest odpowiedź na żądanie, należy podać odpowiednie informacje o funkcji i kontekście. Jeśli nie oczekujesz odpowiedzi, te argumenty powinny zawierać wskaźniki NULL.
Szczegóły | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||||||
Zwracane wartości |
|
otCoapSendResponse
otError otCoapSendResponse( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo )
Wysyła odpowiedź CoAP z serwera.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otCoapSendResponseBlockWise
otError otCoapSendResponseBlockWise( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook )
Wysyła odpowiedź CoAP z serwera w trybie bloku.
Jest dostępna, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.
Szczegóły | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||||
Zwracane wartości |
|
otCoapSendResponseBlockWiseWithParameters
otError otCoapSendResponseBlockWiseWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook )
Wysyła z serwera odpowiedź CoAP z niestandardowymi parametrami transmisji.
Jest dostępna, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.
Szczegóły | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||||||
Zwracane wartości |
|
otCoapSendResponseWithParameters
otError otCoapSendResponseWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters )
Wysyła z serwera odpowiedź CoAP z niestandardowymi parametrami transmisji.
Szczegóły | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||
Zwracane wartości |
|
otCoapSetDefaultHandler
void otCoapSetDefaultHandler( otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext )
Ustawia domyślny moduł obsługi nieobsłużonych żądań CoAP.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
otCoapStart,
otError otCoapStart( otInstance *aInstance, uint16_t aPort )
Uruchamia serwer CoAP.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwracane wartości |
|
OTCoapStop
otError otCoapStop( otInstance *aInstance )
Zatrzymuje serwer CoAP.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwracane wartości |
|
Makra
Kod_COAP_dogr.
OT_COAP_CODE ((((c)&0x7) << 5) | ((d)&0x1f))
Makro pomocnicze do definiowania wartości kodu CoAP.
DŁUGOŚĆ_COAP_DEFAULT_TOKEN_LENGTH
OT_COAP_DEFAULT_TOKEN_LENGTH 2
Domyślna długość tokena.
OT_COAP_MAX_RETRANSMIT
OT_COAP_MAX_RETRANSMIT 20
Maksymalna wartość ponownej przesyłania obsługiwana przez OpenThread.
OT_COAP_MAX_TOKEN_LENGTH
OT_COAP_MAX_TOKEN_LENGTH 8
Maksymalna długość tokena określona w RFC 7252.
OT_COAP_MIN_ACK_TIMEOUT
OT_COAP_MIN_ACK_TIMEOUT 1000
Minimalny czas oczekiwania na potwierdzenie (w milisekundach) obsługiwany przez OpenThread.
OT_DEFAULT_COAP_PORT
OT_DEFAULT_COAP_PORT 5683
Domyślny port CoAP określony w RFC 7252.
Zasoby
Tematy referencyjne interfejsu OpenThread API pochodzą z kodu źródłowego dostępnego w GitHub. Aby dowiedzieć się więcej lub dołączyć do naszej dokumentacji, zajrzyj do zasobów.