Google은 흑인 공동체를 위한 인종적 평등을 추구하기 위해 노력하고 있습니다. 자세히 알아보기
컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.

CoAP 입니다.

이 모듈에는 CoAP 통신을 제어하는 함수가 포함되어 있습니다.

요약

이 모듈의 함수는 CoAP API 기능(OPENTHREAD_CONFIG_COAP_API_ENABLE)이 사용 설정된 경우에 사용할 수 있습니다.

열거형

otCoapBlockSzx enum
CoAP 블록 크기 지수입니다.
otCoapCode{
  OT_COAP_CODE_EMPTY = (((( 0 )&0x7) << 5) | (( 0 )&0x1f)),
  OT_COAP_CODE_GET = (((( 0 )&0x7) << 5) | (( 1 )&0x1f)),
  OT_COAP_CODE_POST = (((( 0 )&0x7) << 5) | (( 2 )&0x1f)),
  OT_COAP_CODE_PUT = (((( 0 )&0x7) << 5) | (( 3 )&0x1f)),
  OT_COAP_CODE_DELETE = (((( 0 )&0x7) << 5) | (( 4 )&0x1f)),
  OT_COAP_CODE_RESPONSE_MIN = (((( 2 )&0x7) << 5) | (( 0 )&0x1f)),
  OT_COAP_CODE_CREATED = (((( 2 )&0x7) << 5) | (( 1 )&0x1f)),
  OT_COAP_CODE_DELETED = (((( 2 )&0x7) << 5) | (( 2 )&0x1f)),
  OT_COAP_CODE_VALID = (((( 2 )&0x7) << 5) | (( 3 )&0x1f)),
  OT_COAP_CODE_CHANGED = (((( 2 )&0x7) << 5) | (( 4 )&0x1f)),
  OT_COAP_CODE_CONTENT = (((( 2 )&0x7) << 5) | (( 5 )&0x1f)),
  OT_COAP_CODE_CONTINUE = (((( 2 )&0x7) << 5) | (( 31 )&0x1f)),
  OT_COAP_CODE_BAD_REQUEST = (((( 4 )&0x7) << 5) | (( 0 )&0x1f)),
  OT_COAP_CODE_UNAUTHORIZED = (((( 4 )&0x7) << 5) | (( 1 )&0x1f)),
  OT_COAP_CODE_BAD_OPTION = (((( 4 )&0x7) << 5) | (( 2 )&0x1f)),
  OT_COAP_CODE_FORBIDDEN = (((( 4 )&0x7) << 5) | (( 3 )&0x1f)),
  OT_COAP_CODE_NOT_FOUND = (((( 4 )&0x7) << 5) | (( 4 )&0x1f)),
  OT_COAP_CODE_METHOD_NOT_ALLOWED = (((( 4 )&0x7) << 5) | (( 5 )&0x1f)),
  OT_COAP_CODE_NOT_ACCEPTABLE = (((( 4 )&0x7) << 5) | (( 6 )&0x1f)),
  OT_COAP_CODE_REQUEST_INCOMPLETE = (((( 4 )&0x7) << 5) | (( 8 )&0x1f)),
  OT_COAP_CODE_PRECONDITION_FAILED = (((( 4 )&0x7) << 5) | (( 12 )&0x1f)),
  OT_COAP_CODE_REQUEST_TOO_LARGE = (((( 4 )&0x7) << 5) | (( 13 )&0x1f)),
  OT_COAP_CODE_UNSUPPORTED_FORMAT = (((( 4 )&0x7) << 5) | (( 15 )&0x1f)),
  OT_COAP_CODE_INTERNAL_ERROR = (((( 5 )&0x7) << 5) | (( 0 )&0x1f)),
  OT_COAP_CODE_NOT_IMPLEMENTED = (((( 5 )&0x7) << 5) | (( 1 )&0x1f)),
  OT_COAP_CODE_BAD_GATEWAY = (((( 5 )&0x7) << 5) | (( 2 )&0x1f)),
  OT_COAP_CODE_SERVICE_UNAVAILABLE = (((( 5 )&0x7) << 5) | (( 3 )&0x1f)),
  OT_COAP_CODE_GATEWAY_TIMEOUT = (((( 5 )&0x7) << 5) | (( 4 )&0x1f)),
  OT_COAP_CODE_PROXY_NOT_SUPPORTED = (((( 5 )&0x7) << 5) | (( 5 )&0x1f))
}
enum
CoAP 코드 값입니다.
otCoapOptionContentFormat{
  OT_COAP_OPTION_CONTENT_FORMAT_TEXT_PLAIN = 0,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0 = 16,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0 = 17,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1 = 18,
  OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT = 40,
  OT_COAP_OPTION_CONTENT_FORMAT_XML = 41,
  OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM = 42,
  OT_COAP_OPTION_CONTENT_FORMAT_EXI = 47,
  OT_COAP_OPTION_CONTENT_FORMAT_JSON = 50,
  OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON = 51,
  OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON = 52,
  OT_COAP_OPTION_CONTENT_FORMAT_CBOR = 60,
  OT_COAP_OPTION_CONTENT_FORMAT_CWT = 61,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT = 96,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC = 97,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN = 98,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY = 101,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET = 102,
  OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON = 110,
  OT_COAP_OPTION_CONTENT_FORMAT_SENSML_JSON = 111,
  OT_COAP_OPTION_CONTENT_FORMAT_SENML_CBOR = 112,
  OT_COAP_OPTION_CONTENT_FORMAT_SENSML_CBOR = 113,
  OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI = 114,
  OT_COAP_OPTION_CONTENT_FORMAT_SENSML_EXI = 115,
  OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON = 256,
  OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML = 310,
  OT_COAP_OPTION_CONTENT_FORMAT_SENSML_XML = 311
}
enum
CoAP 콘텐츠 형식 코드입니다.
otCoapOptionType{
  OT_COAP_OPTION_IF_MATCH = 1,
  OT_COAP_OPTION_URI_HOST = 3,
  OT_COAP_OPTION_E_TAG = 4,
  OT_COAP_OPTION_IF_NONE_MATCH = 5,
  OT_COAP_OPTION_OBSERVE = 6,
  OT_COAP_OPTION_URI_PORT = 7,
  OT_COAP_OPTION_LOCATION_PATH = 8,
  OT_COAP_OPTION_URI_PATH = 11,
  OT_COAP_OPTION_CONTENT_FORMAT = 12,
  OT_COAP_OPTION_MAX_AGE = 14,
  OT_COAP_OPTION_URI_QUERY = 15,
  OT_COAP_OPTION_ACCEPT = 17,
  OT_COAP_OPTION_LOCATION_QUERY = 20,
  OT_COAP_OPTION_BLOCK2 = 23,
  OT_COAP_OPTION_BLOCK1 = 27,
  OT_COAP_OPTION_SIZE2 = 28,
  OT_COAP_OPTION_PROXY_URI = 35,
  OT_COAP_OPTION_PROXY_SCHEME = 39,
  OT_COAP_OPTION_SIZE1 = 60
}
enum
CoAP 옵션 번호입니다.
otCoapType{
  OT_COAP_TYPE_CONFIRMABLE = 0,
  OT_COAP_TYPE_NON_CONFIRMABLE = 1,
  OT_COAP_TYPE_ACKNOWLEDGMENT = 2,
  OT_COAP_TYPE_RESET = 3
}
enum
CoAP 유형 값 (2비트 부호 없는 정수)

Typedef

otCoapBlockSzx typedef
CoAP 블록 크기 지수입니다.
otCoapBlockwiseReceiveHook)(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength) typedef
이 함수 포인터는 차단별 전송 옵션이 있는 CoAP 메시지가 수신될 때 호출됩니다.
otCoapBlockwiseResource typedef
이 구조는 블록별 전송을 사용하는 CoAP 리소스를 나타냅니다.
otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore) typedef
이 함수 포인터는 블록별 전송의 다음 블록이 전송되기 전에 호출됩니다.
otCoapCode typedef
enum otCoapCode
CoAP 코드 값입니다.
otCoapOption typedef
struct otCoapOption
이 구조는 CoAP 옵션을 나타냅니다.
otCoapOptionContentFormat typedef
CoAP 콘텐츠 형식 코드입니다.
otCoapOptionIterator typedef
이 구조는 CoAP 옵션의 반복기 역할을 합니다.
otCoapOptionType typedef
CoAP 옵션 번호입니다.
otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
void(*
이 함수 포인터는 지정된 URI 경로가 있는 CoAP 요청이 수신될 때 호출됩니다.
otCoapResource typedef
이 구조는 CoAP 리소스를 나타냅니다.
otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult) typedef
void(*
이 함수 포인터는 CoAP 응답이 수신되거나 요청 제한 시간에 발생할 때 호출됩니다.
otCoapTxParameters typedef
이 구조는 CoAP 전송 매개변수를 나타냅니다.
otCoapType typedef
enum otCoapType
CoAP 유형 값 (2비트 부호 없는 정수)

함수

otCoapAddBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource)
void
이 함수는 CoAP 서버에 블록별 리소스를 추가합니다.
otCoapAddResource(otInstance *aInstance, otCoapResource *aResource)
void
이 함수는 CoAP 서버에 리소스를 추가합니다.
otCoapBlockSizeFromExponent(otCoapBlockSzx aSize)
uint16_t
이 함수는 CoAP Block 옵션 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 경로 옵션을 추가합니다.
otCoapMessageAppendUriQueryOption(otMessage *aMessage, const char *aUriQuery)
이 함수는 단일 URI 쿼리 옵션을 추가합니다.
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 *
이 함수는 토큰 값에 대한 포인터를 반환합니다.
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 서버를 중지합니다.

구조체

otCoapBlockwardResource

이 구조는 블록별 전송을 사용하는 CoAP 리소스를 나타냅니다.

otCoapOption

이 구조는 CoAP 옵션을 나타냅니다.

otCoapOptionIterator:

이 구조는 CoAP 옵션의 반복기 역할을 합니다.

otCoapResource

이 구조는 CoAP 리소스를 나타냅니다.

otCoapTxParameters

이 구조는 CoAP 전송 매개변수를 나타냅니다.

열거형

otCoaBlockBlockSzx

 otCoapBlockSzx

CoAP 블록 크기 지수입니다.

OTCoaCode

 otCoapCode

CoAP 코드 값입니다.

속성
OT_COAP_CODE_BAD_GATEWAY

게이트웨이가 잘못되었습니다.

OT_COAP_CODE_BAD_OPTION

잘못된 옵션입니다.

OT_COAP_CODE_BAD_REQUEST

잘못된 요청입니다.

OT_COAP_CODE_CHANGED

변경되었습니다.

OT_COAP_CODE_CONTENT

콘텐츠.

OT_COAP_CODE_CONTINUE

RFC7959 계속

OT_COAP_CODE_CREATED

생성됨

OT_COAP_CODE_DELETE

삭제

OT_COAP_CODE_DELETED

삭제되었습니다.

OT_COAP_CODE_EMPTY

메시지 코드가 비어 있습니다.

OT_COAP_CODE_FORBIDDEN

금지되었습니다.

OT_COAP_CODE_GATEWAY_TIMEOUT

게이트웨이 시간이 초과되었습니다.

OT_COAP_CODE_GET

받기

OT_COAP_CODE_INTERNAL_ERROR

내부 서버 오류

OT_COAP_CODE_METHOD_NOT_ALLOWED

허용되지 않는 방법입니다.

OT_COAP_CODE_NOT_ACCEPTABLE

허용되지 않음.

OT_COAP_CODE_NOT_FOUND

찾을 수 없음

OT_COAP_CODE_NOT_IMPLEMENTED

구현되지 않음

OT_COAP_CODE_POST

게시를 탭합니다.

OT_COAP_CODE_PRECONDITION_FAILED

전제조건이 실패했습니다.

OT_COAP_CODE_PROXY_NOT_SUPPORTED

프록시는 지원되지 않습니다.

OT_COAP_CODE_PUT

놓으세요.

OT_COAP_CODE_REQUEST_INCOMPLETE

RFC7959 요청 요소가 완료되지 않았습니다.

OT_COAP_CODE_REQUEST_TOO_LARGE

요청 요소가 너무 큽니다.

OT_COAP_CODE_RESPONSE_MIN

2.00

OT_COAP_CODE_SERVICE_UNAVAILABLE

서비스를 사용할 수 없습니다.

OT_COAP_CODE_UNAUTHORIZED

승인되지 않았습니다.

OT_COAP_CODE_UNSUPPORTED_FORMAT

지원되지 않는 콘텐츠 형식입니다.

OT_COAP_CODE_VALID

올바른 쿼리입니다.

otCoapOptionContentFormat

 otCoapOptionContentFormat

CoAP 콘텐츠 형식 코드입니다.

전체 목록은 https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats에 문서화됩니다.

속성
OT_COAP_OPTION_CONTENT_FORMAT_CBOR

애플리케이션/cbor: [RFC7049]

OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON

애플리케이션/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

애플리케이션/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

애플리케이션/cwt: [RFC8392]

OT_COAP_OPTION_CONTENT_FORMAT_EXI

application/exi: ["효율적인 XML 교환 (EXI) 형식 1.0 (두 번째 버전)", 2014년 2월]

OT_COAP_OPTION_CONTENT_FORMAT_JSON

애플리케이션/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

애플리케이션/senml+cbor: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI

application/senml-exi: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON

애플리케이션/senml+json: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML

application/senml+xml: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_CBOR

애플리케이션/sensml+cbor: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_EXI

application/sensml-exi: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_JSON

애플리케이션/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]

OTCoaOptionOption

 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

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는 호스트입니다.

OT_COAP_OPTION_URI_PATH

URI-경로

OT_COAP_OPTION_URI_PORT

URI 포트

OT_COAP_OPTION_URI_QUERY

URI 쿼리입니다.

OTCoaType

 otCoapType

CoAP 유형 값 (2비트 부호 없는 정수)

속성
OT_COAP_TYPE_ACKNOWLEDGMENT

인정.

OT_COAP_TYPE_CONFIRMABLE

확인 가능.

OT_COAP_TYPE_NON_CONFIRMABLE

확인할 수 없습니다.

OT_COAP_TYPE_RESET

초기화를 탭합니다.

Typedef

otCoaBlockBlockSzx

enum otCoapBlockSzx otCoapBlockSzx

CoAP 블록 크기 지수입니다.

otCoaBlockBlockwardReceiveHook

otError(* otCoapBlockwiseReceiveHook)(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength)

이 함수 포인터는 차단별 전송 옵션이 있는 CoAP 메시지가 수신될 때 호출됩니다.

이 함수는 OPENINVALID_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE 구성이 사용 설정된 경우 사용할 수 있습니다.

세부정보
매개변수
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.
[in] aBlock
블록 세그먼트에 대한 포인터입니다.
[in] aPosition
시퀀스에서 aBlock의 위치(바이트)입니다.
[in] aBlockLength
블록 세그먼트의 길이(바이트)입니다.
[in] aMore
더 많은 차단 세그먼트가 팔로우되면 플래그를 지정합니다.
[in] aTotalLength
전송된 정보의 총 길이(바이트)입니다(Size1 또는 Size2 옵션으로 표시).
반환 값
OT_ERROR_NONE
차단 세그먼트가 저장되었습니다.
OT_ERROR_NO_BUFS
블록을 저장할 메모리가 더 이상 없습니다.
OT_ERROR_NO_FRAME_RECEIVED
차단 세그먼트가 누락되었습니다.

otCoaBlockBlockwardResource

struct otCoapBlockwiseResource otCoapBlockwiseResource

이 구조는 블록별 전송을 사용하는 CoAP 리소스를 나타냅니다.

ota

otError(* otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore)

이 함수 포인터는 블록별 전송의 다음 블록이 전송되기 전에 호출됩니다.

이 함수는 OPENINVALID_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE 구성이 사용 설정된 경우 사용할 수 있습니다.

aBlockLength 값을 변경하면 전체 거래소의 블록 크기가 재협상됩니다. 이후 변경사항을 적용하면 다른 CoAP 구현에 문제가 발생할 수 있으므로 첫 번째 블록을 수신한 후에 이 작업을 수행하는 것이 좋습니다.

세부정보
매개변수
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.
[in,out] aBlock
블록 세그먼트를 작성할 수 있는 포인터입니다.
[in] aPosition
차단 세그먼트를 가져올 시퀀스의 위치입니다.
[in,out] aBlockLength
입력 시 최대 차단 세그먼트 길이(바이트)입니다.
[out] aMore
더 많은 차단 세그먼트가 뒤따를 때 플래그에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
오류가 발생하지 않았습니다.
OT_ERROR_INVALID_ARGS
aPosition에 차단이 없습니다.

OTCoaCode

enum otCoapCode otCoapCode

CoAP 코드 값입니다.

otCoaOption

struct otCoapOption otCoapOption

이 구조는 CoAP 옵션을 나타냅니다.

otCoapOptionContentFormat

enum otCoapOptionContentFormat otCoapOptionContentFormat

CoAP 콘텐츠 형식 코드입니다.

전체 목록은 https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats에 문서화됩니다.

OTCoapOptionIterator

struct otCoapOptionIterator otCoapOptionIterator

이 구조는 CoAP 옵션의 반복기 역할을 합니다.

OTCoaOptionOption

enum otCoapOptionType otCoapOptionType

CoAP 옵션 번호입니다.

otCoapRequestHandler

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

이 함수 포인터는 지정된 URI 경로가 있는 CoAP 요청이 수신될 때 호출됩니다.

세부정보
매개변수
[in] aContext
임의의 컨텍스트 정보를 가리키는 포인터입니다.
[in] aMessage
메시지에 대한 포인터입니다.
[in] aMessageInfo
aMessage의 메시지 정보에 대한 포인터입니다.

OTCoaResource

struct otCoapResource otCoapResource

이 구조는 CoAP 리소스를 나타냅니다.

otCoapResponseHandler

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

이 함수 포인터는 CoAP 응답이 수신되거나 요청 제한 시간에 발생할 때 호출됩니다.

세부정보
매개변수
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.
[in] aMessage
응답이 포함된 메시지 버퍼에 대한 포인터입니다. 수신된 응답이 없으면 NULL입니다.
[in] aMessageInfo
aMessage의 메시지 정보에 대한 포인터입니다. 수신된 응답이 없으면 NULL입니다.
[in] aResult
CoAP 거래의 결과입니다.
반환 값
OT_ERROR_NONE
응답이 수신되었습니다.
OT_ERROR_ABORT
피어에서 CoAP 트랜잭션을 재설정했습니다.
OT_ERROR_RESPONSE_TIMEOUT
제한 시간 동안 응답이나 확인이 수신되지 않았습니다.

otCoapTxParameters

struct otCoapTxParameters otCoapTxParameters

이 구조는 CoAP 전송 매개변수를 나타냅니다.

OTCoaType

enum otCoapType otCoapType

CoAP 유형 값 (2비트 부호 없는 정수)

함수

OTCoapAddBlockWiseResource

void otCoapAddBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

이 함수는 CoAP 서버에 블록별 리소스를 추가합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aResource
리소스에 대한 포인터입니다.

OTCoaAddAddResource

void otCoapAddResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

이 함수는 CoAP 서버에 리소스를 추가합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aResource
리소스에 대한 포인터입니다.

otCoapBlockSizeFromExponent

uint16_t otCoapBlockSizeFromExponent(
  otCoapBlockSzx aSize
)

이 함수는 CoAP Block 옵션 SZX 필드를 실제 블록 크기로 변환합니다.

세부정보
매개변수
[in] aSize
블록 크기 지수
반환
실제 크기 지수 값입니다.

otCoapMessageAppendBlock1Option

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

이 함수는 Block1 옵션을 추가합니다.

세부정보
매개변수
[in,out] aMessage
CoAP 메시지에 대한 포인터입니다.
[in] aNum
현재 블록 번호입니다.
[in] aMore
더 많은 블록을 전송해야 함을 나타내는 부울입니다.
[in] aSize
블록 크기 지수
반환 값
OT_ERROR_NONE
옵션을 추가했습니다.
OT_ERROR_INVALID_ARGS
옵션 유형이 마지막 옵션 유형과 같거나 이보다 크지 않습니다.
OT_ERROR_NO_BUFS
옵션 길이가 버퍼 크기를 초과합니다.

otCoapMessageAppendBlock2Option

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

이 함수는 Block2 옵션을 추가합니다.

세부정보
매개변수
[in,out] aMessage
CoAP 메시지에 대한 포인터입니다.
[in] aNum
현재 블록 번호입니다.
[in] aMore
더 많은 블록을 전송해야 함을 나타내는 부울입니다.
[in] aSize
블록 크기 지수
반환 값
OT_ERROR_NONE
옵션을 추가했습니다.
OT_ERROR_INVALID_ARGS
옵션 유형이 마지막 옵션 유형과 같거나 이보다 크지 않습니다.
OT_ERROR_NO_BUFS
옵션 길이가 버퍼 크기를 초과합니다.

otCoapMessageAppendContentFormatOption

otError otCoapMessageAppendContentFormatOption(
  otMessage *aMessage,
  otCoapOptionContentFormat aContentFormat
)

이 함수는 https://tools.ietf.org/html/rfc7252#page-92에 지정된 대로 콘텐츠 형식 CoAP 옵션을 추가합니다.

메시지에 페이로드가 포함되어야 하는 경우 otCoapMessageSetPayloadMarker를 설정하기 전에 호출해야 합니다.

이 함수는 otCoapMessageAppendUintOption의 편의 래퍼이며 원하는 형식 유형 코드가 otCoapOptionContentFormat에 나열되지 않은 경우 대신 이 기본 함수를 사용해야 합니다.

세부정보
매개변수
[in,out] aMessage
CoAP 메시지에 대한 포인터입니다.
[in] aContentFormat
위의 otCoapOptionContentFormat에 나열된 콘텐츠 형식 중 하나입니다.
반환 값
OT_ERROR_NONE
옵션을 추가했습니다.
OT_ERROR_INVALID_ARGS
옵션 유형이 마지막 옵션 유형과 같거나 이보다 크지 않습니다.
OT_ERROR_NO_BUFS
옵션 길이가 버퍼 크기를 초과합니다.

otCoapMessageAppendMaxAgeOption

otError otCoapMessageAppendMaxAgeOption(
  otMessage *aMessage,
  uint32_t aMaxAge
)

이 함수는 Max-Age 옵션을 추가합니다.

세부정보
매개변수
[in,out] aMessage
CoAP 메시지에 대한 포인터입니다.
[in] aMaxAge
Max-Age 값입니다.
반환 값
OT_ERROR_NONE
옵션을 추가했습니다.
OT_ERROR_INVALID_ARGS
옵션 유형이 마지막 옵션 유형과 같거나 이보다 크지 않습니다.
OT_ERROR_NO_BUFS
옵션 길이가 버퍼 크기를 초과합니다.

