Siyasi nüfuz sahibi kişinin (CoAP)
Bu modül, CoAP iletişimini kontrol eden işlevler içerir.
Özet
Bu modüldeki işlevler, CoAP API özelliği (OPENTHREAD_CONFIG_COAP_API_ENABLE
) etkinleştirildiğinde kullanılabilir.
Türdefler |
|
---|---|
otCoapBlockSzx
|
typedefenum otCoapBlockSzx
CoAP Blok Boyutu Üsleri. |
otCoapBlockwiseReceiveHook)(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength)
|
typedefotError(*
Blok olarak aktarım seçeneğine sahip bir CoAP mesajı alındığında işaretçi çağrılır. |
otCoapBlockwiseResource
|
typedefstruct otCoapBlockwiseResource
Blok tabanlı aktarımla bir CoAP kaynağını temsil eder. |
otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore)
|
typedefotError(*
İşaretçi, blok tabanlı aktarımda bir sonraki blok gönderilmeden önce çağrılır. |
otCoapCode
|
typedefenum otCoapCode
CoAP Kodu değerleri. |
otCoapOption
|
typedefstruct otCoapOption
CoAP seçeneğini temsil eder. |
otCoapOptionContentFormat
|
typedef CoAP İçerik Biçimi kodları. |
otCoapOptionIterator
|
typedefstruct otCoapOptionIterator
CoAP seçenekleri için yineleme işlevi görür. |
otCoapOptionType
|
typedefenum otCoapOptionType
CoAP Seçenek Numaraları. |
otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)
|
typedefvoid(*
Belirli bir Uri Yolu'na sahip CoAP isteği alındığında işaretçi çağrılır. |
otCoapResource
|
typedefstruct otCoapResource
CoAP kaynağını temsil eder. |
otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult)
|
typedefvoid(*
İşaretçi, bir CoAP yanıtı alındığında veya istek zaman aşımına uğradığında çağrılır. |
otCoapTxParameters
|
typedefstruct otCoapTxParameters
CoAP iletim parametrelerini temsil eder. |
otCoapType
|
typedefenum otCoapType
CoAP Türü değerleri (2 bit imzalanmamış tam sayı). |
İşlevler |
|
---|---|
otCoapAddBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource)
|
void
CoAP sunucusuna blok düzeyinde bir kaynak ekler.
|
otCoapAddResource(otInstance *aInstance, otCoapResource *aResource)
|
void
CoAP sunucusuna bir kaynak ekler.
|
otCoapBlockSizeFromExponent(otCoapBlockSzx aSize)
|
uint16_t
CoAP Blok seçeneği SZX alanını gerçek blok boyutuna dönüştürür.
|
otCoapMessageAppendBlock1Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
|
Bir Engelleme1 seçeneği ekler.
|
otCoapMessageAppendBlock2Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
|
Bir Block2 seçeneği ekler.
|
otCoapMessageAppendContentFormatOption(otMessage *aMessage, otCoapOptionContentFormat aContentFormat)
|
İçerik Biçimi CoAP seçeneğini https://tools.ietf.org/html/rfc7252#page-92 adresinde belirtildiği gibi ekler.
|
otCoapMessageAppendMaxAgeOption(otMessage *aMessage, uint32_t aMaxAge)
|
Maksimum Yaş seçeneği ekler.
|
otCoapMessageAppendObserveOption(otMessage *aMessage, uint32_t aObserve)
|
Gözlem seçeneği ekler.
|
otCoapMessageAppendOption(otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue)
|
Başlığa CoAP seçeneği ekler.
|
otCoapMessageAppendProxyUriOption(otMessage *aMessage, const char *aUriPath)
|
Bir Proxy-Uri seçeneği ekler.
|
otCoapMessageAppendUintOption(otMessage *aMessage, uint16_t aNumber, uint32_t aValue)
|
https://tools.ietf.org/html/rfc7252#section-3.2 adresinde belirtildiği gibi imzalanmamış bir tam sayı CoAP seçeneği ekler.
|
otCoapMessageAppendUriPathOptions(otMessage *aMessage, const char *aUriPath)
|
Uri yolu seçeneği ekler.
|
otCoapMessageAppendUriQueryOption(otMessage *aMessage, const char *aUriQuery)
|
Tek bir Uri Sorgusu seçeneği ekler.
|
otCoapMessageCodeToString(const otMessage *aMessage)
|
const char *
CoAP Kodunu okunabilir dize olarak döndürür.
|
otCoapMessageGenerateToken(otMessage *aMessage, uint8_t aTokenLength)
|
void
Jeton uzunluğunu ayarlar ve değerini rastgele hale getirir.
|
otCoapMessageGetCode(const otMessage *aMessage)
|
Kod değerini döndürür.
|
otCoapMessageGetMessageId(const otMessage *aMessage)
|
uint16_t
İleti Kimliği değerini döndürür.
|
otCoapMessageGetToken(const otMessage *aMessage)
|
const uint8_t *
Jeton değerine işaretçi döndürür.
|
otCoapMessageGetTokenLength(const otMessage *aMessage)
|
uint8_t
Jeton uzunluğunu döndürür.
|
otCoapMessageGetType(const otMessage *aMessage)
|
Type (Tür) değerini döndürür.
|
otCoapMessageInit(otMessage *aMessage, otCoapType aType, otCoapCode aCode)
|
void
CoAP başlığını başlatır.
|
otCoapMessageInitResponse(otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode)
|
Bir yanıt mesajını başlatır.
|
otCoapMessageSetCode(otMessage *aMessage, otCoapCode aCode)
|
void
Kod değerini ayarlar.
|
otCoapMessageSetPayloadMarker(otMessage *aMessage)
|
CoAP başlığına yükün başlangıcını belirten Yük İşaretçisi ekler.
|
otCoapMessageSetToken(otMessage *aMessage, const uint8_t *aToken, uint8_t aTokenLength)
|
Bir başlıkta Jeton değerini ve uzunluğunu ayarlar.
|
otCoapNewMessage(otInstance *aInstance, const otMessageSettings *aSettings)
|
Yeni bir CoAP mesajı oluşturur.
|
otCoapOptionIteratorGetFirstOption(otCoapOptionIterator *aIterator)
|
const otCoapOption *
İlk seçeneğe işaret eden döndürür.
|
otCoapOptionIteratorGetFirstOptionMatching(otCoapOptionIterator *aIterator, uint16_t aOption)
|
const otCoapOption *
Belirtilen seçenek numarasıyla eşleşen ilk seçeneğe işaretçiyi döndürür.
|
otCoapOptionIteratorGetNextOption(otCoapOptionIterator *aIterator)
|
const otCoapOption *
İşaretçiyi sonraki seçeneğe döndürür.
|
otCoapOptionIteratorGetNextOptionMatching(otCoapOptionIterator *aIterator, uint16_t aOption)
|
const otCoapOption *
Belirtilen seçenek numarasıyla eşleşen sonraki seçeneğe işaretçiyi döndürür.
|
otCoapOptionIteratorGetOptionUintValue(otCoapOptionIterator *aIterator, uint64_t *aValue)
|
Geçerli değerin https://tools.ietf.org/html/ytc7252#section-3.2 adresine göre kodlanmış imzasız bir tam sayı olduğunu varsayarak mevcut seçenek değerini
aValue ile doldurur. |
otCoapOptionIteratorGetOptionValue(otCoapOptionIterator *aIterator, void *aValue)
|
Mevcut seçenek değerini
aValue içine doldurur. |
otCoapOptionIteratorInit(otCoapOptionIterator *aIterator, const otMessage *aMessage)
|
Belirtilen mesajdaki seçenekler için bir yineleme başlatır.
|
otCoapRemoveBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource)
|
void
Blok düzeyindeki bir kaynağı CoAP sunucusundan kaldırır.
|
otCoapRemoveResource(otInstance *aInstance, otCoapResource *aResource)
|
void
CoAP sunucusundan bir kaynağı kaldırır.
|
otCoapSendRequest(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext)
|
CoAP isteği gönderir.
|
otCoapSendRequestBlockWise(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)
|
Blok olarak CoAP isteği gönderir.
|
otCoapSendRequestBlockWiseWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)
|
Özel iletim parametreleriyle blok düzeyinde bir CoAP isteği gönderir.
|
otCoapSendRequestWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters)
|
Özel iletim parametreleri içeren bir CoAP isteği gönderir.
|
otCoapSendResponse(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo)
|
Sunucudan bir CoAP yanıtı gönderir.
|
otCoapSendResponseBlockWise(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)
|
Sunucudan blok halinde bir CoAP yanıtı gönderir.
|
otCoapSendResponseBlockWiseWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)
|
Özel iletim parametreleriyle sunucudan blok halinde bir CoAP yanıtı gönderir.
|
otCoapSendResponseWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters)
|
Sunucudan özel iletim parametreleriyle CoAP yanıtı gönderir.
|
otCoapSetDefaultHandler(otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext)
|
void
İşlenmemiş CoAP istekleri için varsayılan işleyiciyi ayarlar.
|
otCoapStart(otInstance *aInstance, uint16_t aPort)
|
CoAP sunucusunu başlatır.
|
otCoapStop(otInstance *aInstance)
|
CoAP sunucusunu durdurur.
|
Yapılar |
|
---|---|
otCoapBlockwiseResource |
Blok tabanlı aktarımla bir CoAP kaynağını temsil eder. |
otCoapOption |
CoAP seçeneğini temsil eder. |
otCoapOptionIterator |
CoAP seçenekleri için yineleme işlevi görür. |
otCoapResource |
CoAP kaynağını temsil eder. |
otCoapTxParameters |
CoAP iletim parametrelerini temsil eder. |
Sıralamalar
OTCoapBlockSzx
otCoapBlockSzx
CoAP Blok Boyutu Üsleri.
OTCoapKodu
otCoapCode
CoAP Kodu değerleri.
otCoapOptionContentFormat
otCoapOptionContentFormat
CoAP İçerik Biçimi kodları.
Listenin tamamını https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats adresinde bulabilirsiniz.
Özellikler | |
---|---|
OT_COAP_OPTION_CONTENT_FORMAT_CBOR
|
uygulama/cbor: [RFC7049] |
OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON
|
uygulama/coap-grubu+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
|
uygulama/cose-anahtar: [RFC8152] |
OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET
|
uygulama/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
|
uygulama/cwt: [RFC8392] |
OT_COAP_OPTION_CONTENT_FORMAT_EXI
|
application/exi: ["Efficient XML Interchange (EXI) Format 1.0 (İkinci Sürüm)", Şubat 2014] |
OT_COAP_OPTION_CONTENT_FORMAT_JSON
|
uygulama/json: [RFC7159] |
OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON
|
app/json-patch+json: [RFC6902] |
OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT
|
uygulama/bağlantı biçimi: [RFC6690] |
OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON
|
application/merge-patch+json: [RFC7396] |
OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM
|
uygulama/octet akışı: [RFC2045][RFC2046] |
OT_COAP_OPTION_CONTENT_FORMAT_SENML_CBOR
|
uygulama/senml+cbor: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI
|
application/senml-exi: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON
|
uygulama/senml+json: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML
|
uygulama/senml+xml: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_CBOR
|
uygulama/sensml+cbor: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_EXI
|
uygulama/sensml-exi: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_JSON
|
uygulama/sensml+json: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_XML
|
app/sensml+xml: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_TEXT_PLAIN
|
text/plain; charset=utf-8: [RFC2046][RFC3676][RFC5147] |
OT_COAP_OPTION_CONTENT_FORMAT_XML
|
uygulama/xml: [RFC3023] |
OTCoapOptionType
otCoapOptionType
CoAP Seçenek Numaraları.
Özellikler | |
---|---|
OT_COAP_OPTION_ACCEPT
|
Bunları kabul ettiğinizi onaylayın. |
OT_COAP_OPTION_BLOCK1
|
Blok1 (RFC7959) |
OT_COAP_OPTION_BLOCK2
|
Blok2 (RFC7959) |
OT_COAP_OPTION_CONTENT_FORMAT
|
İçerik biçimi. |
OT_COAP_OPTION_E_TAG
|
ETag. |
OT_COAP_OPTION_IF_MATCH
|
Eşleşirse. |
OT_COAP_OPTION_IF_NONE_MATCH
|
Eğer-Hiçbiri-Eşleşmez. |
OT_COAP_OPTION_LOCATION_PATH
|
Konum-Yolu. |
OT_COAP_OPTION_LOCATION_QUERY
|
Konum Sorgusu. |
OT_COAP_OPTION_MAX_AGE
|
Maksimum Yaş. |
OT_COAP_OPTION_OBSERVE
|
[RFC7641]'i inceleyin. |
OT_COAP_OPTION_PROXY_SCHEME
|
Proxy-Şema. |
OT_COAP_OPTION_PROXY_URI
|
Proxy-Uri. |
OT_COAP_OPTION_SIZE1
|
Boyut1. |
OT_COAP_OPTION_SIZE2
|
Boyut2 (RFC7959) |
OT_COAP_OPTION_URI_HOST
|
Uri-Host. |
OT_COAP_OPTION_URI_PATH
|
URI yolu. |
OT_COAP_OPTION_URI_PORT
|
Uri Bağlantı Noktası'na gidin. |
OT_COAP_OPTION_URI_QUERY
|
URI sorgusu |
OTCoapTürü
otCoapType
CoAP Türü değerleri (2 bit imzalanmamış tam sayı).
Özellikler | |
---|---|
OT_COAP_TYPE_ACKNOWLEDGMENT
|
Onaylama. |
OT_COAP_TYPE_CONFIRMABLE
|
Onaylanabilir. |
OT_COAP_TYPE_NON_CONFIRMABLE
|
Onaylanamaz. |
OT_COAP_TYPE_RESET
|
Sıfırla'ya dokunun. |
Türdefler
OTCoapBlockwiseAlıcı Kancası
otError(* otCoapBlockwiseReceiveHook)(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength)
Blok olarak aktarım seçeneğine sahip bir CoAP mesajı alındığında işaretçi çağrılır.
OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE yapılandırması etkinleştirildiğinde kullanılabilir.
Ayrıntılar | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||||||
Döndürülen Değerler |
|
otCoapBlockwiseResource
struct otCoapBlockwiseResource otCoapBlockwiseResource
Blok tabanlı aktarımla bir CoAP kaynağını temsil eder.
OTCoapBlockwiseTransmitHook
otError(* otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore)
İşaretçi, blok tabanlı aktarımda bir sonraki blok gönderilmeden önce çağrılır.
OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE yapılandırması etkinleştirildiğinde kullanılabilir.
aBlockLength değerinin değiştirilmesiyle tüm exchange'in blok boyutu yeniden belirlenir. Sonraki değişiklikler diğer CoAP uygulamalarında sorunlara neden olabileceğinden, ilk blok alındıktan sonra bunu yapmanız önerilir.
Ayrıntılar | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||||
Döndürülen Değerler |
|
otCoapOptionContentFormat
enum otCoapOptionContentFormat otCoapOptionContentFormat
CoAP İçerik Biçimi kodları.
Listenin tamamını https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats adresinde bulabilirsiniz.
otCoapOptionIterator
struct otCoapOptionIterator otCoapOptionIterator
CoAP seçenekleri için yineleme işlevi görür.
otCoapRequestHandler
void(* otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)
Belirli bir Uri Yolu'na sahip CoAP isteği alındığında işaretçi çağrılır.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
otCoapResponseHandler
void(* otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult)
İşaretçi, bir CoAP yanıtı alındığında veya istek zaman aşımına uğradığında çağrılır.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||
Döndürülen Değerler |
|
otCoapTxParameters
struct otCoapTxParameters otCoapTxParameters
CoAP iletim parametrelerini temsil eder.
İşlevler
otCoapAddBlockWiseResource
void otCoapAddBlockWiseResource( otInstance *aInstance, otCoapBlockwiseResource *aResource )
CoAP sunucusuna blok düzeyinde bir kaynak ekler.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
otCoapAddResource
void otCoapAddResource( otInstance *aInstance, otCoapResource *aResource )
CoAP sunucusuna bir kaynak ekler.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
otCoapBlockSizeFromExponent
uint16_t otCoapBlockSizeFromExponent( otCoapBlockSzx aSize )
CoAP Blok seçeneği SZX alanını gerçek blok boyutuna dönüştürür.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
Gerçek boyut üs değeri.
|
otCoapMessageInsertBlock1Option
otError otCoapMessageAppendBlock1Option( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize )
Bir Engelleme1 seçeneği ekler.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||
Döndürülen Değerler |
|
otCoapMessageInsertBlock2Option
otError otCoapMessageAppendBlock2Option( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize )
Bir Block2 seçeneği ekler.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||
Döndürülen Değerler |
|
otCoapMessageAttachContentFormatOption
otError otCoapMessageAppendContentFormatOption( otMessage *aMessage, otCoapOptionContentFormat aContentFormat )
İçerik Biçimi CoAP seçeneğini https://tools.ietf.org/html/rfc7252#page-92 adresinde belirtildiği gibi ekler.
Mesaja bir yük eklenecekse bu öğe, otCoapMessageSetPayloadMarker'ı ayarlamadan önce çağrılmalıdır.
İşlev, otCoapMessageattachUintOption etrafında bir kolaylık sarmalayıcıdır ve istenen biçim türü kodu otCoapOptionContentFormat içinde listelenmiyorsa bunun yerine bu temel işlev kullanılmalıdır.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Döndürülen Değerler |
|
otCoapMessageInsertMaxAgeOption
otError otCoapMessageAppendMaxAgeOption( otMessage *aMessage, uint32_t aMaxAge )
Maksimum Yaş seçeneği ekler.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Döndürülen Değerler |
|
otCoapMessageInsertObserveOption
otError otCoapMessageAppendObserveOption( otMessage *aMessage, uint32_t aObserve )
Gözlem seçeneği ekler.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Döndürülen Değerler |
|
otCoapMessageInsertOption
otError otCoapMessageAppendOption( otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue )
Başlığa CoAP seçeneği ekler.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||
Döndürülen Değerler |
|
otCoapMessageInsertProxyUriOption
otError otCoapMessageAppendProxyUriOption( otMessage *aMessage, const char *aUriPath )
Bir Proxy-Uri seçeneği ekler.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Döndürülen Değerler |
|
otCoapMessageInsertUintOption
otError otCoapMessageAppendUintOption( otMessage *aMessage, uint16_t aNumber, uint32_t aValue )
https://tools.ietf.org/html/rfc7252#section-3.2 adresinde belirtildiği gibi imzalanmamış bir tam sayı CoAP seçeneği ekler.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Döndürülen Değerler |
|
otCoapMessageGetOptionUintValue
otCoapMessageInsertUriPathOptions
otError otCoapMessageAppendUriPathOptions( otMessage *aMessage, const char *aUriPath )
Uri yolu seçeneği ekler.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Döndürülen Değerler |
|
otCoapMessageInsertUriQueryOption
otError otCoapMessageAppendUriQueryOption( otMessage *aMessage, const char *aUriQuery )
Tek bir Uri Sorgusu seçeneği ekler.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Döndürülen Değerler |
|
otCoapMessageCodeToString
const char * otCoapMessageCodeToString( const otMessage *aMessage )
CoAP Kodunu okunabilir dize olarak döndürür.
@, CoAP Kodunu dize olarak döndürür.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
otCoapMessageGenerateToken
void otCoapMessageGenerateToken( otMessage *aMessage, uint8_t aTokenLength )
Jeton uzunluğunu ayarlar ve değerini rastgele hale getirir.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
OTCoapMessageGetCode
otCoapCode otCoapMessageGetCode( const otMessage *aMessage )
Kod değerini döndürür.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
Kod değeri.
|
otCoapMessageGetMessageId
uint16_t otCoapMessageGetMessageId( const otMessage *aMessage )
İleti Kimliği değerini döndürür.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
İleti Kimliği değeri.
|
otCoapMessageGetToken
const uint8_t * otCoapMessageGetToken( const otMessage *aMessage )
Jeton değerine işaretçi döndürür.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
Jeton değerinin işaretçisi.
|
OTCoapMessageGetTokenLength
uint8_t otCoapMessageGetTokenLength( const otMessage *aMessage )
Jeton uzunluğunu döndürür.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
Jeton uzunluğu.
|
ÖTUCoapMessageGetType
otCoapType otCoapMessageGetType( const otMessage *aMessage )
Type (Tür) değerini döndürür.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
Type (Tür) değeri.
|
OTCoapMessageInit
void otCoapMessageInit( otMessage *aMessage, otCoapType aType, otCoapCode aCode )
CoAP başlığını başlatır.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
OTCoapMessageInitResponse
otError otCoapMessageInitResponse( otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode )
Bir yanıt mesajını başlatır.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||
Döndürülen Değerler |
|
OTCoapMessageSetCode
void otCoapMessageSetCode( otMessage *aMessage, otCoapCode aCode )
Kod değerini ayarlar.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
otCoapMessageSetPayloadMarker
otError otCoapMessageSetPayloadMarker( otMessage *aMessage )
CoAP başlığına yükün başlangıcını belirten Yük İşaretçisi ekler.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
Döndürülen Değerler |
|
otCoapMessageSetToken
otError otCoapMessageSetToken( otMessage *aMessage, const uint8_t *aToken, uint8_t aTokenLength )
Bir başlıkta Jeton değerini ve uzunluğunu ayarlar.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Döndürülen Değerler |
|
OTCoapYeniMesaj
otMessage * otCoapNewMessage( otInstance *aInstance, const otMessageSettings *aSettings )
Yeni bir CoAP mesajı oluşturur.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
İadeler |
Kullanılabilir mesaj arabelleği yoksa veya parametreler geçersizse mesaj arabelleğine ya da NULL değerine işaret eden.
|
otCoapOptionIteratorGetFirstOption
const otCoapOption * otCoapOptionIteratorGetFirstOption( otCoapOptionIterator *aIterator )
İlk seçeneğe işaret eden döndürür.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
İlk seçeneğe işaret eden bir işaretçi. Seçenek yoksa NULL işaretçi döndürülür.
|
otCoapOptionIteratorGetFirstOptionmatching
const otCoapOption * otCoapOptionIteratorGetFirstOptionMatching( otCoapOptionIterator *aIterator, uint16_t aOption )
Belirtilen seçenek numarasıyla eşleşen ilk seçeneğe işaretçiyi döndürür.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
İadeler |
İlk eşleme seçeneğine işaret eden. Eşleşen seçenek yoksa NULL işaretçi döndürülür.
|
otCoapOptionIteratorGetNextOption
const otCoapOption * otCoapOptionIteratorGetNextOption( otCoapOptionIterator *aIterator )
İşaretçiyi sonraki seçeneğe döndürür.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
Sonraki seçeneğe işaret eden işaretçi. Başka seçenek yoksa NULL işaretçi döndürülür.
|
otCoapOptionIteratorGetNextOptionEşleme
const otCoapOption * otCoapOptionIteratorGetNextOptionMatching( otCoapOptionIterator *aIterator, uint16_t aOption )
Belirtilen seçenek numarasıyla eşleşen sonraki seçeneğe işaretçiyi döndürür.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
İadeler |
Bir sonraki eşleme seçeneğine işaret eden. Eşleşen başka bir seçenek yoksa NULL işaretçi döndürülür.
|
otCoapOptionIteratorGetOptionUintValue
otError otCoapOptionIteratorGetOptionUintValue( otCoapOptionIterator *aIterator, uint64_t *aValue )
Geçerli değerin https://tools.ietf.org/html/ytc7252#section-3.2 adresine göre kodlanmış imzasız bir tam sayı olduğunu varsayarak mevcut seçenek değerini aValue
ile doldurur.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Döndürülen Değerler |
|
otCoapMessageAttachUintOption
otCoapOptionIteratorGetOptionValue
otError otCoapOptionIteratorGetOptionValue( otCoapOptionIterator *aIterator, void *aValue )
Mevcut seçenek değerini aValue
içine doldurur.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
Döndürülen Değerler |
|
OTCoapOptionIteratorInit
otError otCoapOptionIteratorInit( otCoapOptionIterator *aIterator, const otMessage *aMessage )
Belirtilen mesajdaki seçenekler için bir yineleme başlatır.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
Döndürülen Değerler |
|
otCoapRemoveBlockWiseResource
void otCoapRemoveBlockWiseResource( otInstance *aInstance, otCoapBlockwiseResource *aResource )
Blok düzeyindeki bir kaynağı CoAP sunucusundan kaldırır.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
otCoapRemoveResource
void otCoapRemoveResource( otInstance *aInstance, otCoapResource *aResource )
CoAP sunucusundan bir kaynağı kaldırır.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
otCoapSendRequest
otError otCoapSendRequest( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext )
CoAP isteği gönderir.
Bir istek için yanıt bekleniyorsa ilgili işlev ve bağlam bilgisi sağlanmalıdır. Yanıt beklenmiyorsa bu bağımsız değişkenler NULL işaretçi olmalıdır.
Ayrıntılar | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||||
Döndürülen Değerler |
|
otCoapSendRequestBlockWise
otError otCoapSendRequestBlockWise( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook )
Blok olarak CoAP isteği gönderir.
OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE yapılandırması etkinleştirildiğinde kullanılabilir.
Bir istek için yanıt bekleniyorsa ilgili işlev ve bağlam bilgisi sağlanmalıdır. Yanıtın blok halinde olması bekleniyorsa ilgili bir kanca işlevi sağlanmalıdır. Yanıt beklenmiyorsa bu bağımsız değişkenler NULL işaretçi olmalıdır.
Ayrıntılar | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||||||||
Döndürülen Değerler |
|
otCoapSendRequestBlockWiseWithParameters
otError otCoapSendRequestBlockWiseWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook )
Özel iletim parametreleriyle blok düzeyinde bir CoAP isteği gönderir.
OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE yapılandırması etkinleştirildiğinde kullanılabilir.
Bir istek için yanıt bekleniyorsa ilgili işlev ve bağlam bilgisi sağlanmalıdır. Yanıtın blok halinde olması bekleniyorsa ilgili bir kanca işlevi sağlanmalıdır. Yanıt beklenmiyorsa bu bağımsız değişkenler NULL işaretçi olmalıdır.
Ayrıntılar | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||||||||||
Döndürülen Değerler |
|
otCoapSendRequestWithParameters
otError otCoapSendRequestWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters )
Özel iletim parametreleri içeren bir CoAP isteği gönderir.
Bir istek için yanıt bekleniyorsa ilgili işlev ve bağlam bilgisi sağlanmalıdır. Yanıt beklenmiyorsa bu bağımsız değişkenler NULL işaretçi olmalıdır.
Ayrıntılar | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||||||
Döndürülen Değerler |
|
otCoapSendResponse
otError otCoapSendResponse( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo )
Sunucudan bir CoAP yanıtı gönderir.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Döndürülen Değerler |
|
otCoapSendResponseBlockWise
otError otCoapSendResponseBlockWise( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook )
Sunucudan blok halinde bir CoAP yanıtı gönderir.
OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE yapılandırması etkinleştirildiğinde kullanılabilir.
Ayrıntılar | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||||
Döndürülen Değerler |
|
otCoapSendResponseBlockWiseWithParameters
otError otCoapSendResponseBlockWiseWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook )
Özel iletim parametreleriyle sunucudan blok halinde bir CoAP yanıtı gönderir.
OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE yapılandırması etkinleştirildiğinde kullanılabilir.
Ayrıntılar | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||||||
Döndürülen Değerler |
|
otCoapSendResponseWithParameters
otError otCoapSendResponseWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters )
Sunucudan özel iletim parametreleriyle CoAP yanıtı gönderir.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||
Döndürülen Değerler |
|
otCoapSetDefaultHandler
void otCoapSetDefaultHandler( otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext )
İşlenmemiş CoAP istekleri için varsayılan işleyiciyi ayarlar.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
OTCoapStart
otError otCoapStart( otInstance *aInstance, uint16_t aPort )
CoAP sunucusunu başlatır.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
Döndürülen Değerler |
|
OTCoapStop
otError otCoapStop( otInstance *aInstance )
CoAP sunucusunu durdurur.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
Döndürülen Değerler |
|
Makrolar
UD_COAP_CODE
OT_COAP_CODE ((((c)&0x7) << 5) | ((d)&0x1f))
CoAP Kodu değerlerini tanımlamak için kullanılan yardımcı makrosu.
UD_COAP_DEFAULT_TOKEN_LENGTH
OT_COAP_DEFAULT_TOKEN_LENGTH 2
Varsayılan jeton uzunluğu.
UZ_COAP_MAX_RETRANSMIT
OT_COAP_MAX_RETRANSMIT 20
OpenThread tarafından desteklenen maksimum yeniden aktarım.
UD_COAP_MAX_TOKEN_LENGTH
OT_COAP_MAX_TOKEN_LENGTH 8
Belirtilen maksimum jeton uzunluğu (RFC 7252).
UD_COAP_MIN_ACK_TIMEOUT
OT_COAP_MIN_ACK_TIMEOUT 1000
OpenThread tarafından desteklenen milisaniye cinsinden minimum ACK zaman aşımı.
UD_DEFAULT_COAP_PORT
OT_DEFAULT_COAP_PORT 5683
RFC 7252'de belirtildiği şekliyle varsayılan CoAP bağlantı noktası.
Kaynaklar
OpenThread API Referans konuları, GitHub'da bulunan kaynak koddan gelir. Daha fazla bilgi edinmek veya dokümanlarımıza katkıda bulunmak için Kaynaklar bölümüne bakın.