CoAP

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

요약

이 모듈의 기능은 CoAP API 기능 ( OPENTHREAD_CONFIG_COAP_API_ENABLE )이 활성화 된 경우 사용할 수 있습니다.

열거 형
`otCoapBlockSzx`	열거 형 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)) }	열거 형 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 }	열거 형 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 }	열거 형 CoAP 옵션 번호.
`otCoapType { OT_COAP_TYPE_CONFIRMABLE = 0, OT_COAP_TYPE_NON_CONFIRMABLE = 1, OT_COAP_TYPE_ACKNOWLEDGMENT = 2, OT_COAP_TYPE_RESET = 3 }`	열거 형 CoAP 유형 값 (2 비트 부호없는 정수).

Typedef
`otCoapBlockSzx`	typedef `enum otCoapBlockSzx` CoAP 블록 크기 지수.
`otCoapBlockwiseReceiveHook )(void aContext, const uint8_t aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength)`	typedef `otError (*` 이 함수 포인터는 블록 단위 전송 옵션이있는 CoAP 메시지가 수신 될 때 호출됩니다.
`otCoapBlockwiseResource`	typedef `struct otCoapBlockwiseResource` 이 구조는 블록 단위 전송이있는 CoAP 리소스를 나타냅니다.
`otCoapBlockwiseTransmitHook )(void aContext, uint8_t aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore)`	typedef `otError (*` 이 함수 포인터는 블록 단위 전송에서 다음 블록이 전송되기 전에 호출됩니다.
`otCoapCode`	typedef `enum otCoapCode` CoAP 코드 값.
`otCoapOption`	typedef `struct otCoapOption` 이 구조는 CoAP 옵션을 나타냅니다.
`otCoapOptionContentFormat`	typedef `enum otCoapOptionContentFormat` CoAP 콘텐츠 형식 코드.
`otCoapOptionIterator`	typedef `struct otCoapOptionIterator` 이 구조는 CoAP 옵션에 대한 반복기 역할을합니다.
`otCoapOptionType`	typedef `enum otCoapOptionType` CoAP 옵션 번호.
`otCoapRequestHandler )(void aContext, otMessage aMessage, const otMessageInfo *aMessageInfo)`	typedef `void(*` 이 함수 포인터는 주어진 Uri-Path가있는 CoAP 요청이 수신 될 때 호출됩니다.
`otCoapResource`	typedef `struct otCoapResource` 이 구조는 CoAP 리소스를 나타냅니다.
`otCoapResponseHandler )(void aContext, otMessage aMessage, const otMessageInfo *aMessageInfo, otError aResult)`	typedef `void(*` 이 함수 포인터는 CoAP 응답이 수신되거나 요청 시간 초과시 호출됩니다.
`otCoapTxParameters`	typedef `struct otCoapTxParameters` 이 구조는 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 블록 옵션 SZX 필드를 실제 블록 크기로 변환합니다.
`otCoapMessageAppendBlock1Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)`	`otError` 이 함수는 Block1 옵션을 추가합니다.
`otCoapMessageAppendBlock2Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)`	`otError` 이 함수는 Block2 옵션을 추가합니다.
`otCoapMessageAppendContentFormatOption ( otMessage *aMessage, otCoapOptionContentFormat aContentFormat)`	`otError` 이 함수는 https://tools.ietf.org/html/rfc7252#page-92에 지정된대로 콘텐츠 형식 CoAP 옵션을 추가합니다.
`otCoapMessageAppendMaxAgeOption ( otMessage *aMessage, uint32_t aMaxAge)`	`otError` 이 기능은 Max-Age 옵션을 추가합니다.
`otCoapMessageAppendObserveOption ( otMessage *aMessage, uint32_t aObserve)`	`otError` 이 함수는 관찰 옵션을 추가합니다.
`otCoapMessageAppendOption ( otMessage aMessage, uint16_t aNumber, uint16_t aLength, const void aValue)`	`otError` 이 함수는 헤더에 CoAP 옵션을 추가합니다.
`otCoapMessageAppendProxyUriOption ( otMessage aMessage, const char aUriPath)`	`otError` 이 함수는 Proxy-Uri 옵션을 추가합니다.
`otCoapMessageAppendUintOption ( otMessage *aMessage, uint16_t aNumber, uint32_t aValue)`	`otError` 이 함수는 https://tools.ietf.org/html/rfc7252#section-3.2에 지정된 부호없는 정수 CoAP 옵션을 추가합니다.
`otCoapMessageAppendUriPathOptions ( otMessage aMessage, const char aUriPath)`	`otError` 이 함수는 Uri-Path 옵션을 추가합니다.
`otCoapMessageAppendUriQueryOption ( otMessage aMessage, const char aUriQuery)`	`otError` 이 함수는 단일 Uri-Query 옵션을 추가합니다.
`otCoapMessageCodeToString (const otMessage *aMessage)`	`const char *` 이 메서드는 CoAP 코드를 사람이 읽을 수있는 문자열로 반환합니다.
`otCoapMessageGenerateToken ( otMessage *aMessage, uint8_t aTokenLength)`	`void` 이 함수는 토큰 길이를 설정하고 그 값을 무작위 화합니다.
`otCoapMessageGetCode (const otMessage *aMessage)`	`otCoapCode` 이 함수는 코드 값을 반환합니다.
`otCoapMessageGetMessageId (const otMessage *aMessage)`	`uint16_t` 이 함수는 메시지 ID 값을 반환합니다.
`otCoapMessageGetToken (const otMessage *aMessage)`	`const uint8_t *` 이 함수는 토큰 값에 대한 포인터를 반환합니다.
`otCoapMessageGetTokenLength (const otMessage *aMessage)`	`uint8_t` 이 함수는 토큰 길이를 반환합니다.
`otCoapMessageGetType (const otMessage *aMessage)`	`otCoapType` 이 함수는 유형 값을 반환합니다.
`otCoapMessageInit ( otMessage *aMessage, otCoapType aType, otCoapCode aCode)`	`void` 이 함수는 CoAP 헤더를 초기화합니다.
`otCoapMessageInitResponse ( otMessage aResponse, const otMessage aRequest, otCoapType aType, otCoapCode aCode)`	`otError` 이 함수는 응답 메시지를 초기화합니다.
`otCoapMessageSetPayloadMarker ( otMessage *aMessage)`	`otError` 이 함수는 CoAP 헤더에 페이로드의 시작을 나타내는 페이로드 마커를 추가합니다.
`otCoapMessageSetToken ( otMessage aMessage, const uint8_t aToken, uint8_t aTokenLength)`	`otError` 이 함수는 헤더의 토큰 값과 길이를 설정합니다.
`otCoapNewMessage ( otInstance aInstance, const otMessageSettings aSettings)`	`otMessage *` 이 함수는 새로운 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)`	`otError` 이 함수는 현재 값이 https://tools.ietf.org/html/rfc7252#section-3.2 에 따라 인코딩 된 부호없는 정수라고 가정하고 현재 옵션 값을 `aValue` 채 웁니다.
`otCoapOptionIteratorGetOptionValue ( otCoapOptionIterator aIterator, void aValue)`	`otError` 이 함수는 현재 옵션 값을 `aValue` 채 웁니다.
`otCoapOptionIteratorInit ( otCoapOptionIterator aIterator, const otMessage aMessage)`	`otError` 이 함수는 주어진 메시지의 옵션에 대한 반복자를 초기화합니다.
`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)`	`otError` 이 함수는 CoAP 요청을 보냅니다.
`otCoapSendRequestBlockWise ( otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, otCoapResponseHandler aHandler, void aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)`	`otError` 이 함수는 블록 단위로 CoAP 요청을 보냅니다.
`otCoapSendRequestBlockWiseWithParameters ( otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, otCoapResponseHandler aHandler, void aContext, const otCoapTxParameters *aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)`	`otError` 이 함수는 사용자 지정 전송 매개 변수와 함께 블록 단위로 CoAP 요청을 보냅니다.
`otCoapSendRequestWithParameters ( otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, otCoapResponseHandler aHandler, void aContext, const otCoapTxParameters *aTxParameters)`	`otError` 이 함수는 사용자 지정 전송 매개 변수와 함께 CoAP 요청을 보냅니다.
`otCoapSendResponse ( otInstance aInstance, otMessage aMessage, const otMessageInfo *aMessageInfo)`	`otError` 이 함수는 서버에서 CoAP 응답을 보냅니다.
`otCoapSendResponseBlockWise ( otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, void aContext, otCoapBlockwiseTransmitHook aTransmitHook)`	`otError` 이 함수는 서버에서 블록 단위로 CoAP 응답을 보냅니다.
`otCoapSendResponseBlockWiseWithParameters ( otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, const otCoapTxParameters aTxParameters, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)`	`otError` 이 함수는 사용자 지정 전송 매개 변수를 사용하여 서버에서 블록 단위로 CoAP 응답을 보냅니다.
`otCoapSendResponseWithParameters ( otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, const otCoapTxParameters aTxParameters)`	`otError` 이 함수는 사용자 지정 전송 매개 변수와 함께 서버에서 CoAP 응답을 보냅니다.
`otCoapSetDefaultHandler ( otInstance aInstance, otCoapRequestHandler aHandler, void aContext)`	`void` 이 함수는 처리되지 않은 CoAP 요청에 대한 기본 처리기를 설정합니다.
`otCoapStart ( otInstance *aInstance, uint16_t aPort)`	`otError` 이 기능은 CoAP 서버를 시작합니다.
`otCoapStop ( otInstance *aInstance)`	`otError` 이 기능은 CoAP 서버를 중지합니다.

구조체
otCoapBlockwiseResource	이 구조는 블록 단위 전송이있는 CoAP 리소스를 나타냅니다.
otCoapOption	이 구조는 CoAP 옵션을 나타냅니다.
otCoapOptionIterator	이 구조는 CoAP 옵션에 대한 반복기 역할을합니다.
otCoapResource	이 구조는 CoAP 리소스를 나타냅니다.
otCoapTxParameters	이 구조는 CoAP 전송 매개 변수를 나타냅니다.

열거 형

otCoapBlockSzx

 otCoapBlockSzx

CoAP 블록 크기 지수.

otCoapCode

 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`	응용 프로그램 / 코스; cose-type = "cose-encrypt": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0`	응용 프로그램 / 코스; cose-type = "cose-encrypt0": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY`	애플리케이션 / 코즈 키 : [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET`	애플리케이션 / 코즈 키 세트 : [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC`	응용 프로그램 / 코스; cose-type = "cose-mac": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0`	응용 프로그램 / 코스; cose-type = "cose-mac0": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN`	응용 프로그램 / 코스; cose-type = "cose-sign": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1`	응용 프로그램 / 코스; cose-type = "cose-sign1": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_CWT`	애플리케이션 / cwt : [RFC8392]
`OT_COAP_OPTION_CONTENT_FORMAT_EXI`	application / exi : [ "EXI (Efficient XML Interchange) 형식 1.0 (Second Edition)", 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`	응용 프로그램 / 링크 형식 : [RFC6690]
`OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON`	응용 프로그램 / 병합 패치 + json : [RFC7396]
`OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM`	애플리케이션 / 옥텟 스트림 : [RFC2045] [RFC2046]
`OT_COAP_OPTION_CONTENT_FORMAT_SENML_CBOR`	응용 프로그램 / senml + cbor : [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI`	응용 프로그램 / senml-exi : [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON`	응용 프로그램 / senml + json : [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML`	애플리케이션 / senml + xml : [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_SENSML_CBOR`	응용 프로그램 / sensml + cbor : [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_SENSML_EXI`	애플리케이션 / sensml-exi : [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_SENSML_JSON`	애플리케이션 / sensml + json : [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_SENSML_XML`	애플리케이션 / sensml + xml : [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_TEXT_PLAIN`	텍스트 / 일반; charset = utf-8 : [RFC2046] [RFC3676] [RFC5147]
`OT_COAP_OPTION_CONTENT_FORMAT_XML`	애플리케이션 / 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`	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`	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-Path.
`OT_COAP_OPTION_URI_PORT`	Uri-Port.
`OT_COAP_OPTION_URI_QUERY`	Uri-Query.

otCoapType

 otCoapType

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

속성
`OT_COAP_TYPE_ACKNOWLEDGMENT`	승인.
`OT_COAP_TYPE_CONFIRMABLE`	확인 가능합니다.
`OT_COAP_TYPE_NON_CONFIRMABLE`	확인 불가.
`OT_COAP_TYPE_RESET`	초기화.

Typedef

otCoapBlockSzx

enum otCoapBlockSzx otCoapBlockSzx

CoAP 블록 크기 지수.

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 구성이 활성화 된 경우 사용할 수 있습니다.

세부

매개 변수

`[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`	블록 세그먼트가 없습니다.

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 구현에 문제가 발생할 수 있으므로 첫 번째 블록을받은 후에이 작업을 수행하는 것이 좋습니다.

세부

매개 변수

`[in] aContext`	애플리케이션 특정 컨텍스트에 대한 포인터.
`[in,out] aBlock`	블록 세그먼트를 쓸 수있는 위치에 대한 포인터.
`[in] aPosition`	블록 세그먼트를 가져올 시퀀스의 위치입니다.
`[in,out] aBlockLength`	입력시 최대 블록 세그먼트 길이 (바이트).
`[out] aMore`	더 많은 블록 세그먼트가 뒤따를 경우 플래그에 대한 포인터.

반환 값

`OT_ERROR_NONE`	오류가 발생하지 않았습니다.
`OT_ERROR_INVALID_ARGS`	`aPosition` 에서 `aPosition` 이 존재하지 않습니다.

otCoapCode

enum otCoapCode otCoapCode

CoAP 코드 값.

otCoapOption

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 옵션에 대한 반복기 역할을합니다.

otCoapOptionType

enum otCoapOptionType otCoapOptionType

CoAP 옵션 번호.

otCoapRequestHandler

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

이 함수 포인터는 주어진 Uri-Path가있는 CoAP 요청이 수신 될 때 호출됩니다.

세부

매개 변수

`[in] aContext`	임의의 컨텍스트 정보에 대한 포인터입니다.
`[in] aMessage`	메시지에 대한 포인터.
`[in] aMessageInfo`	`aMessage` 의 메시지 정보에 대한 포인터입니다.

otCoapResource

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 전송 매개 변수를 나타냅니다.

otCoapType

enum otCoapType otCoapType

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

기능

otCoapAddBlockWiseResource

void otCoapAddBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

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

세부

매개 변수

`[in] aInstance`	OpenThread 인스턴스에 대한 포인터입니다.
`[in] aResource`	리소스에 대한 포인터.

otCoapAddResource

void otCoapAddResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

이 기능은 CoAP 서버에 리소스를 추가합니다.

세부

매개 변수

`[in] aInstance`	OpenThread 인스턴스에 대한 포인터입니다.
`[in] aResource`	리소스에 대한 포인터.

otCoapBlockSizeFromExponent

uint16_t otCoapBlockSizeFromExponent(
  otCoapBlockSzx aSize
)

이 기능은 CoAP 블록 옵션 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 옵션 부호없는 정수 값입니다.

반환 값

`OT_ERROR_NONE`	옵션을 성공적으로 추가했습니다.
`OT_ERROR_INVALID_ARGS`	옵션 유형이 마지막 옵션 유형과 같거나 크지 않습니다.
`OT_ERROR_NO_BUFS`	옵션 길이가 버퍼 크기를 초과합니다.

또한보십시오:
otCoapMessageGetOptionUintValue

otCoapMessageAppendUriPathOptions

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

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

세부

매개 변수

`[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-Query 옵션을 추가합니다.

세부

매개 변수

`[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`	설정할 토큰의 길이입니다.

otCoapMessageGetCode

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 메시지에 대한 포인터입니다.

보고

유형 값입니다.

otCoapMessageInit

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
)

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

참고 : 메시지 ID와 토큰은 모두 aRequest 에 따라 설정됩니다.

세부

매개 변수

`[in,out] aResponse`	CoAP 응답 메시지에 대한 포인터입니다.
`[in] aRequest`	CoAP 요청 메시지에 대한 포인터입니다.
`[in] aType`	CoAP 메시지 유형.
`[in] aCode`	CoAP 메시지 코드.

반환 값

`OT_ERROR_NONE`	응답 메시지를 성공적으로 초기화했습니다.
`OT_ERROR_NO_BUFS`	응답 메시지를 초기화하는 데 사용할 수있는 메시지 버퍼가 부족합니다.

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`	토큰 값을 설정하기에 버퍼가 충분하지 않습니다.

otCoapNewMessage

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

이 함수는 새로운 CoAP 메시지를 생성합니다.

참고 : aSettings 가 'NULL'이면 링크 계층 보안이 활성화되고 메시지 우선 순위는 기본적으로 OT_MESSAGE_PRIORITY_NORMAL로 설정됩니다.

세부

매개 변수

`[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`	현재 옵션이 없습니다.

otCoapOptionIteratorInit

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

이 함수는 주어진 메시지의 옵션에 대한 반복자를 초기화합니다.

세부

매개 변수

`[in,out] aIterator`	CoAP 메시지 옵션 반복기에 대한 포인터입니다.
`[in] aMessage`	CoAP 메시지에 대한 포인터입니다.

반환 값

`OT_ERROR_NONE`	성공적으로 초기화되었습니다.
`OT_ERROR_PARSE`	메시지 상태가 일치하지 않습니다.

otCoapRemoveBlockWiseResource

void otCoapRemoveBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

이 함수는 CoAP 서버에서 블록 단위 리소스를 제거합니다.

세부

매개 변수

`[in] aInstance`	OpenThread 인스턴스에 대한 포인터입니다.
`[in] aResource`	리소스에 대한 포인터.

otCoapRemoveResource

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 요청을 보냅니다.

이 기능은 OPENTHREAD_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 요청을 보냅니다.

이 기능은 OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE 구성이 활성화 된 경우 사용할 수 있습니다.

세부

매개 변수

`[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을 사용하십시오. 그렇지 않으면 제공된 매개 변수가 다음 조건을 충족해야합니다. mMaxRetransmit은 OT_COAP_MAX_RETRANSMIT 이하입니다. mAckRandomFactorNumerator / mAckRandomFactorDenominator는 1.0 미만이어야합니다. 계산 된 교환 수명은 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 응답을 보냅니다.

이 기능은 OPENTHREAD_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 응답을 보냅니다.

이 기능은 OPENTHREAD_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 일 수 있습니다.

otCoapStart

otError otCoapStart(
  otInstance *aInstance,
  uint16_t aPort
)

이 기능은 CoAP 서버를 시작합니다.

세부

매개 변수

`[in] aInstance`	OpenThread 인스턴스에 대한 포인터입니다.
`[in] aPort`	바인딩 할 로컬 UDP 포트입니다.

반환 값

`OT_ERROR_NONE`	CoAP 서버를 성공적으로 시작했습니다.
`OT_ERROR_FAILED`	CoAP 서버를 시작하지 못했습니다.

otCoapStop

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 포트.

CoAP

요약

열거 형

Typedef

기능

구조체

열거 형

otCoapBlockSzx

otCoapCode

otCoapOptionContentFormat

otCoapOptionType

otCoapType

Typedef

otCoapBlockSzx

otCoapBlockwiseReceiveHook

otCoapBlockwiseResource

otCoapBlockwiseTransmitHook

otCoapCode

otCoapOption

otCoapOptionContentFormat

otCoapOptionIterator

otCoapOptionType

otCoapRequestHandler

otCoapResource

otCoapResponseHandler

otCoapTxParameters

otCoapType

기능

otCoapAddBlockWiseResource

otCoapAddResource

otCoapBlockSizeFromExponent

otCoapMessageAppendBlock1Option

otCoapMessageAppendBlock2Option

otCoapMessageAppendContentFormatOption

otCoapMessageAppendMaxAgeOption

otCoapMessageAppendObserveOption

otCoapMessageAppendOption

otCoapMessageAppendProxyUriOption

otCoapMessageAppendUintOption

otCoapMessageAppendUriPathOptions

otCoapMessageAppendUriQueryOption

otCoapMessageCodeToString

otCoapMessageGenerateToken

otCoapMessageGetCode

otCoapMessageGetMessageId

otCoapMessageGetToken

otCoapMessageGetTokenLength

otCoapMessageGetType

otCoapMessageInit

otCoapMessageInitResponse

otCoapMessageSetPayloadMarker

otCoapMessageSetToken

otCoapNewMessage

otCoapOptionIteratorGetFirstOption

otCoapOptionIteratorGetFirstOptionMatching

otCoapOptionIteratorGetNextOption

otCoapOptionIteratorGetNextOptionMatching

otCoapOptionIteratorGetOptionUintValue

otCoapOptionIteratorGetOptionValue

otCoapOptionIteratorInit

otCoapRemoveBlockWiseResource

otCoapRemoveResource

otCoapSendRequest

otCoapSendRequestBlockWise

otCoapSendRequestBlockWiseWithParameters

otCoapSendRequestWithParameters

otCoapSendResponse

otCoapSendResponseBlockWise

otCoapSendResponseBlockWiseWithParameters

otCoapSendResponseWithParameters

otCoapSetDefaultHandler

otCoapStart

otCoapStop

매크로

OT_COAP_CODE

OT_COAP_DEFAULT_TOKEN_LENGTH

OT_COAP_MAX_RETRANSMIT

OT_COAP_MAX_TOKEN_LENGTH

OT_COAP_MIN_ACK_TIMEOUT

OT_DEFAULT_COAP_PORT