SDK  23.9.2
For IoT System Software Development
Classes | Public Member Functions | List of all members
CoAPRequest Class Reference

CoAP 서버로 요청을 보내기 위한 클래스 More...

#include <CoAPRequest.hpp>

Inheritance diagram for CoAPRequest:
CoAP

Classes

struct  ResponseInfo_t
 CoAP response 정보 More...
 

Public Member Functions

error_t open (Method_t method, const char *uri, const char *token, IPv6Interface *interface)
 CoAP request의 세부 사항을 지정합니다. More...
 
error_t open (Method_t method, const char *uri)
 
error_t open (Method_t method, const char *uri, const char *token)
 
error_t open (Method_t method, const char *uri, IPv6Interface *interface)
 
void onResponse (void(*handler)(CoAPRequest &req, const ResponseInfo_t *response))
 CoAP request에 대한 response 콜백함수를 지정합니다. More...
 
error_t send (Media_t media=MEDIA_TEXT_PLAIN, const uint8_t *payload=NULL, uint16_t payloadLength=0)
 CoAP request를 payload와 함께 전송합니다. More...
 
error_t send (Media_t media, const char *payload, uint16_t payloadLength)
 

Additional Inherited Members

- Public Types inherited from CoAP
enum  Media_t {
  MEDIA_TEXT_PLAIN = 0, MEDIA_APP_COSE_ENC0 = 16, MEDIA_APP_COSE_MAC0 = 17, MEDIA_APP_COSE_SIGN1 = 18,
  MEDIA_APP_LINK_FORMAT = 40, MEDIA_APP_XML = 41, MEDIA_APP_OCTET_STREAM = 42, MEDIA_APP_EXI = 47,
  MEDIA_APP_JSON = 50, MEDIA_APP_JSON_PATCH_JSON = 51, MEDIA_APP_MERGE_PATCH_JSON = 52, MEDIA_APP_CBOR = 60,
  MEDIA_APP_CWT = 61, MEDIA_APP_COSE_ENC = 96, MEDIA_APP_COSE_MAC = 97, MEDIA_APP_COSE_SIGN = 98,
  MEDIA_APP_COSE_KEY = 101, MEDIA_APP_COSE_KEY_SET = 102, MEDIA_APP_SENML_JSON = 110, MEDIA_APP_SENSML_JSON = 111,
  MEDIA_APP_SENML_CBOR = 112, MEDIA_APP_SENSML_CBOR = 113, MEDIA_APP_SENML_EXI = 114, MEDIA_APP_SENSML_EXI = 115,
  MEDIA_APP_COAP_GROUP_JSON = 116, MEDIA_APP_SENML_XML = 310, MEDIA_APP_SENSML_XML = 311, MEDIA_APP_VND_OCF_CBOR = 10000,
  MEDIA_APP_VND_OMA_LWM2M_TLV = 11542, MEDIA_APP_VND_OMA_LWM2M_JSON = 11543
}
 Media type (content format) More...
 
enum  Method_t { GET = 1, POST = 2, PUT = 3, DELETE = 4 }
 Method type. More...
 

Detailed Description

CoAP 서버로 요청을 보내기 위한 클래스

Member Function Documentation

◆ onResponse()

void CoAPRequest::onResponse ( void(*)(CoAPRequest &req, const ResponseInfo_t *response)  handler)

CoAP request에 대한 response 콜백함수를 지정합니다.

Parameters
handler콜백함수 포인터. 콜백함수는 다음 2개의 파라미터를 전달합니다.
  • CoAP request의 참조자
  • Response information의 포인터: 응답을 받지 못한 경우 NULL

◆ open()

error_t CoAPRequest::open ( Method_t  method,
const char *  uri,
const char *  token,
IPv6Interface interface 
)

CoAP request의 세부 사항을 지정합니다.

Parameters
methodRequest의 method
uriRequest의 URI
tokenRequest의 token
interfaceRequest를 보낼 IPv6 인터페이스 (IPv6 주소가 IPv6Address::TYPE_GLOBAL이 아닌 경우 사용)

◆ send()

error_t CoAPRequest::send ( Media_t  media = MEDIA_TEXT_PLAIN,
const uint8_t *  payload = NULL,
uint16_t  payloadLength = 0 
)

CoAP request를 payload와 함께 전송합니다.

Parameters
mediapayload의 media type. Payload가 생략될 때는 무시됩니다.
payload전송할 payload. Payload를 생략할 때는 NULL로 지정합니다.
payloadLength전송할 payload의 길이

파라미터들을 지정하지 않으면 payload 없이 전송합니다.

Member Data Documentation

◆ m

unsigned int CoAPRequest::m

1 if more blocks follow, 0 otherwise

◆ num

unsigned int CoAPRequest::num

block number

◆ szx

unsigned int CoAPRequest::szx

block size


The documentation for this class was generated from the following file: