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.

Sıralamalar

otCoapBlockSzx enum
CoAP Blok Boyutu Üsleri.
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))
}
enum
CoAP Kodu değerleri.
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
}
enum
CoAP İçerik Biçimi kodları.
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_SIZE2 = 28,
  OT_COAP_OPTION_PROXY_URI = 35,
  OT_COAP_OPTION_PROXY_SCHEME = 39,
  OT_COAP_OPTION_SIZE1 = 60
}
enum
CoAP Seçenek Numaraları.
otCoapType{
  OT_COAP_TYPE_CONFIRMABLE = 0,
  OT_COAP_TYPE_NON_CONFIRMABLE = 1,
  OT_COAP_TYPE_ACKNOWLEDGMENT = 2,
  OT_COAP_TYPE_RESET = 3
}
enum
CoAP Türü değerleri (2 bit imzalanmamış tam sayı).

Türdefler

otCoapBlockSzx typedef
CoAP Blok Boyutu Üsleri.
otCoapBlockwiseReceiveHook)(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength) typedef
Blok olarak aktarım seçeneğine sahip bir CoAP mesajı alındığında işaretçi çağrılır.
otCoapBlockwiseResource typedef
Blok tabanlı aktarımla bir CoAP kaynağını temsil eder.
otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore) typedef
İşaretçi, blok tabanlı aktarımda bir sonraki blok gönderilmeden önce çağrılır.
otCoapCode typedef
enum otCoapCode
CoAP Kodu değerleri.
otCoapOption typedef
struct otCoapOption
CoAP seçeneğini temsil eder.
otCoapOptionContentFormat typedef
CoAP İçerik Biçimi kodları.
otCoapOptionIterator typedef
CoAP seçenekleri için yineleme işlevi görür.
otCoapOptionType typedef
CoAP Seçenek Numaraları.
otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
void(*
Belirli bir Uri Yolu'na sahip CoAP isteği alındığında işaretçi çağrılır.
otCoapResource typedef
CoAP kaynağını temsil eder.
otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult) typedef
void(*
İşaretçi, bir CoAP yanıtı alındığında veya istek zaman aşımına uğradığında çağrılır.
otCoapTxParameters typedef
CoAP iletim parametrelerini temsil eder.
otCoapType typedef
enum 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.

Özellikler
OT_COAP_CODE_BAD_GATEWAY

Bozuk Ağ Geçidi.

OT_COAP_CODE_BAD_OPTION

Kötü Seçenek.

OT_COAP_CODE_BAD_REQUEST

Hatalı İstek.

OT_COAP_CODE_CHANGED

Değişti.

OT_COAP_CODE_CONTENT

İçerik.

OT_COAP_CODE_CONTINUE

RFC7959 Devam edin.

OT_COAP_CODE_CREATED

Oluşturuldu.

OT_COAP_CODE_DELETE

Sil'e dokunun.

OT_COAP_CODE_DELETED

Silindi.

OT_COAP_CODE_EMPTY

Boş mesaj kodu.

OT_COAP_CODE_FORBIDDEN

Yasak.

OT_COAP_CODE_GATEWAY_TIMEOUT

Ağ Geçidi Zaman Aşımı.

OT_COAP_CODE_GET

Al.

OT_COAP_CODE_INTERNAL_ERROR

Dahili Sunucu Hatası.

OT_COAP_CODE_METHOD_NOT_ALLOWED

Yönteme İzin Verilmiyor.

OT_COAP_CODE_NOT_ACCEPTABLE

Kabul Edilemez.

OT_COAP_CODE_NOT_FOUND

Bulunamadı.

OT_COAP_CODE_NOT_IMPLEMENTED

Uygulanmadı.

OT_COAP_CODE_POST

Yayınla'ya dokunun.

OT_COAP_CODE_PRECONDITION_FAILED

Ön Koşul Başarısız Oldu.

OT_COAP_CODE_PROXY_NOT_SUPPORTED

Proxy Kullanımı Desteklenmiyor.

OT_COAP_CODE_PUT

Koy.

OT_COAP_CODE_REQUEST_INCOMPLETE

RFC7959 İstek Varlığı Tamamlanmadı.

OT_COAP_CODE_REQUEST_TOO_LARGE

İstek Varlığı Çok Büyük.

OT_COAP_CODE_RESPONSE_MIN

2,00

OT_COAP_CODE_SERVICE_UNAVAILABLE

Hizmet Kullanılamıyor.

OT_COAP_CODE_UNAUTHORIZED

Yetkilendirilmedi.

OT_COAP_CODE_UNSUPPORTED_FORMAT

Desteklenmeyen İçerik Biçimi.

OT_COAP_CODE_VALID

Geçerli.

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

OTCoapBlockSzx

enum otCoapBlockSzx otCoapBlockSzx

CoAP Blok Boyutu Üsleri.

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
[in] aContext
Uygulamaya özel bağlama işarettir.
[in] aBlock
Blok segmentinin işaretçisi.
[in] aPosition
aBlock öğesinin bayt cinsinden bir dizideki konumu.
[in] aBlockLength
Blok segmentinin bayt cinsinden uzunluğu.
[in] aMore
Daha fazla engelleme segmenti takip ediliyorsa işaretleyin.
[in] aTotalLength
Aktarılan bilgilerin bayt cinsinden toplam uzunluğu (Boyut1 veya Boyut2 seçeneğiyle gösterilir).
Döndürülen Değerler
OT_ERROR_NONE
Blok segmenti başarıyla depolandı.
OT_ERROR_NO_BUFS
Blokları depolamak için artık bellek yok.
OT_ERROR_NO_FRAME_RECEIVED
Blok segmenti eksik.

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
[in] aContext
Uygulamaya özel bağlama işarettir.
[in,out] aBlock
Blok segmentinin yazılabileceği yeri gösteren işaretçi.
[in] aPosition
Bir dizide blok segmentinin alınacağı konum.
[in,out] aBlockLength
Girişte, bayt cinsinden maksimum blok segmenti uzunluğu.
[out] aMore
Daha fazla blok segmenti gelecekse bayrağın işaretçisi.
Döndürülen Değerler
OT_ERROR_NONE
Hata oluşmadı.
OT_ERROR_INVALID_ARGS
aPosition adresinde engelleme mevcut değil.

OTCoapKodu

enum otCoapCode otCoapCode

CoAP Kodu değerleri.

OTCoapOption

struct otCoapOption otCoapOption

CoAP seçeneğini temsil eder.

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.

OTCoapOptionType

enum otCoapOptionType otCoapOptionType

CoAP Seçenek Numaraları.

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
[in] aContext
Rastgele bağlam bilgilerine işaret eden bir kaynak.
[in] aMessage
İletinin işaretçisi.
[in] aMessageInfo
aMessage için mesaj bilgisinin işaretçisi.

otCoapResource

struct otCoapResource otCoapResource

CoAP kaynağını temsil eder.

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
[in] aContext
Uygulamaya özel bağlama işarettir.
[in] aMessage
Yanıtı içeren ileti arabelleğine giden bir işaretçi. Yanıt alınmadıysa NULL olur.
[in] aMessageInfo
aMessage için mesaj bilgisinin işaretçisi. Yanıt alınmadıysa NULL olur.
[in] aResult
CoAP işleminin sonucu.
Döndürülen Değerler
OT_ERROR_NONE
Başarıyla bir yanıt alındı.
OT_ERROR_ABORT
Bir CoAP işlemi eş tarafından sıfırlandı.
OT_ERROR_RESPONSE_TIMEOUT
Zaman aşımı süresi boyunca yanıt veya onay alınmadı.

otCoapTxParameters

struct otCoapTxParameters otCoapTxParameters

CoAP iletim parametrelerini temsil eder.

OTCoapTürü

enum otCoapType otCoapType

CoAP Türü değerleri (2 bit imzalanmamış tam sayı).

İşlevler

otCoapAddBlockWiseResource

void otCoapAddBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

CoAP sunucusuna blok düzeyinde bir kaynak ekler.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğine işaret eden bir işaretçi.
[in] aResource
Kaynağı gösteren bir işaretçi.

otCoapAddResource

void otCoapAddResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

CoAP sunucusuna bir kaynak ekler.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğine işaret eden bir işaretçi.
[in] aResource
Kaynağı gösteren bir işaretçi.

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
[in] aSize
Blok boyutu üssü.
İ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
[in,out] aMessage
CoAP mesajının işaretçisi.
[in] aNum
Mevcut blok numarası.
[in] aMore
Daha fazla engellemenin gönderileceğini belirten boole değeri.
[in] aSize
Blok Boyutu Üssü.
Döndürülen Değerler
OT_ERROR_NONE
Seçenek başarıyla eklendi.
OT_ERROR_INVALID_ARGS
Seçenek türü, son seçenek türüne eşit veya ondan büyük değil.
OT_ERROR_NO_BUFS
Seçenek uzunluğu arabellek boyutunu aşıyor.

otCoapMessageInsertBlock2Option

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

Bir Block2 seçeneği ekler.

Ayrıntılar
Parametreler
[in,out] aMessage
CoAP mesajının işaretçisi.
[in] aNum
Mevcut blok numarası.
[in] aMore
Daha fazla engellemenin gönderileceğini belirten boole değeri.
[in] aSize
Blok Boyutu Üssü.
Döndürülen Değerler
OT_ERROR_NONE
Seçenek başarıyla eklendi.
OT_ERROR_INVALID_ARGS
Seçenek türü, son seçenek türüne eşit veya ondan büyük değil.
OT_ERROR_NO_BUFS
Seçenek uzunluğu arabellek boyutunu aşıyor.

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
[in,out] aMessage
CoAP mesajının işaretçisi.
[in] aContentFormat
Yukarıdaki otCoapOptionContentFormat bölümünde listelenen içerik biçimlerinden biri.
Döndürülen Değerler
OT_ERROR_NONE
Seçenek başarıyla eklendi.
OT_ERROR_INVALID_ARGS
Seçenek türü, son seçenek türüne eşit veya ondan büyük değil.
OT_ERROR_NO_BUFS
Seçenek uzunluğu arabellek boyutunu aşıyor.

otCoapMessageInsertMaxAgeOption

otError otCoapMessageAppendMaxAgeOption(
  otMessage *aMessage,
  uint32_t aMaxAge
)

Maksimum Yaş seçeneği ekler.

Ayrıntılar
Parametreler
[in,out] aMessage
CoAP mesajının işaretçisi.
[in] aMaxAge
Maksimum yaş değeri.
Döndürülen Değerler
OT_ERROR_NONE
Seçenek başarıyla eklendi.
OT_ERROR_INVALID_ARGS
Seçenek türü, son seçenek türüne eşit veya ondan büyük değil.
OT_ERROR_NO_BUFS
Seçenek uzunluğu arabellek boyutunu aşıyor.

otCoapMessageInsertObserveOption

otError otCoapMessageAppendObserveOption(
  otMessage *aMessage,
  uint32_t aObserve
)

Gözlem seçeneği ekler.

Ayrıntılar
Parametreler
[in,out] aMessage
CoAP mesajının işaretçisi.
[in] aObserve
Alan değerini gözlemleyin.
Döndürülen Değerler
OT_ERROR_NONE
Seçenek başarıyla eklendi.
OT_ERROR_INVALID_ARGS
Seçenek türü, son seçenek türüne eşit veya ondan büyük değil.
OT_ERROR_NO_BUFS
Seçenek uzunluğu arabellek boyutunu aşıyor.

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
[in,out] aMessage
CoAP mesajının işaretçisi.
[in] aNumber
CoAP Opsiyon numarası.
[in] aLength
CoAP Opsiyon uzunluğu.
[in] aValue
CoAP değerine işaret eden bir işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
Seçenek başarıyla eklendi.
OT_ERROR_INVALID_ARGS
Seçenek türü, son seçenek türüne eşit veya ondan büyük değil.
OT_ERROR_NO_BUFS
Seçenek uzunluğu arabellek boyutunu aşıyor.

otCoapMessageInsertProxyUriOption

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

Bir Proxy-Uri seçeneği ekler.

Ayrıntılar
Parametreler
[in,out] aMessage
CoAP mesajının işaretçisi.
[in] aUriPath
NULL sonlandırılmış bir dizeye işaret eden.
Döndürülen Değerler
OT_ERROR_NONE
Seçenek başarıyla eklendi.
OT_ERROR_INVALID_ARGS
Seçenek türü, son seçenek türüne eşit veya ondan büyük değil.
OT_ERROR_NO_BUFS
Seçenek uzunluğu arabellek boyutunu aşıyor.

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
[in,out] aMessage
CoAP mesajının işaretçisi.
[in] aNumber
CoAP Opsiyon numarası.
[in] aValue
CoAP Seçeneği imzalanmamış tam sayı değeri.
Döndürülen Değerler
OT_ERROR_NONE
Seçenek başarıyla eklendi.
OT_ERROR_INVALID_ARGS
Seçenek türü, son seçenek türüne eşit veya ondan büyük değil.
OT_ERROR_NO_BUFS
Seçenek uzunluğu arabellek boyutunu aşıyor.
Şu makaleyi de inceleyebilirsiniz:
otCoapMessageGetOptionUintValue

otCoapMessageInsertUriPathOptions

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

Uri yolu seçeneği ekler.

Ayrıntılar
Parametreler
[in,out] aMessage
CoAP mesajının işaretçisi.
[in] aUriPath
NULL sonlandırılmış bir dizeye işaret eden.
Döndürülen Değerler
OT_ERROR_NONE
Seçenek başarıyla eklendi.
OT_ERROR_INVALID_ARGS
Seçenek türü, son seçenek türüne eşit veya ondan büyük değil.
OT_ERROR_NO_BUFS
Seçenek uzunluğu arabellek boyutunu aşıyor.

otCoapMessageInsertUriQueryOption

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

Tek bir Uri Sorgusu seçeneği ekler.

Ayrıntılar
Parametreler
[in,out] aMessage
CoAP mesajının işaretçisi.
[in] aUriQuery
Tek bir anahtar=değer çifti içermesi gereken NULL sonlandırılmış bir dizeye işaret eden.
Döndürülen Değerler
OT_ERROR_NONE
Seçenek başarıyla eklendi.
OT_ERROR_INVALID_ARGS
Seçenek türü, son seçenek türüne eşit veya ondan büyük değil.
OT_ERROR_NO_BUFS
Seçenek uzunluğu arabellek boyutunu aşıyor.

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
[in] aMessage
CoAP mesajının işaretçisi.

otCoapMessageGenerateToken

void otCoapMessageGenerateToken(
  otMessage *aMessage,
  uint8_t aTokenLength
)

Jeton uzunluğunu ayarlar ve değerini rastgele hale getirir.

Ayrıntılar
Parametreler
[in,out] aMessage
CoAP mesajının işaretçisi.
[in] aTokenLength
Ayarlanacak Jetonun Uzunluğu.

OTCoapMessageGetCode

otCoapCode otCoapMessageGetCode(
  const otMessage *aMessage
)

Kod değerini döndürür.

Ayrıntılar
Parametreler
[in] aMessage
CoAP mesajının işaretçisi.
İadeler
Kod değeri.

otCoapMessageGetMessageId

uint16_t otCoapMessageGetMessageId(
  const otMessage *aMessage
)

İleti Kimliği değerini döndürür.

Ayrıntılar
Parametreler
[in] aMessage
CoAP mesajının işaretçisi.
İ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
[in] aMessage
CoAP mesajının işaretçisi.
İ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
[in] aMessage
CoAP mesajının işaretçisi.
İadeler
Jeton uzunluğu.

ÖTUCoapMessageGetType

otCoapType otCoapMessageGetType(
  const otMessage *aMessage
)

Type (Tür) değerini döndürür.

Ayrıntılar
Parametreler
[in] aMessage
CoAP mesajının işaretçisi.
İ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
[in,out] aMessage
Başlatılacak CoAP mesajının işaretçisi.
[in] aType
CoAP mesaj türü.
[in] aCode
CoAP mesaj kodu.

OTCoapMessageInitResponse

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

Bir yanıt mesajını başlatır.

Ayrıntılar
Parametreler
[in,out] aResponse
CoAP yanıt mesajının işaretçisi.
[in] aRequest
CoAP istek mesajının işaretçisi.
[in] aType
CoAP mesaj türü.
[in] aCode
CoAP mesaj kodu.
Döndürülen Değerler
OT_ERROR_NONE
Yanıt iletisi başarıyla başlatıldı.
OT_ERROR_NO_BUFS
Yanıt mesajını başlatmak için yeterli mesaj arabelleği yok.

OTCoapMessageSetCode

void otCoapMessageSetCode(
  otMessage *aMessage,
  otCoapCode aCode
)

Kod değerini ayarlar.

Ayrıntılar
Parametreler
[in,out] aMessage
Başlatılacak CoAP mesajının işaretçisi.
[in] aCode
CoAP mesaj kodu.

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
[in,out] aMessage
CoAP mesajının işaretçisi.
Döndürülen Değerler
OT_ERROR_NONE
Yük İşaretçisi başarıyla eklendi.
OT_ERROR_NO_BUFS
Başlık Yük İşaretçisi, arabellek boyutunu aşıyor.

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
[in,out] aMessage
CoAP mesajının işaretçisi.
[in] aToken
Jeton değerinin işaretçisi.
[in] aTokenLength
aToken uzunluğu.
Döndürülen Değerler
OT_ERROR_NONE
Jeton değeri başarıyla ayarlandı.
OT_ERROR_NO_BUFS
Jeton değerini ayarlamak için yeterli arabellek yok.

OTCoapYeniMesaj

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

Yeni bir CoAP mesajı oluşturur.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğine işaret eden bir işaretçi.
[in] aSettings
Varsayılan ayarları belirlemek için mesaj ayarlarını veya NULL işaretçisi.
İ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
[in,out] aIterator
CoAP mesaj seçeneği yineleyicisine işaret eden bir işaretçi.
İ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
[in] aIterator
CoAP mesaj seçeneği yineleyicisine işaret eden bir işaretçi.
[in] aOption
Aranan seçenek numarası.
İ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
[in,out] aIterator
CoAP mesaj seçeneği yineleyicisine işaret eden bir işaretçi.
İ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
[in] aIterator
CoAP mesaj seçeneği yineleyicisine işaret eden bir işaretçi.
[in] aOption
Aranan seçenek numarası.
İ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
[in,out] aIterator
CoAP mesaj seçeneği yineleyicisine işaret eden bir işaretçi.
[out] aValue
Seçenek değerini almak için imzalanmamış bir tam sayıya işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
Değer başarıyla dolduruldu.
OT_ERROR_NOT_FOUND
Geçerli seçenek yok.
OT_ERROR_NO_BUFS
Değer, uint64_t içine sığmayacak kadar uzun.
Şu makaleyi de inceleyebilirsiniz:
otCoapMessageAttachUintOption

otCoapOptionIteratorGetOptionValue

otError otCoapOptionIteratorGetOptionValue(
  otCoapOptionIterator *aIterator,
  void *aValue
)

Mevcut seçenek değerini aValue içine doldurur.

Ayrıntılar
Parametreler
[in,out] aIterator
CoAP mesaj seçeneği yineleyicisine işaret eden bir işaretçi.
[out] aValue
Seçenek değerini almak için bir arabelleğin işaretçisi.
Döndürülen Değerler
OT_ERROR_NONE
Değer başarıyla dolduruldu.
OT_ERROR_NOT_FOUND
Geçerli seçenek yok.

OTCoapOptionIteratorInit

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

Belirtilen mesajdaki seçenekler için bir yineleme başlatır.

Ayrıntılar
Parametreler
[in,out] aIterator
CoAP mesaj seçeneği yineleyicisine işaret eden bir işaretçi.
[in] aMessage
CoAP mesajının işaretçisi.
Döndürülen Değerler
OT_ERROR_NONE
Başarıyla başlatıldı.
OT_ERROR_PARSE
İleti durumu tutarsız.

otCoapRemoveBlockWiseResource

void otCoapRemoveBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

Blok düzeyindeki bir kaynağı CoAP sunucusundan kaldırır.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğine işaret eden bir işaretçi.
[in] aResource
Kaynağı gösteren bir işaretçi.

otCoapRemoveResource

void otCoapRemoveResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

CoAP sunucusundan bir kaynağı kaldırır.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğine işaret eden bir işaretçi.
[in] aResource
Kaynağı gösteren bir işaretçi.

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
[in] aInstance
OpenThread örneğine işaret eden bir işaretçi.
[in] aMessage
Gönderilecek iletinin işaretçisi.
[in] aMessageInfo
aMessage ile ilişkili mesaj bilgisinin işaretçisi.
[in] aHandler
Yanıt alımında veya zaman aşımında çağrılacak bir işlev işaretçisi.
[in] aContext
Rastgele bağlam bilgilerine işaret eden bir kaynak. Kullanılmazsa NULL olabilir.
Döndürülen Değerler
OT_ERROR_NONE
CoAP mesajı başarıyla gönderildi.
OT_ERROR_NO_BUFS
Yeniden iletim verileri atanamadı.

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
[in] aInstance
OpenThread örneğine işaret eden bir işaretçi.
[in] aMessage
Gönderilecek iletinin işaretçisi.
[in] aMessageInfo
aMessage ile ilişkili mesaj bilgisinin işaretçisi.
[in] aHandler
Yanıt alımında veya zaman aşımında çağrılacak bir işlev işaretçisi.
[in] aContext
Rastgele bağlam bilgilerine işaret eden bir kaynak. Kullanılmazsa NULL olabilir.
[in] aTransmitHook
Blok bazında giden aktarım için kanca işlevine işaretçi.
[in] aReceiveHook
Gelen blok tabanlı aktarım için kanca işlevine işarettir.
Döndürülen Değerler
OT_ERROR_NONE
CoAP mesajı başarıyla gönderildi.
OT_ERROR_NO_BUFS
Yeniden iletim verileri atanamadı.

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
[in] aInstance
OpenThread örneğine işaret eden bir işaretçi.
[in] aMessage
Gönderilecek iletinin işaretçisi.
[in] aMessageInfo
aMessage ile ilişkili mesaj bilgisinin işaretçisi.
[in] aHandler
Yanıt alımında veya zaman aşımında çağrılacak bir işlev işaretçisi.
[in] aContext
Rastgele bağlam bilgilerine işaret eden bir kaynak. Kullanılmazsa NULL olabilir.
[in] aTxParameters
Bu istek için iletim parametrelerinin işaretçisi. Varsayılanlar için NULL kullanın.
[in] aTransmitHook
Blok bazında giden aktarım için kanca işlevine işaretçi.
[in] aReceiveHook
Gelen blok tabanlı aktarım için kanca işlevine işarettir.
Döndürülen Değerler
OT_ERROR_NONE
CoAP mesajı başarıyla gönderildi.
OT_ERROR_NO_BUFS
Yeniden iletim verileri atanamadı.
OT_ERROR_INVALID_ARGS
Geçersiz bağımsız değişkenler verilmiş.

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
[in] aInstance
OpenThread örneğine işaret eden bir işaretçi.
[in] aMessage
Gönderilecek iletinin işaretçisi.
[in] aMessageInfo
aMessage ile ilişkili mesaj bilgisinin işaretçisi.
[in] aHandler
Yanıt alımında veya zaman aşımında çağrılacak bir işlev işaretçisi.
[in] aContext
Rastgele bağlam bilgilerine işaret eden bir kaynak. Kullanılmazsa NULL olabilir.
[in] aTxParameters
Bu istek için iletim parametrelerinin işaretçisi. Varsayılanlar için NULL kullanın. Aksi takdirde, belirtilen parametreler aşağıdaki koşulları karşılamalıdır:
  1. mMaxRetransmit değeri, OT_COAP_MAX_RETRANSMIT değerinden fazla değildir.
  2. mAckRandomFactorNumerator / mAckRandomFactorDenominator 1,0'dan küçük olmamalıdır.
  3. Hesaplanan değişim ömrü değeri uint32_t'den taşmamalıdır.
Döndürülen Değerler
OT_ERROR_NONE
CoAP mesajı başarıyla gönderildi.
OT_ERROR_NO_BUFS
Yeniden iletim verileri atanamadı.
OT_ERROR_INVALID_ARGS
Geçersiz bağımsız değişkenler verilmiş.

otCoapSendResponse

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

Sunucudan bir CoAP yanıtı gönderir.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğine işaret eden bir işaretçi.
[in] aMessage
Gönderilecek CoAP yanıtını gösteren bir işaretçi.
[in] aMessageInfo
aMessage ile ilişkili mesaj bilgisinin işaretçisi.
Döndürülen Değerler
OT_ERROR_NONE
CoAP yanıt mesajı başarıyla sıraya alındı.
OT_ERROR_NO_BUFS
CoAP yanıtını göndermek için yeterli tampon yok.

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
[in] aInstance
OpenThread örneğine işaret eden bir işaretçi.
[in] aMessage
Gönderilecek CoAP yanıtını gösteren bir işaretçi.
[in] aMessageInfo
aMessage ile ilişkili mesaj bilgisinin işaretçisi.
[in] aContext
Rastgele bağlam bilgilerine işaret eden bir kaynak. Kullanılmazsa NULL olabilir.
[in] aTransmitHook
Blok bazında giden aktarım için kanca işlevine işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
CoAP yanıt mesajı başarıyla sıraya alındı.
OT_ERROR_NO_BUFS
CoAP yanıtını göndermek için yeterli tampon yok.

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
[in] aInstance
OpenThread örneğine işaret eden bir işaretçi.
[in] aMessage
Gönderilecek CoAP yanıtını gösteren bir işaretçi.
[in] aMessageInfo
aMessage ile ilişkili mesaj bilgisinin işaretçisi.
[in] aTxParameters
Bu yanıt için iletim parametrelerinin işaretçisi. Varsayılanlar için NULL kullanın.
[in] aContext
Rastgele bağlam bilgilerine işaret eden bir kaynak. Kullanılmazsa NULL olabilir.
[in] aTransmitHook
Blok bazında giden aktarım için kanca işlevine işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
CoAP yanıt mesajı başarıyla sıraya alındı.
OT_ERROR_NO_BUFS
CoAP yanıtını göndermek için yeterli tampon yok.
OT_ERROR_INVALID_ARGS
Geçersiz bağımsız değişkenler verilmiş.

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
[in] aInstance
OpenThread örneğine işaret eden bir işaretçi.
[in] aMessage
Gönderilecek CoAP yanıtını gösteren bir işaretçi.
[in] aMessageInfo
aMessage ile ilişkili mesaj bilgisinin işaretçisi.
[in] aTxParameters
Bu yanıt için iletim parametrelerinin işaretçisi. Varsayılanlar için NULL kullanın.
Döndürülen Değerler
OT_ERROR_NONE
CoAP yanıt mesajı başarıyla sıraya alındı.
OT_ERROR_NO_BUFS
CoAP yanıtını göndermek için yeterli tampon yok.
OT_ERROR_INVALID_ARGS
Geçersiz bağımsız değişkenler verilmiş.

otCoapSetDefaultHandler

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

İşlenmemiş CoAP istekleri için varsayılan işleyiciyi ayarlar.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğine işaret eden bir işaretçi.
[in] aHandler
İşlenmemiş bir istek geldiğinde çağrılacak bir işlev işaretçisi.
[in] aContext
Rastgele bağlam bilgilerine işaret eden bir kaynak. Kullanılmazsa NULL olabilir.

OTCoapStart

otError otCoapStart(
  otInstance *aInstance,
  uint16_t aPort
)

CoAP sunucusunu başlatır.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğine işaret eden bir işaretçi.
[in] aPort
Bağlanılacak yerel UDP bağlantı noktası.
Döndürülen Değerler
OT_ERROR_NONE
CoAP sunucusu başarıyla başlatıldı.
OT_ERROR_FAILED
CoAP sunucusu başlatılamadı.

OTCoapStop

otError otCoapStop(
  otInstance *aInstance
)

CoAP sunucusunu durdurur.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğine işaret eden bir işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
CoAP sunucusu başarıyla durduruldu.

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.