otCoapMessageAppendObserveOption

otError otCoapMessageAppendObserveOption(
  otMessage *aMessage,
  uint32_t aObserve
)

이 함수는 관찰 옵션을 추가합니다.

세부정보
매개변수
[in,out] aMessage
CoAP 메시지에 대한 포인터입니다.
[in] aObserve
필드 값을 관찰합니다.
반환 값
OT_ERROR_NONE
옵션을 추가했습니다.
OT_ERROR_INVALID_ARGS
옵션 유형이 마지막 옵션 유형과 같거나 이보다 크지 않습니다.
OT_ERROR_NO_BUFS
옵션 길이가 버퍼 크기를 초과합니다.

otCoapMessageAppendOption

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

이 함수는 헤더에 CoAP 옵션을 추가합니다.

세부정보
매개변수
[in,out] aMessage
CoAP 메시지에 대한 포인터입니다.
[in] aNumber
CoAP 옵션 번호입니다.
[in] aLength
CoAP 옵션 길이입니다.
[in] aValue
CoAP 값에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
옵션을 추가했습니다.
OT_ERROR_INVALID_ARGS
옵션 유형이 마지막 옵션 유형과 같거나 이보다 크지 않습니다.
OT_ERROR_NO_BUFS
옵션 길이가 버퍼 크기를 초과합니다.

otCoapMessageAppendProxyUriOption

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

이 함수는 Proxy-Uri 옵션을 추가합니다.

세부정보
매개변수
[in,out] aMessage
CoAP 메시지에 대한 포인터입니다.
[in] aUriPath
NULL로 끝나는 문자열을 가리키는 포인터입니다.
반환 값
OT_ERROR_NONE
옵션을 추가했습니다.
OT_ERROR_INVALID_ARGS
옵션 유형이 마지막 옵션 유형과 같거나 이보다 크지 않습니다.
OT_ERROR_NO_BUFS
옵션 길이가 버퍼 크기를 초과합니다.

otCoapMessageAppendUintOption

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

이 함수는 https://tools.ietf.org/html/rfc7252#section-3.2에 지정된 대로 부호 없는 정수 CoAP 옵션을 추가합니다.

세부정보
매개변수
[in,out] aMessage
CoAP 메시지에 대한 포인터입니다.
[in] aNumber
CoAP 옵션 번호입니다.
[in] aValue
CoAP Option 부호 없는 정수 값입니다.
반환 값
OT_ERROR_NONE
옵션을 추가했습니다.
OT_ERROR_INVALID_ARGS
옵션 유형이 마지막 옵션 유형과 같거나 이보다 크지 않습니다.
OT_ERROR_NO_BUFS
옵션 길이가 버퍼 크기를 초과합니다.
참고:
otCoapMessageGetOptionUintValue

otCoapMessageAppendUriPathOptions

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

이 함수는 URI 경로 옵션을 추가합니다.

세부정보
매개변수
[in,out] aMessage
CoAP 메시지에 대한 포인터입니다.
[in] aUriPath
NULL로 끝나는 문자열을 가리키는 포인터입니다.
반환 값
OT_ERROR_NONE
옵션을 추가했습니다.
OT_ERROR_INVALID_ARGS
옵션 유형이 마지막 옵션 유형과 같거나 이보다 크지 않습니다.
OT_ERROR_NO_BUFS
옵션 길이가 버퍼 크기를 초과합니다.

otCoapMessageAppendUriQueryOption

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

이 함수는 단일 URI 쿼리 옵션을 추가합니다.

세부정보
매개변수
[in,out] aMessage
CoAP 메시지에 대한 포인터입니다.
[in] aUriQuery
NULL로 끝나는 문자열에 대한 포인터로, 단일 키=값 쌍이 포함되어야 합니다.
반환 값
OT_ERROR_NONE
옵션을 추가했습니다.
OT_ERROR_INVALID_ARGS
옵션 유형이 마지막 옵션 유형과 같거나 이보다 크지 않습니다.
OT_ERROR_NO_BUFS
옵션 길이가 버퍼 크기를 초과합니다.

otCoapMessageCodeToString

const char * otCoapMessageCodeToString(
  const otMessage *aMessage
)

이 메서드는 CoAP 코드를 사람이 읽을 수 있는 문자열로 반환합니다.

@ 기호는 문자열로 CoAP 코드를 반환합니다.

세부정보
매개변수
[in] aMessage
CoAP 메시지에 대한 포인터입니다.

otCoapMessageGenerateToken

void otCoapMessageGenerateToken(
  otMessage *aMessage,
  uint8_t aTokenLength
)

이 함수는 토큰 길이를 설정하고 값을 무작위로 지정합니다.

세부정보
매개변수
[in,out] aMessage
CoAP 메시지에 대한 포인터입니다.
[in] aTokenLength
설정할 토큰의 길이입니다.

OTCoaMessageMessageCode

otCoapCode otCoapMessageGetCode(
  const otMessage *aMessage
)

이 함수는 코드 값을 반환합니다.

세부정보
매개변수
[in] aMessage
CoAP 메시지에 대한 포인터입니다.
반환
코드 값입니다.

otCoapMessageGetMessageId

uint16_t otCoapMessageGetMessageId(
  const otMessage *aMessage
)

이 함수는 메시지 ID 값을 반환합니다.

세부정보
매개변수
[in] aMessage
CoAP 메시지에 대한 포인터입니다.
반환
메시지 ID 값입니다.

otCoapMessageGetToken

const uint8_t * otCoapMessageGetToken(
  const otMessage *aMessage
)

이 함수는 토큰 값에 대한 포인터를 반환합니다.

