ot::Cli::Coap class

Implements the CLI CoAP server and client.

Syntax

Show:

Summary

Declaration

from cli_coap.hpp:51

class Coap : private Utils { public: Coap(otInstance *aInstance, OutputImplementer &aOutputImplementer); otError Process(Arg aArgs[]); private: static constexpr uint16_t kMaxUriLength = 32; static constexpr uint16_t kMaxBufferSize = 16; using Command = CommandEntry<Coap>; #if OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE enum BlockType : uint8_t{ kBlockType1, kBlockType2, }; #endif template <CommandId kCommandId> otError Process(Arg aArgs[]); #if OPENTHREAD_CONFIG_COAP_OBSERVE_API_ENABLE otError CancelResourceSubscription(void); void CancelSubscriber(void); #endif void PrintPayload(otMessage *aMessage); #if OPENTHREAD_CONFIG_COAP_OBSERVE_API_ENABLE otError ProcessRequest(Arg aArgs[], otCoapCode aCoapCode, bool aCoapObserve = false); #else otError ProcessRequest(Arg aArgs[], otCoapCode aCoapCode); #endif static void HandleRequest(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo); void HandleRequest(otMessage *aMessage, const otMessageInfo *aMessageInfo); #if OPENTHREAD_CONFIG_COAP_OBSERVE_API_ENABLE static void HandleNotificationResponse(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aError); void HandleNotificationResponse(otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aError); #endif static void HandleResponse(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aError); void HandleResponse(otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aError); #if OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE static otError BlockwiseReceiveHook(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength); otError BlockwiseReceiveHook(const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength); static otError BlockwiseTransmitHook(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore); otError BlockwiseTransmitHook(uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore); #endif const otCoapTxParameters *GetRequestTxParameters(void) const { return mUseDefaultRequestTxParameters ? nullptr : &mRequestTxParameters; } const otCoapTxParameters *GetResponseTxParameters(void) const { return mUseDefaultResponseTxParameters ? nullptr : &mResponseTxParameters; } bool mUseDefaultRequestTxParameters; bool mUseDefaultResponseTxParameters; otCoapTxParameters mRequestTxParameters; otCoapTxParameters mResponseTxParameters; #if OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE otCoapBlockwiseResource mResource; #else otCoapResource mResource; #endif #if OPENTHREAD_CONFIG_COAP_OBSERVE_API_ENABLE otIp6Address mRequestAddr; otSockAddr mSubscriberSock; char mRequestUri[kMaxUriLength]; uint8_t mRequestToken[OT_COAP_MAX_TOKEN_LENGTH]; uint8_t mSubscriberToken[OT_COAP_MAX_TOKEN_LENGTH]; #endif char mUriPath[kMaxUriLength]; char mResourceContent[kMaxBufferSize]; #if OPENTHREAD_CONFIG_COAP_OBSERVE_API_ENABLE uint32_t mObserveSerial; uint8_t mRequestTokenLength; uint8_t mSubscriberTokenLength; bool mSubscriberConfirmableNotifications; #endif #if OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE uint32_t mBlockCount; #endif };

Fields

Field

Declared as

ot::Cli::Coap::mUseDefaultRequestTxParameters

bool

ot::Cli::Coap::mUseDefaultResponseTxParameters

bool

ot::Cli::Coap::mRequestTxParameters

otCoapTxParameters

ot::Cli::Coap::mResponseTxParameters

otCoapTxParameters

ot::Cli::Coap::mResource

otCoapResource

ot::Cli::Coap::mUriPath

char[kMaxUriLength]

ot::Cli::Coap::mResourceContent

char[kMaxBufferSize]

ot::Cli::Coap::kMaxUriLength

ot::Cli::Coap::kMaxBufferSize

Methods

HandleResponse()

GetRequestTxParameters() const

GetResponseTxParameters() const

Process()

@cli coap delete

 coap delete fdde:ad00:beef:0:2780:9423:166c:1aac test-resource con hellothere
 Done
 

@cparam coap delete @ca{address} @ca{uri-path} [@ca{type}] [@ca{payload}] * `address`: IPv6 address of the CoAP server. * `uri-path`: URI path of the resource. * `type`: * `con`: Confirmable * `non-con`: Non-confirmable (default) * `payload`: The CoAP payload string. For example, `hellothere`. @par Deletes the specified CoAP resource.