CoAP : CoAP : CoAP
이 모듈에는 CoAP 통신을 제어하는 기능이 포함되어 있습니다.
요약
이 모듈의 함수는 CoAP API 기능 (OPENTHREAD_CONFIG_COAP_API_ENABLE
)이 사용 설정된 경우 사용할 수 있습니다.
Typedef |
|
---|---|
otCoapBlockSzx
|
typedefenum otCoapBlockSzx
CoAP 블록 크기 지수 |
otCoapBlockwiseReceiveHook)(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength)
|
typedefotError(*
포인터는 블록별 전송 옵션이 포함된 CoAP 메시지가 수신될 때 호출됩니다. |
otCoapBlockwiseResource
|
typedefstruct otCoapBlockwiseResource
블록별 환승이 포함된 CoAP 리소스를 나타냅니다. |
otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore)
|
typedefotError(*
포인터는 블록별 환승의 다음 블록이 전송되기 전에 호출됩니다. |
otCoapCode
|
typedefenum otCoapCode
CoAP 코드 값입니다. |
otCoapOption
|
typedefstruct otCoapOption
CoAP 옵션을 나타냅니다. |
otCoapOptionContentFormat
|
typedef CoAP 콘텐츠 형식 코드 |
otCoapOptionIterator
|
typedefstruct otCoapOptionIterator
CoAP 옵션의 반복자 역할을 합니다. |
otCoapOptionType
|
typedefenum otCoapOptionType
CoAP 옵션 번호 |
otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)
|
typedefvoid(*
포인터는 지정된 Uri-Path의 CoAP 요청이 수신될 때 호출됩니다. |
otCoapResource
|
typedefstruct otCoapResource
CoAP 리소스를 나타냅니다. |
otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult)
|
typedefvoid(*
포인터는 CoAP 응답이 수신되거나 요청 시간 초과 시 호출됩니다. |
otCoapTxParameters
|
typedefstruct otCoapTxParameters
CoAP 전송 매개변수를 나타냅니다. |
otCoapType
|
typedefenum otCoapType
CoAP 유형 값 (부호 없는 2비트 정수) |
함수 |
|
---|---|
otCoapAddBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource)
|
void
블록별 리소스를 CoAP 서버에 추가합니다.
|
otCoapAddResource(otInstance *aInstance, otCoapResource *aResource)
|
void
CoAP 서버에 리소스를 추가합니다.
|
otCoapBlockSizeFromExponent(otCoapBlockSzx aSize)
|
uint16_t
CoAP 블록 옵션 SZX 필드를 실제 블록 크기로 변환합니다.
|
otCoapMessageAppendBlock1Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
|
Block1 옵션을 추가합니다.
|
otCoapMessageAppendBlock2Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
|
Block2 옵션을 추가합니다.
|
otCoapMessageAppendContentFormatOption(otMessage *aMessage, otCoapOptionContentFormat aContentFormat)
|
https://tools.ietf.org/html/rfc7252#page-92에 지정된 대로 콘텐츠 형식 CoAP 옵션을 추가합니다.
|
otCoapMessageAppendMaxAgeOption(otMessage *aMessage, uint32_t aMaxAge)
|
Max-Age 옵션을 추가합니다.
|
otCoapMessageAppendObserveOption(otMessage *aMessage, uint32_t aObserve)
|
관찰 옵션을 추가합니다.
|
otCoapMessageAppendOption(otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue)
|
헤더에 CoAP 옵션을 추가합니다.
|
otCoapMessageAppendProxyUriOption(otMessage *aMessage, const char *aUriPath)
|
Proxy-Uri 옵션을 추가합니다.
|
otCoapMessageAppendUintOption(otMessage *aMessage, uint16_t aNumber, uint32_t aValue)
|
https://tools.ietf.org/html/rfc7252#section-3.2에 지정된 대로 부호 없는 정수 CoAP 옵션을 추가합니다.
|
otCoapMessageAppendUriPathOptions(otMessage *aMessage, const char *aUriPath)
|
Uri-Path 옵션을 추가합니다.
|
otCoapMessageAppendUriQueryOption(otMessage *aMessage, const char *aUriQuery)
|
단일 Uri-Query 옵션을 추가합니다.
|
otCoapMessageCodeToString(const otMessage *aMessage)
|
const char *
CoAP 코드를 사람이 읽을 수 있는 문자열로 반환합니다.
|
otCoapMessageGenerateToken(otMessage *aMessage, uint8_t aTokenLength)
|
void
토큰 길이를 설정하고 값을 무작위로 지정합니다.
|
otCoapMessageGetCode(const otMessage *aMessage)
|
코드 값을 반환합니다.
|
otCoapMessageGetMessageId(const otMessage *aMessage)
|
uint16_t
메시지 ID 값을 반환합니다.
|
otCoapMessageGetToken(const otMessage *aMessage)
|
const uint8_t *
Token 값에 대한 포인터를 반환합니다.
|
otCoapMessageGetTokenLength(const otMessage *aMessage)
|
uint8_t
토큰 길이를 반환합니다.
|
otCoapMessageGetType(const otMessage *aMessage)
|
유형 값을 반환합니다.
|
otCoapMessageInit(otMessage *aMessage, otCoapType aType, otCoapCode aCode)
|
void
CoAP 헤더를 초기화합니다.
|
otCoapMessageInitResponse(otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode)
|
응답 메시지를 초기화합니다.
|
otCoapMessageSetCode(otMessage *aMessage, otCoapCode aCode)
|
void
코드 값을 설정합니다.
|
otCoapMessageSetPayloadMarker(otMessage *aMessage)
|
페이로드의 시작을 나타내는 페이로드 마커를 CoAP 헤더에 추가합니다.
|
otCoapMessageSetToken(otMessage *aMessage, const uint8_t *aToken, uint8_t aTokenLength)
|
헤더에서 토큰 값과 길이를 설정합니다.
|
otCoapNewMessage(otInstance *aInstance, const otMessageSettings *aSettings)
|
새 CoAP 메시지를 만듭니다.
|
otCoapOptionIteratorGetFirstOption(otCoapOptionIterator *aIterator)
|
const otCoapOption *
첫 번째 옵션을 가리키는 포인터를 반환합니다.
|
otCoapOptionIteratorGetFirstOptionMatching(otCoapOptionIterator *aIterator, uint16_t aOption)
|
const otCoapOption *
지정된 옵션 번호와 일치하는 첫 번째 옵션에 대한 포인터를 반환합니다.
|
otCoapOptionIteratorGetNextOption(otCoapOptionIterator *aIterator)
|
const otCoapOption *
다음 옵션에 대한 포인터를 반환합니다.
|
otCoapOptionIteratorGetNextOptionMatching(otCoapOptionIterator *aIterator, uint16_t aOption)
|
const otCoapOption *
지정된 옵션 번호와 일치하는 다음 옵션에 대한 포인터를 반환합니다.
|
otCoapOptionIteratorGetOptionUintValue(otCoapOptionIterator *aIterator, uint64_t *aValue)
|
현재 값이 https://tools.ietf.org/html/rfc7252#section-3.2에 따라 인코딩된 부호 없는 정수라고 가정하고 현재 옵션 값을
aValue 에 채웁니다. |
otCoapOptionIteratorGetOptionValue(otCoapOptionIterator *aIterator, void *aValue)
|
현재 옵션 값을
aValue 에 채웁니다. |
otCoapOptionIteratorInit(otCoapOptionIterator *aIterator, const otMessage *aMessage)
|
지정된 메시지에서 옵션의 이터레이터를 초기화합니다.
|
otCoapRemoveBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource)
|
void
CoAP 서버에서 블록별 리소스를 삭제합니다.
|
otCoapRemoveResource(otInstance *aInstance, otCoapResource *aResource)
|
void
CoAP 서버에서 리소스를 삭제합니다.
|
otCoapSendRequest(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext)
|
CoAP 요청을 전송합니다.
|
otCoapSendRequestBlockWise(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)
|
블록별로 CoAP 요청을 전송합니다.
|
otCoapSendRequestBlockWiseWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)
|
맞춤 전송 매개변수를 사용하여 블록별로 CoAP 요청을 전송합니다.
|
otCoapSendRequestWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters)
|
맞춤 전송 매개변수와 함께 CoAP 요청을 전송합니다.
|
otCoapSendResponse(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo)
|
서버에서 CoAP 응답을 전송합니다.
|
otCoapSendResponseBlockWise(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)
|
서버에서 블록별 CoAP 응답을 전송합니다.
|
otCoapSendResponseBlockWiseWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)
|
맞춤 전송 매개변수를 사용하여 서버에서 블록별로 CoAP 응답을 전송합니다.
|
otCoapSendResponseWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters)
|
맞춤 전송 매개변수를 사용하여 서버에서 CoAP 응답을 전송합니다.
|
otCoapSetDefaultHandler(otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext)
|
void
처리되지 않은 CoAP 요청의 기본 핸들러를 설정합니다.
|
otCoapStart(otInstance *aInstance, uint16_t aPort)
|
CoAP 서버를 시작합니다.
|
otCoapStop(otInstance *aInstance)
|
CoAP 서버를 중지합니다.
|
구조체 |
|
---|---|
otCoapBlockwiseResource |
블록별 환승이 포함된 CoAP 리소스를 나타냅니다. |
otCoapOption |
CoAP 옵션을 나타냅니다. |
otCoapOptionIterator |
CoAP 옵션의 반복자 역할을 합니다. |
otCoapResource |
CoAP 리소스를 나타냅니다. |
otCoapTxParameters |
CoAP 전송 매개변수를 나타냅니다. |
열거형
otCoapBlockSzx
otCoapBlockSzx
CoAP 블록 크기 지수
OTCoapCode
otCoapCode
CoAP 코드 값입니다.
otCoapOptionContentFormat
otCoapOptionContentFormat
CoAP 콘텐츠 형식 코드
전체 목록은 https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats에 설명되어 있습니다.
속성 | |
---|---|
OT_COAP_OPTION_CONTENT_FORMAT_CBOR
|
application/cbor: [RFC7049] |
OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON
|
application/coap-group+json: [RFC7390] |
OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT
|
application/cose; cose-type="cose-encrypt": [RFC8152] |
OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0
|
application/cose; cose-type="cose-encrypt0": [RFC8152] |
OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY
|
application/cose-key: [RFC8152] |
OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET
|
application/cose-key-set: [RFC8152] |
OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC
|
application/cose; cose-type="cose-mac": [RFC8152] |
OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0
|
application/cose; cose-type="cose-mac0": [RFC8152] |
OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN
|
application/cose; cose-type="cose-sign": [RFC8152] |
OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1
|
application/cose; cose-type="cose-sign1": [RFC8152] |
OT_COAP_OPTION_CONTENT_FORMAT_CWT
|
application/cwt: [RFC8392] |
OT_COAP_OPTION_CONTENT_FORMAT_EXI
|
application/exi: ["EXI (Efficient XML Interchange) 형식 1.0 (두 번째 버전)", 2014년 2월] |
OT_COAP_OPTION_CONTENT_FORMAT_JSON
|
application/json: [RFC7159] |
OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON
|
application/json-patch+json: [RFC6902] |
OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT
|
application/link-format: [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
|
application/senml+cbor: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI
|
application/senml-exi: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON
|
application/senml+json: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML
|
application/senml+xml: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_CBOR
|
application/sensml+cbor: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_EXI
|
application/sensml-exi: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_JSON
|
application/sensml+json: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_XML
|
application/sensml+xml: [RFC8428] |
OT_COAP_OPTION_CONTENT_FORMAT_TEXT_PLAIN
|
text/plain; charset=utf-8: [RFC2046][RFC3676][RFC5147] |
OT_COAP_OPTION_CONTENT_FORMAT_XML
|
application/xml: [RFC3023] |
otCoapOptionType
otCoapOptionType
CoAP 옵션 번호
속성 | |
---|---|
OT_COAP_OPTION_ACCEPT
|
동의합니다. |
OT_COAP_OPTION_BLOCK1
|
Block1 (RFC7959) |
OT_COAP_OPTION_BLOCK2
|
Block2 (RFC7959) |
OT_COAP_OPTION_CONTENT_FORMAT
|
콘텐츠 형식. |
OT_COAP_OPTION_E_TAG
|
ETag |
OT_COAP_OPTION_IF_MATCH
|
조건과 일치시킵니다. |
OT_COAP_OPTION_IF_NONE_MATCH
|
if-None-Match. |
OT_COAP_OPTION_LOCATION_PATH
|
위치-경로 |
OT_COAP_OPTION_LOCATION_QUERY
|
위치-쿼리. |
OT_COAP_OPTION_MAX_AGE
|
최대 연령. |
OT_COAP_OPTION_OBSERVE
|
[RFC7641]을 준수합니다. |
OT_COAP_OPTION_PROXY_SCHEME
|
프록시 스키마입니다. |
OT_COAP_OPTION_PROXY_URI
|
Proxy-Uri입니다. |
OT_COAP_OPTION_SIZE1
|
크기1. |
OT_COAP_OPTION_SIZE2
|
Size2 (RFC7959) |
OT_COAP_OPTION_URI_HOST
|
Uri-Host. |
OT_COAP_OPTION_URI_PATH
|
Uri-Path를 지정합니다. |
OT_COAP_OPTION_URI_PORT
|
Uri-Port입니다. |
OT_COAP_OPTION_URI_QUERY
|
Uri-Query. |
OTCoap 유형
otCoapType
CoAP 유형 값 (부호 없는 2비트 정수)
속성 | |
---|---|
OT_COAP_TYPE_ACKNOWLEDGMENT
|
인정 |
OT_COAP_TYPE_CONFIRMABLE
|
확인 가능합니다. |
OT_COAP_TYPE_NON_CONFIRMABLE
|
확인할 수 없습니다. |
OT_COAP_TYPE_RESET
|
초기화를 탭합니다. |
Typedef
otCoapBlockwiseReceiveHook
otError(* otCoapBlockwiseReceiveHook)(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength)
포인터는 블록별 전송 옵션이 포함된 CoAP 메시지가 수신될 때 호출됩니다.
OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE 구성이 사용 설정된 경우 사용할 수 있습니다.
세부정보 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
매개변수 |
|
||||||||||||
반환 값 |
|
otCoapBlockwiseResource
struct otCoapBlockwiseResource otCoapBlockwiseResource
블록별 환승이 포함된 CoAP 리소스를 나타냅니다.
otCoapBlockwiseTransmitHook
otError(* otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore)
포인터는 블록별 환승의 다음 블록이 전송되기 전에 호출됩니다.
OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE 구성이 사용 설정된 경우 사용할 수 있습니다.
aBlockLength 값을 변경하면 전체 거래소의 블록 크기가 다시 협상됩니다. 나중에 변경하면 다른 CoAP 구현에 문제가 발생할 수 있으므로 첫 번째 블록을 수신한 후에 이렇게 하는 것이 좋습니다.
세부정보 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
매개변수 |
|
||||||||||
반환 값 |
|
otCoapOptionContentFormat
enum otCoapOptionContentFormat otCoapOptionContentFormat
CoAP 콘텐츠 형식 코드
전체 목록은 https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats에 설명되어 있습니다.
otCoapRequestHandler
void(* otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)
포인터는 지정된 Uri-Path의 CoAP 요청이 수신될 때 호출됩니다.
세부정보 | |||||||
---|---|---|---|---|---|---|---|
매개변수 |
|
otCoapResponseHandler 클래스의 생성자
void(* otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult)
포인터는 CoAP 응답이 수신되거나 요청 시간 초과 시 호출됩니다.
세부정보 | |||||||||
---|---|---|---|---|---|---|---|---|---|
매개변수 |
|
||||||||
반환 값 |
|
함수
otCoapAddBlockWise리소스
void otCoapAddBlockWiseResource( otInstance *aInstance, otCoapBlockwiseResource *aResource )
블록별 리소스를 CoAP 서버에 추가합니다.
세부정보 | |||||
---|---|---|---|---|---|
매개변수 |
|
OTCoapAddResource
void otCoapAddResource( otInstance *aInstance, otCoapResource *aResource )
CoAP 서버에 리소스를 추가합니다.
세부정보 | |||||
---|---|---|---|---|---|
매개변수 |
|
otCoapBlockSizeFromExponent
uint16_t otCoapBlockSizeFromExponent( otCoapBlockSzx aSize )
CoAP 블록 옵션 SZX 필드를 실제 블록 크기로 변환합니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
||
반환 |
실제 크기 지수 값입니다.
|
otCoapMessageAttachBlock1Option
otError otCoapMessageAppendBlock1Option( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize )
Block1 옵션을 추가합니다.
세부정보 | |||||||||
---|---|---|---|---|---|---|---|---|---|
매개변수 |
|
||||||||
반환 값 |
|
otCoapMessageAttachBlock2Option
otError otCoapMessageAppendBlock2Option( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize )
Block2 옵션을 추가합니다.
세부정보 | |||||||||
---|---|---|---|---|---|---|---|---|---|
매개변수 |
|
||||||||
반환 값 |
|
otCoapMessageAttachContentFormatOption
otError otCoapMessageAppendContentFormatOption( otMessage *aMessage, otCoapOptionContentFormat aContentFormat )
https://tools.ietf.org/html/rfc7252#page-92에 지정된 대로 콘텐츠 형식 CoAP 옵션을 추가합니다.
메시지에 페이로드를 포함하려면 otCoapMessageSetPayloadMarker를 설정하기 전에 반드시 호출해야 합니다.
이 함수는 otCoapMessageAttachUintOption을 둘러싼 편의 래퍼이며, 원하는 형식 유형 코드가 otCoapOptionContentFormat에 없는 경우 이 기본 함수를 대신 사용해야 합니다.
세부정보 | |||||||
---|---|---|---|---|---|---|---|
매개변수 |
|
||||||
반환 값 |
|
otCoapMessageAttachMaxAgeOption
otError otCoapMessageAppendMaxAgeOption( otMessage *aMessage, uint32_t aMaxAge )
Max-Age 옵션을 추가합니다.
세부정보 | |||||||
---|---|---|---|---|---|---|---|
매개변수 |
|
||||||
반환 값 |
|
otCoapMessageAttachObserveOption
otError otCoapMessageAppendObserveOption( otMessage *aMessage, uint32_t aObserve )
관찰 옵션을 추가합니다.
세부정보 | |||||||
---|---|---|---|---|---|---|---|
매개변수 |
|
||||||
반환 값 |
|
otCoapMessageAttachOption
otError otCoapMessageAppendOption( otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue )
헤더에 CoAP 옵션을 추가합니다.
세부정보 | |||||||||
---|---|---|---|---|---|---|---|---|---|
매개변수 |
|
||||||||
반환 값 |
|
otCoapMessageAttachProxyUriOption
otError otCoapMessageAppendProxyUriOption( otMessage *aMessage, const char *aUriPath )
Proxy-Uri 옵션을 추가합니다.
세부정보 | |||||||
---|---|---|---|---|---|---|---|
매개변수 |
|
||||||
반환 값 |
|
otCoapMessageAttachUintOption
otError otCoapMessageAppendUintOption( otMessage *aMessage, uint16_t aNumber, uint32_t aValue )
https://tools.ietf.org/html/rfc7252#section-3.2에 지정된 대로 부호 없는 정수 CoAP 옵션을 추가합니다.
세부정보 | |||||||
---|---|---|---|---|---|---|---|
매개변수 |
|
||||||
반환 값 |
|
otCoapMessageGetOptionUintValue
otCoapMessageAttachUriPathOptions 클래스의 정적 변수
otError otCoapMessageAppendUriPathOptions( otMessage *aMessage, const char *aUriPath )
Uri-Path 옵션을 추가합니다.
세부정보 | |||||||
---|---|---|---|---|---|---|---|
매개변수 |
|
||||||
반환 값 |
|
otCoapMessageAttachUriQueryOption
otError otCoapMessageAppendUriQueryOption( otMessage *aMessage, const char *aUriQuery )
단일 Uri-Query 옵션을 추가합니다.
세부정보 | |||||||
---|---|---|---|---|---|---|---|
매개변수 |
|
||||||
반환 값 |
|
otCoapMessageCodeToString
const char * otCoapMessageCodeToString( const otMessage *aMessage )
CoAP 코드를 사람이 읽을 수 있는 문자열로 반환합니다.
@ 은 CoAP 코드를 문자열로 반환합니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
otCoapMessageGenerateToken
void otCoapMessageGenerateToken( otMessage *aMessage, uint8_t aTokenLength )
토큰 길이를 설정하고 값을 무작위로 지정합니다.
세부정보 | |||||
---|---|---|---|---|---|
매개변수 |
|
otCoapMessageGetCode
otCoapCode otCoapMessageGetCode( const otMessage *aMessage )
코드 값을 반환합니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
||
반환 |
코드 값입니다.
|
otCoapMessageGetMessageId
uint16_t otCoapMessageGetMessageId( const otMessage *aMessage )
메시지 ID 값을 반환합니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
||
반환 |
메시지 ID 값입니다.
|
otCoapMessageGetToken
const uint8_t * otCoapMessageGetToken( const otMessage *aMessage )
Token 값에 대한 포인터를 반환합니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
||
반환 |
Token 값에 대한 포인터입니다.
|
otCoapMessageGetTokenLength
uint8_t otCoapMessageGetTokenLength( const otMessage *aMessage )
토큰 길이를 반환합니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
||
반환 |
토큰 길이입니다.
|
otCoapMessageGetType
otCoapType otCoapMessageGetType( const otMessage *aMessage )
유형 값을 반환합니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
||
반환 |
유형 값입니다.
|
otCoapMessageInit
void otCoapMessageInit( otMessage *aMessage, otCoapType aType, otCoapCode aCode )
CoAP 헤더를 초기화합니다.
세부정보 | |||||||
---|---|---|---|---|---|---|---|
매개변수 |
|
otCoapMessageInitResponse
otError otCoapMessageInitResponse( otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode )
응답 메시지를 초기화합니다.
세부정보 | |||||||||
---|---|---|---|---|---|---|---|---|---|
매개변수 |
|
||||||||
반환 값 |
|
otCoapMessageSetCode
void otCoapMessageSetCode( otMessage *aMessage, otCoapCode aCode )
코드 값을 설정합니다.
세부정보 | |||||
---|---|---|---|---|---|
매개변수 |
|
otCoapMessageSetPayloadMarker
otError otCoapMessageSetPayloadMarker( otMessage *aMessage )
페이로드의 시작을 나타내는 페이로드 마커를 CoAP 헤더에 추가합니다.
세부정보 | |||||
---|---|---|---|---|---|
매개변수 |
|
||||
반환 값 |
|
otCoapMessageSetToken
otError otCoapMessageSetToken( otMessage *aMessage, const uint8_t *aToken, uint8_t aTokenLength )
헤더에서 토큰 값과 길이를 설정합니다.
세부정보 | |||||||
---|---|---|---|---|---|---|---|
매개변수 |
|
||||||
반환 값 |
|
OTCoapNewMessage
otMessage * otCoapNewMessage( otInstance *aInstance, const otMessageSettings *aSettings )
새 CoAP 메시지를 만듭니다.
세부정보 | |||||
---|---|---|---|---|---|
매개변수 |
|
||||
반환 |
메시지 버퍼에 대한 포인터 또는 사용 가능한 메시지 버퍼가 없거나 매개변수가 유효하지 않은 경우 NULL.
|
otCoapOptionIteratorGetFirstOption
const otCoapOption * otCoapOptionIteratorGetFirstOption( otCoapOptionIterator *aIterator )
첫 번째 옵션을 가리키는 포인터를 반환합니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
||
반환 |
첫 번째 옵션을 가리키는 포인터입니다. 옵션이 없으면 NULL 포인터가 반환됩니다.
|
otCoapOptionIteratorGetFirstOptionMatching
const otCoapOption * otCoapOptionIteratorGetFirstOptionMatching( otCoapOptionIterator *aIterator, uint16_t aOption )
지정된 옵션 번호와 일치하는 첫 번째 옵션에 대한 포인터를 반환합니다.
세부정보 | |||||
---|---|---|---|---|---|
매개변수 |
|
||||
반환 |
첫 번째 일치 옵션에 대한 포인터입니다. 일치하는 옵션이 없으면 NULL 포인터가 반환됩니다.
|
otCoapOptionIteratorGetNextOption
const otCoapOption * otCoapOptionIteratorGetNextOption( otCoapOptionIterator *aIterator )
다음 옵션에 대한 포인터를 반환합니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
||
반환 |
다음 옵션을 가리키는 포인터입니다. 더 이상 옵션이 없으면 NULL 포인터가 반환됩니다.
|
otCoapOptionIteratorGetNextOptionMatching
const otCoapOption * otCoapOptionIteratorGetNextOptionMatching( otCoapOptionIterator *aIterator, uint16_t aOption )
지정된 옵션 번호와 일치하는 다음 옵션에 대한 포인터를 반환합니다.
세부정보 | |||||
---|---|---|---|---|---|
매개변수 |
|
||||
반환 |
다음 일치 옵션에 대한 포인터입니다. 추가 일치 옵션이 없으면 NULL 포인터가 반환됩니다.
|
otCoapOptionIteratorGetOptionUintValue
otError otCoapOptionIteratorGetOptionUintValue( otCoapOptionIterator *aIterator, uint64_t *aValue )
현재 값이 https://tools.ietf.org/html/rfc7252#section-3.2에 따라 인코딩된 부호 없는 정수라고 가정하고 현재 옵션 값을 aValue
에 채웁니다.
세부정보 | |||||||
---|---|---|---|---|---|---|---|
매개변수 |
|
||||||
반환 값 |
|
otCoapMessageAttachUintOption
otCoapOptionIteratorGetOptionValue
otError otCoapOptionIteratorGetOptionValue( otCoapOptionIterator *aIterator, void *aValue )
현재 옵션 값을 aValue
에 채웁니다.
세부정보 | |||||
---|---|---|---|---|---|
매개변수 |
|
||||
반환 값 |
|
otCoapOptionIteratorInit
otError otCoapOptionIteratorInit( otCoapOptionIterator *aIterator, const otMessage *aMessage )
지정된 메시지에서 옵션의 이터레이터를 초기화합니다.
세부정보 | |||||
---|---|---|---|---|---|
매개변수 |
|
||||
반환 값 |
|
otCoapRemoveBlockWiseResource
void otCoapRemoveBlockWiseResource( otInstance *aInstance, otCoapBlockwiseResource *aResource )
CoAP 서버에서 블록별 리소스를 삭제합니다.
세부정보 | |||||
---|---|---|---|---|---|
매개변수 |
|
otCoap리소스 삭제
void otCoapRemoveResource( otInstance *aInstance, otCoapResource *aResource )
CoAP 서버에서 리소스를 삭제합니다.
세부정보 | |||||
---|---|---|---|---|---|
매개변수 |
|
otCoapSendRequest
otError otCoapSendRequest( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext )
CoAP 요청을 전송합니다.
요청에 대한 응답이 예상되면 해당 기능과 컨텍스트 정보를 제공해야 합니다. 응답이 예상되지 않는 경우 이러한 인수는 NULL 포인터여야 합니다.
세부정보 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
매개변수 |
|
||||||||||
반환 값 |
|
otCoapSendRequestBlockWise
otError otCoapSendRequestBlockWise( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook )
블록별로 CoAP 요청을 전송합니다.
OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE 구성이 사용 설정된 경우 사용할 수 있습니다.
요청에 대한 응답이 예상되면 해당 기능과 컨텍스트 정보를 제공해야 합니다. 응답이 블록 단위여야 하는 경우 각 후크 함수를 제공해야 합니다. 응답이 예상되지 않는 경우 이러한 인수는 NULL 포인터여야 합니다.
세부정보 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
매개변수 |
|
||||||||||||||
반환 값 |
|
otCoapSendRequestBlockWiseWithParameters
otError otCoapSendRequestBlockWiseWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook )
맞춤 전송 매개변수를 사용하여 블록별로 CoAP 요청을 전송합니다.
OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE 구성이 사용 설정된 경우 사용할 수 있습니다.
요청에 대한 응답이 예상되면 해당 기능과 컨텍스트 정보를 제공해야 합니다. 응답이 블록 단위여야 하는 경우 각 후크 함수를 제공해야 합니다. 응답이 예상되지 않는 경우 이러한 인수는 NULL 포인터여야 합니다.
세부정보 | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
매개변수 |
|
||||||||||||||||
반환 값 |
|
otCoapSendRequestWithParameters
otError otCoapSendRequestWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters )
맞춤 전송 매개변수와 함께 CoAP 요청을 전송합니다.
요청에 대한 응답이 예상되면 해당 기능과 컨텍스트 정보를 제공해야 합니다. 응답이 예상되지 않는 경우 이러한 인수는 NULL 포인터여야 합니다.
세부정보 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
매개변수 |
|
||||||||||||
반환 값 |
|
otCoapSendResponse
otError otCoapSendResponse( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo )
서버에서 CoAP 응답을 전송합니다.
세부정보 | |||||||
---|---|---|---|---|---|---|---|
매개변수 |
|
||||||
반환 값 |
|
otCoapSendResponseBlockWise
otError otCoapSendResponseBlockWise( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook )
서버에서 블록별 CoAP 응답을 전송합니다.
OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE 구성이 사용 설정된 경우 사용할 수 있습니다.
세부정보 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
매개변수 |
|
||||||||||
반환 값 |
|
otCoapSendResponseBlockWiseWithParameters
otError otCoapSendResponseBlockWiseWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook )
맞춤 전송 매개변수를 사용하여 서버에서 블록별로 CoAP 응답을 전송합니다.
OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE 구성이 사용 설정된 경우 사용할 수 있습니다.
세부정보 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
매개변수 |
|
||||||||||||
반환 값 |
|
otCoapSendResponseWithParameters
otError otCoapSendResponseWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters )
맞춤 전송 매개변수를 사용하여 서버에서 CoAP 응답을 전송합니다.
세부정보 | |||||||||
---|---|---|---|---|---|---|---|---|---|
매개변수 |
|
||||||||
반환 값 |
|
otCoapSetDefaultHandler 클래스의 생성자
void otCoapSetDefaultHandler( otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext )
처리되지 않은 CoAP 요청의 기본 핸들러를 설정합니다.
세부정보 | |||||||
---|---|---|---|---|---|---|---|
매개변수 |
|
OTCoapStart
otError otCoapStart( otInstance *aInstance, uint16_t aPort )
CoAP 서버를 시작합니다.
세부정보 | |||||
---|---|---|---|---|---|
매개변수 |
|
||||
반환 값 |
|
OTCoapStop
otError otCoapStop( otInstance *aInstance )
CoAP 서버를 중지합니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
||
반환 값 |
|
매크로
OT_COAP_CODE 코드
OT_COAP_CODE ((((c)&0x7) << 5) | ((d)&0x1f))
CoAP 코드 값을 정의하는 도우미 매크로입니다.
OT_COAP_DEFAULT_TOKEN_LENGTH
OT_COAP_DEFAULT_TOKEN_LENGTH 2
기본 토큰 길이입니다.
OT_COAP_MAX_RETRANSMIT
OT_COAP_MAX_RETRANSMIT 20
OpenThread에서 지원하는 최대 재전송
OT_COAP_MAX_TOKEN_LENGTH
OT_COAP_MAX_TOKEN_LENGTH 8
지정된 최대 토큰 길이입니다 (RFC 7252).
OT_COAP_MIN_ACK_TIMEOUT
OT_COAP_MIN_ACK_TIMEOUT 1000
OpenThread에서 지원하는 최소 ACK 제한 시간(밀리초)입니다.
OT_DEFAULT_COAP_PORT
OT_DEFAULT_COAP_PORT 5683
RFC 7252에 지정된 기본 CoAP 포트입니다.
자료
OpenThread API 참조 주제는 GitHub에서 제공되는 소스 코드에서 가져옵니다. 자세한 내용을 알아보거나 문서에 참여하려면 리소스를 참고하세요.