세부정보
매개변수
[in] aMessage
CoAP 메시지에 대한 포인터입니다.
반환
토큰 값에 대한 포인터입니다.

otCoapMessageGetTokenLength

uint8_t otCoapMessageGetTokenLength(
  const otMessage *aMessage
)

이 함수는 토큰 길이를 반환합니다.

세부정보
매개변수
[in] aMessage
CoAP 메시지에 대한 포인터입니다.
반환
토큰 길이

otCoapMessageGetType

otCoapType otCoapMessageGetType(
  const otMessage *aMessage
)

이 함수는 유형 값을 반환합니다.

세부정보
매개변수
[in] aMessage
CoAP 메시지에 대한 포인터입니다.
반환
유형 값입니다.

OTCoaMessageInit

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

이 함수는 CoAP 헤더를 초기화합니다.

세부정보
매개변수
[in,out] aMessage
초기화할 CoAP 메시지를 가리키는 포인터입니다.
[in] aType
CoAP 메시지 유형입니다.
[in] aCode
CoAP 메시지 코드입니다.

otCoapMessageInitResponse

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

이 함수는 응답 메시지를 초기화합니다.

세부정보
매개변수
[in,out] aResponse
CoAP 응답 메시지에 대한 포인터입니다.
[in] aRequest
CoAP 요청 메시지에 대한 포인터입니다.
[in] aType
CoAP 메시지 유형입니다.
[in] aCode
CoAP 메시지 코드입니다.
반환 값
OT_ERROR_NONE
응답 메시지를 초기화했습니다.
OT_ERROR_NO_BUFS
응답 메시지를 초기화할 수 있는 메시지 버퍼가 충분하지 않습니다.

otCoapMessageSetCode

void otCoapMessageSetCode(
  otMessage *aMessage,
  otCoapCode aCode
)

이 함수는 코드 값을 설정합니다.

세부정보
매개변수
[in,out] aMessage
초기화할 CoAP 메시지를 가리키는 포인터입니다.
[in] aCode
CoAP 메시지 코드입니다.

otCoapMessageSetPayloadMarker

otError otCoapMessageSetPayloadMarker(
  otMessage *aMessage
)

이 함수는 페이로드의 시작을 나타내는 페이로드 마커를 CoAP 헤더에 추가합니다.

세부정보
매개변수
[in,out] aMessage
CoAP 메시지에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
페이로드 마커가 추가되었습니다.
OT_ERROR_NO_BUFS
헤더 페이로드 마커가 버퍼 크기를 초과합니다.

otCoapMessageSetToken

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

이 함수는 헤더에 토큰 값과 길이를 설정합니다.

세부정보
매개변수
[in,out] aMessage
CoAP 메시지에 대한 포인터입니다.
[in] aToken
토큰 값에 대한 포인터입니다.
[in] aTokenLength
aToken의 길이입니다.
반환 값
OT_ERROR_NONE
토큰 값을 설정했습니다.
OT_ERROR_NO_BUFS
토큰 값을 설정하기 위한 버퍼가 부족합니다.

OTCoaNewMessage

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

이 함수는 새 CoAP 메시지를 만듭니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aSettings
메시지 설정을 가리키는 포인터 또는 기본 설정을 설정하는 NULL
반환
메시지 버퍼에 대한 포인터 또는 사용 가능한 메시지 버퍼가 없거나 매개변수가 유효하지 않은 경우 NULL입니다.

otCoapOptionIteratorGetFirstOption

const otCoapOption * otCoapOptionIteratorGetFirstOption(
  otCoapOptionIterator *aIterator
)

이 함수는 첫 번째 옵션에 대한 포인터를 반환합니다.

세부정보
매개변수
[in,out] aIterator
CoAP 메시지 옵션 반복자를 가리키는 포인터입니다.
반환
첫 번째 옵션에 대한 포인터입니다. 옵션이 없으면 NULL 포인터가 반환됩니다.

otCoapOptionIteratorGetFirstOptionMatching

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

이 함수는 지정된 옵션 번호와 일치하는 첫 번째 옵션에 대한 포인터를 반환합니다.

세부정보
매개변수
[in] aIterator
CoAP 메시지 옵션 반복자를 가리키는 포인터입니다.
[in] aOption
옵션 번호를 찾았습니다.
반환
첫 번째 일치 옵션에 대한 포인터입니다. 일치하는 옵션이 없으면 NULL 포인터가 반환됩니다.

otCoapOptionIteratorGetNextOption

const otCoapOption * otCoapOptionIteratorGetNextOption(
  otCoapOptionIterator *aIterator
)

이 함수는 다음 옵션에 대한 포인터를 반환합니다.

세부정보
매개변수
[in,out] aIterator
CoAP 메시지 옵션 반복자를 가리키는 포인터입니다.
반환
다음 옵션에 대한 포인터입니다. 추가 옵션이 없는 경우 NULL 포인터가 반환됩니다.

otCoapOptionIteratorGetNextOptionMatching

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

이 함수는 지정된 옵션 번호와 일치하는 다음 옵션에 대한 포인터를 반환합니다.

세부정보
매개변수
[in] aIterator
CoAP 메시지 옵션 반복자를 가리키는 포인터입니다.
[in] aOption
옵션 번호를 찾았습니다.
반환
다음 일치 옵션을 가리키는 포인터입니다. 추가 일치 옵션이 없는 경우 NULL 포인터가 반환됩니다.

otCoapOptionIteratorGetOptionUintValue

otError otCoapOptionIteratorGetOptionUintValue(
  otCoapOptionIterator *aIterator,
  uint64_t *aValue
)

이 함수는 현재 값이 https://tools.ietf.org/html/rfc7252#section-3.2에 따라 인코딩된 부호 없는 정수라고 가정하여 현재 옵션 값을 aValue에 채웁니다.

세부정보
매개변수
[in,out] aIterator
CoAP 메시지 옵션 반복자를 가리키는 포인터입니다.
[out] aValue
옵션 값을 수신할 부호가 없는 정수에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
값을 입력했습니다.
OT_ERROR_NOT_FOUND
현재 옵션이 없습니다.
OT_ERROR_NO_BUFS
값이 너무 길어서 uint64_t에 넣을 수 없습니다.
참고:
otCoapMessageAppendUintOption

otCoapOptionIteratorGetOptionValue

otError otCoapOptionIteratorGetOptionValue(
  otCoapOptionIterator *aIterator,
  void *aValue
)

이 함수는 현재 옵션 값을 aValue에 채웁니다.

세부정보
매개변수
[in,out] aIterator
CoAP 메시지 옵션 반복자를 가리키는 포인터입니다.
[out] aValue
옵션 값을 수신할 버퍼에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
값을 입력했습니다.
OT_ERROR_NOT_FOUND
현재 옵션이 없습니다.

otCoaOptionOptionIteratorInit

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

이 함수는 지정된 메시지의 옵션에 대해 반복기를 초기화합니다.

세부정보
매개변수
[in,out] aIterator
CoAP 메시지 옵션 반복자를 가리키는 포인터입니다.
[in] aMessage
CoAP 메시지에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
초기화되었습니다.
OT_ERROR_PARSE
메시지 상태가 일관되지 않습니다.

OTCoaRemoveRemoveBlockWiseResource

void otCoapRemoveBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

이 함수는 CoAP 서버에서 블록별 리소스를 삭제합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aResource
리소스에 대한 포인터입니다.

리소스 삭제

void otCoapRemoveResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

이 함수는 CoAP 서버에서 리소스를 삭제합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aResource
리소스에 대한 포인터입니다.

otCoapSendRequest

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

이 함수는 CoAP 요청을 전송합니다.

요청에 대한 응답이 예상되는 경우 각 함수와 컨텍스트 정보를 제공해야 합니다. 응답이 예상되지 않는 경우 이러한 인수는 NULL 포인터여야 합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aMessage
전송할 메시지에 대한 포인터입니다.
[in] aMessageInfo
aMessage와 연결된 메시지 정보에 대한 포인터입니다.
[in] aHandler
응답 수신 또는 시간 초과 시 호출될 함수 포인터입니다.
[in] aContext
임의의 컨텍스트 정보를 가리키는 포인터입니다. 사용하지 않는 경우 NULL일 수 있습니다.
반환 값
OT_ERROR_NONE
CoAP 메시지를 보냈습니다.
OT_ERROR_NO_BUFS
재전송 데이터를 할당하지 못했습니다.

OTCoapSendRequestBlockWise

otError otCoapSendRequestBlockWise(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext,
  otCoapBlockwiseTransmitHook aTransmitHook,
  otCoapBlockwiseReceiveHook aReceiveHook
)

이 함수는 CoAP 요청을 블록 단위로 전송합니다.

이 함수는 OPENINVALID_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE 구성이 사용 설정된 경우 사용할 수 있습니다.

요청에 대한 응답이 예상되는 경우 각 함수와 컨텍스트 정보를 제공해야 합니다. 응답이 블록에 관련되어야 하는 경우 각 후크 함수를 제공해야 합니다. 응답이 예상되지 않는 경우 이러한 인수는 NULL 포인터여야 합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aMessage
전송할 메시지에 대한 포인터입니다.
[in] aMessageInfo
aMessage와 연결된 메시지 정보에 대한 포인터입니다.
[in] aHandler
응답 수신 또는 시간 초과 시 호출될 함수 포인터입니다.
[in] aContext
임의의 컨텍스트 정보를 가리키는 포인터입니다. 사용하지 않는 경우 NULL일 수 있습니다.
[in] aTransmitHook
발신 차단별 전송을 위한 후크 함수에 대한 포인터입니다.
[in] aReceiveHook
수신 블록별 전송을 위한 후크 함수에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
CoAP 메시지를 보냈습니다.
OT_ERROR_NO_BUFS
재전송 데이터를 할당하지 못했습니다.

otCoapSendRequestBlockWiseWithParameters

otError otCoapSendRequestBlockWiseWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext,
  const otCoapTxParameters *aTxParameters,
  otCoapBlockwiseTransmitHook aTransmitHook,
  otCoapBlockwiseReceiveHook aReceiveHook
)

이 함수는 커스텀 전송 매개변수와 함께 CoAP 요청을 블록별로 전송합니다.

이 함수는 OPENINVALID_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE 구성이 사용 설정된 경우 사용할 수 있습니다.

요청에 대한 응답이 예상되는 경우 각 함수와 컨텍스트 정보를 제공해야 합니다. 응답이 블록에 관련되어야 하는 경우 각 후크 함수를 제공해야 합니다. 응답이 예상되지 않는 경우 이러한 인수는 NULL 포인터여야 합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aMessage
전송할 메시지에 대한 포인터입니다.
[in] aMessageInfo
aMessage와 연결된 메시지 정보에 대한 포인터입니다.
[in] aHandler
응답 수신 또는 시간 초과 시 호출될 함수 포인터입니다.
[in] aContext
임의의 컨텍스트 정보를 가리키는 포인터입니다. 사용하지 않는 경우 NULL일 수 있습니다.
[in] aTxParameters
이 요청의 전송 매개변수에 대한 포인터입니다. 기본값에는 NULL을 사용합니다.
[in] aTransmitHook
발신 차단별 전송을 위한 후크 함수에 대한 포인터입니다.
[in] aReceiveHook
수신 블록별 전송을 위한 후크 함수에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
CoAP 메시지를 보냈습니다.
OT_ERROR_NO_BUFS
재전송 데이터를 할당하지 못했습니다.

otCoapSendRequestWithParameters

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

이 함수는 커스텀 전송 매개변수와 함께 CoAP 요청을 전송합니다.

요청에 대한 응답이 예상되는 경우 각 함수와 컨텍스트 정보를 제공해야 합니다. 응답이 예상되지 않는 경우 이러한 인수는 NULL 포인터여야 합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aMessage
전송할 메시지에 대한 포인터입니다.
[in] aMessageInfo
aMessage와 연결된 메시지 정보에 대한 포인터입니다.
[in] aHandler
응답 수신 또는 시간 초과 시 호출될 함수 포인터입니다.
[in] aContext
임의의 컨텍스트 정보를 가리키는 포인터입니다. 사용하지 않는 경우 NULL일 수 있습니다.
[in] aTxParameters
이 요청의 전송 매개변수에 대한 포인터입니다. 기본값에는 NULL을 사용합니다. 그렇지 않은 경우 매개변수는 다음 조건을 충족해야 합니다.
  1. mMaxRetransmit는 OT_COAP_MAX_RETRANSMIT 이하입니다.
  2. mAckRandomFactorNumerator / mAckRandomFactorDenominator가 1.0 미만이어서는 안 됩니다.
  3. 계산된 교환 수명은 uint32_t를 초과해서는 안 됩니다.
반환 값
OT_ERROR_INVALID_ARGS
aTxParameters의 형식이 잘못되었습니다.
OT_ERROR_NONE
CoAP 메시지를 보냈습니다.
OT_ERROR_NO_BUFS
재전송 데이터를 할당하지 못했습니다.

otCoapSendResponse

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

이 함수는 서버에서 CoAP 응답을 전송합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aMessage
전송할 CoAP 응답에 대한 포인터입니다.
[in] aMessageInfo
aMessage와 연결된 메시지 정보에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
CoAP 응답 메시지를 큐에 추가했습니다.
OT_ERROR_NO_BUFS
CoAP 응답을 보낼 수 있는 버퍼가 충분하지 않습니다.

otCoapSendResponseBlockWise

otError otCoapSendResponseBlockWise(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  void *aContext,
  otCoapBlockwiseTransmitHook aTransmitHook
)

이 함수는 서버에서 CoAP 응답을 블록 단위로 전송합니다.

이 함수는 OPENINVALID_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE 구성이 사용 설정된 경우 사용할 수 있습니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aMessage
전송할 CoAP 응답에 대한 포인터입니다.
[in] aMessageInfo
aMessage와 연결된 메시지 정보에 대한 포인터입니다.
[in] aContext
임의의 컨텍스트 정보를 가리키는 포인터입니다. 사용하지 않는 경우 NULL일 수 있습니다.
[in] aTransmitHook
발신 차단별 전송을 위한 후크 함수에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
CoAP 응답 메시지를 큐에 추가했습니다.
OT_ERROR_NO_BUFS
CoAP 응답을 보낼 수 있는 버퍼가 충분하지 않습니다.

otCoapSendResponseBlockWiseWithParameters

otError otCoapSendResponseBlockWiseWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  const otCoapTxParameters *aTxParameters,
  void *aContext,
  otCoapBlockwiseTransmitHook aTransmitHook
)

이 함수는 서버에서 맞춤 전송 매개변수와 함께 CoAP 응답을 블록 단위로 전송합니다.

이 함수는 OPENINVALID_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE 구성이 사용 설정된 경우 사용할 수 있습니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aMessage
전송할 CoAP 응답에 대한 포인터입니다.
[in] aMessageInfo
aMessage와 연결된 메시지 정보에 대한 포인터입니다.
[in] aTxParameters
이 응답의 전송 매개변수에 대한 포인터입니다. 기본값에는 NULL을 사용합니다.
[in] aContext
임의의 컨텍스트 정보를 가리키는 포인터입니다. 사용하지 않는 경우 NULL일 수 있습니다.
[in] aTransmitHook
발신 차단별 전송을 위한 후크 함수에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
CoAP 응답 메시지를 큐에 추가했습니다.
OT_ERROR_NO_BUFS
CoAP 응답을 보낼 수 있는 버퍼가 충분하지 않습니다.

otCoapSendResponseWithParameters

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

이 함수는 서버에서 맞춤 전송 매개변수와 함께 CoAP 응답을 전송합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aMessage
전송할 CoAP 응답에 대한 포인터입니다.
[in] aMessageInfo
aMessage와 연결된 메시지 정보에 대한 포인터입니다.
[in] aTxParameters
이 응답의 전송 매개변수에 대한 포인터입니다. 기본값에는 NULL을 사용합니다.
반환 값
OT_ERROR_NONE
CoAP 응답 메시지를 큐에 추가했습니다.
OT_ERROR_NO_BUFS
CoAP 응답을 보낼 수 있는 버퍼가 충분하지 않습니다.

otCoapSetDefaultHandler

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

이 함수는 처리되지 않은 CoAP 요청에 대한 기본 핸들러를 설정합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aHandler
처리되지 않은 요청이 도착할 때 호출할 함수 포인터입니다.
[in] aContext
임의의 컨텍스트 정보를 가리키는 포인터입니다. 사용하지 않는 경우 NULL일 수 있습니다.

OTCoaStart

otError otCoapStart(
  otInstance *aInstance,
  uint16_t aPort
)

이 함수는 CoAP 서버를 시작합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aPort
결합할 로컬 UDP 포트입니다.
반환 값
OT_ERROR_NONE
CoAP 서버를 시작했습니다.
OT_ERROR_FAILED
CoAP 서버를 시작할 수 없습니다.

OTCoAStop

otError otCoapStop(
  otInstance *aInstance
)

이 함수는 CoAP 서버를 중지합니다.

세부정보
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
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에서 제공되는 소스 코드에서 비롯됩니다. 자세한 내용을 보거나 문서에 참여하려면 리소스를 참조하세요.