Symbols

Files

loading (2/5)...

Summary Syntax Methods Related References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Coap::CoapBase

ot::Coap::CoapBase class

Implements the CoAP client and server.

Syntax

Show:

Summary

Declaration

from coap.hpp:338

class CoapBase : public InstanceLocator, private NonCopyable { friend class ResponsesQueue; public: #if OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE static constexpr uint16_t kMaxBlockLength = OPENTHREAD_CONFIG_COAP_MAX_BLOCK_LENGTH; #endif typedef Error (*Interceptor)(const Message &aMessage, const Ip6::MessageInfo &aMessageInfo, void *aContext); void ClearRequestsAndResponses(void); void ClearRequests(const Ip6::Address &aAddress); #if OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE void AddBlockWiseResource(ResourceBlockWise &aResource); void RemoveBlockWiseResource(ResourceBlockWise &aResource); #endif void AddResource(Resource &aResource); void RemoveResource(Resource &aResource); void SetDefaultHandler(RequestHandler aHandler, void *aContext) { mDefaultHandler.Set(aHandler, aContext); } Message *NewMessage(const Message::Settings &aSettings); Message *NewMessage(void); Message *NewPriorityMessage(void); Message *NewPriorityConfirmablePostMessage(Uri aUri); Message *NewConfirmablePostMessage(Uri aUri); Message *NewPriorityNonConfirmablePostMessage(Uri aUri); Message *NewNonConfirmablePostMessage(Uri aUri); Message *NewPriorityResponseMessage(const Message &aRequest); Message *NewResponseMessage(const Message &aRequest); #if OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE Error SendMessage(Message &aMessage, const Ip6::MessageInfo &aMessageInfo, const TxParameters &aTxParameters, otCoapResponseHandler aHandler = nullptr, void *aContext = nullptr, otCoapBlockwiseTransmitHook aTransmitHook = nullptr, otCoapBlockwiseReceiveHook aReceiveHook = nullptr); #else Error SendMessage(Message &aMessage, const Ip6::MessageInfo &aMessageInfo, const TxParameters &aTxParameters, ResponseHandler aHandler, void *aContext); #endif Error SendMessage(Message &aMessage, const Ip6::MessageInfo &aMessageInfo, const TxParameters &aTxParameters); Error SendMessage(Message &aMessage, const Ip6::MessageInfo &aMessageInfo, ResponseHandler aHandler, void *aContext); Error SendMessage(Message &aMessage, const Ip6::MessageInfo &aMessageInfo); Error SendReset(Message &aRequest, const Ip6::MessageInfo &aMessageInfo); Error SendHeaderResponse(Message::Code aCode, const Message &aRequest, const Ip6::MessageInfo &aMessageInfo); Error SendAck(const Message &aRequest, const Ip6::MessageInfo &aMessageInfo); Error SendEmptyAck(const Message &aRequest, const Ip6::MessageInfo &aMessageInfo, Code aCode); Error SendEmptyAck(const Message &aRequest, const Ip6::MessageInfo &aMessageInfo); Error SendNotFound(const Message &aRequest, const Ip6::MessageInfo &aMessageInfo); #if OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE Error SendRequestEntityIncomplete(const Message &aRequest, const Ip6::MessageInfo &aMessageInfo) { return SendHeaderResponse(kCodeRequestIncomplete, aRequest, aMessageInfo); } #endif Error AbortTransaction(ResponseHandler aHandler, void *aContext); void SetInterceptor(Interceptor aInterceptor, void *aContext) { mInterceptor.Set(aInterceptor, aContext); } const MessageQueue &GetRequestMessages(void) const { return mPendingRequests; } const MessageQueue &GetCachedResponses(void) const { return mResponsesQueue.GetResponses(); } protected: typedef bool (*ResourceHandler)(CoapBase &aCoapBase, const char *aUriPath, Message &aMessage, const Ip6::MessageInfo &aMessageInfo); typedef Error (*Sender)(CoapBase &aCoapBase, ot::Message &aMessage, const Ip6::MessageInfo &aMessageInfo); CoapBase(Instance &aInstance, Sender aSender); void Receive(ot::Message &aMessage, const Ip6::MessageInfo &aMessageInfo); void SetResourceHandler(ResourceHandler aHandler) { mResourceHandler = aHandler; } private: struct Metadata : public Message::FooterData<Metadata> { Ip6::Address mSourceAddress; Ip6::Address mDestinationAddress; uint16_t mDestinationPort; ResponseHandler mResponseHandler; void *mResponseContext; TimeMilli mNextTimerShot; uint32_t mRetransmissionTimeout; uint8_t mRetransmissionsRemaining; #if OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE uint8_t mHopLimit; #endif bool mAcknowledged : 1; bool mConfirmable : 1; bool mMulticastLoop : 1; #if OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE bool mIsHostInterface : 1; #endif #if OPENTHREAD_CONFIG_COAP_OBSERVE_API_ENABLE bool mObserve : 1; #endif #if OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE otCoapBlockwiseReceiveHook mBlockwiseReceiveHook; otCoapBlockwiseTransmitHook mBlockwiseTransmitHook; #endif }; Message *InitMessage(Message *aMessage, Type aType, Uri aUri); Message *InitResponse(Message *aMessage, const Message &aRequest); static void HandleRetransmissionTimer(Timer &aTimer); void HandleRetransmissionTimer(void); void ClearRequests(const Ip6::Address *aAddress); Message *CopyAndEnqueueMessage(const Message &aMessage, uint16_t aCopyLength, const Metadata &aMetadata); void DequeueMessage(Message &aMessage); Message *FindRelatedRequest(const Message &aResponse, const Ip6::MessageInfo &aMessageInfo, Metadata &aMetadata); void FinalizeCoapTransaction(Message &aRequest, const Metadata &aMetadata, Message *aResponse, const Ip6::MessageInfo *aMessageInfo, Error aResult); #if OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE void FreeLastBlockResponse(void); Error CacheLastBlockResponse(Message *aResponse); Error PrepareNextBlockRequest(Message::BlockType aType, bool aMoreBlocks, Message &aRequestOld, Message &aRequest, Message &aMessage); Error ProcessBlock1Request(Message &aMessage, const Ip6::MessageInfo &aMessageInfo, const ResourceBlockWise &aResource, uint32_t aTotalLength); Error ProcessBlock2Request(Message &aMessage, const Ip6::MessageInfo &aMessageInfo, const ResourceBlockWise &aResource); #endif void ProcessReceivedRequest(Message &aMessage, const Ip6::MessageInfo &aMessageInfo); void ProcessReceivedResponse(Message &aMessage, const Ip6::MessageInfo &aMessageInfo); #if OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE Error SendNextBlock1Request(Message &aRequest, Message &aMessage, const Ip6::MessageInfo &aMessageInfo, const Metadata &aCoapMetadata); Error SendNextBlock2Request(Message &aRequest, Message &aMessage, const Ip6::MessageInfo &aMessageInfo, const Metadata &aCoapMetadata, uint32_t aTotalLength, bool aBeginBlock1Transfer); #endif void SendCopy(const Message &aMessage, const Ip6::MessageInfo &aMessageInfo); Error SendEmptyMessage(Type aType, const Message &aRequest, const Ip6::MessageInfo &aMessageInfo); Error Send(ot::Message &aMessage, const Ip6::MessageInfo &aMessageInfo); MessageQueue mPendingRequests; uint16_t mMessageId; TimerMilliContext mRetransmissionTimer; LinkedList<Resource> mResources; Callback<Interceptor> mInterceptor; ResponsesQueue mResponsesQueue; Callback<RequestHandler> mDefaultHandler; ResourceHandler mResourceHandler; const Sender mSender; #if OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE LinkedList<ResourceBlockWise> mBlockWiseResources; Message *mLastResponse; #endif };

Fields

Field

Declared as

ot::Coap::CoapBase::mPendingRequests

MessageQueue

ot::Coap::CoapBase::mMessageId

uint16_t

ot::Coap::CoapBase::mRetransmissionTimer

TimerMilliContext

ot::Coap::CoapBase::mResources

LinkedList<Resource>

ot::Coap::CoapBase::mInterceptor

Callback<Interceptor>

ot::Coap::CoapBase::mResponsesQueue

ResponsesQueue

ot::Coap::CoapBase::mDefaultHandler

Callback<RequestHandler>

ot::Coap::CoapBase::mResourceHandler

ResourceHandler

ot::Coap::CoapBase::mSender

const Sender

Methods

ClearRequestsAndResponses()

Clears requests and responses used by this CoAP agent.

ClearRequests()

Clears requests with specified source address used by this CoAP agent.

AddResource()

Adds a resource to the CoAP server.

RemoveResource()

Removes a resource from the CoAP server.

SetDefaultHandler()

NewMessage()

Allocates a new message with a CoAP header.

NewMessage()

Allocates a new message with a CoAP header.

NewPriorityMessage()

Allocates a new message with a CoAP header that has Network Control priority level.

NewPriorityConfirmablePostMessage()

Allocates and initializes a new CoAP Confirmable Post message with Network Control priority level. The CoAP header is initialized as `kTypeConfirmable` and `kCodePost` with a given URI path and a randomly generated token (of default length). This method also sets the payload marker (`SetPayloadMarker()` on message. Even if message has no payload, calling `SetPayloadMarker()` is harmless, since `SendMessage()` will check and remove the payload marker when there is no payload.

NewConfirmablePostMessage()

Allocates and initializes a new CoAP Confirmable Post message with normal priority level. The CoAP header is initialized as `kTypeConfirmable` and `kCodePost` with a given URI and a randomly generated token (of default length). This method also sets the payload marker (calling `SetPayloadMarker()`). Even if message has no payload, calling `SetPayloadMarker()` is harmless, since `SendMessage()` will check and remove the payload marker when there is no payload.

NewPriorityNonConfirmablePostMessage()

Allocates and initializes a new CoAP Non-confirmable Post message with Network Control priority level. The CoAP header is initialized as `kTypeNonConfirmable` and `kCodePost` with a given URI and a randomly generated token (of default length). This method also sets the payload marker (calling `SetPayloadMarker()`). Even if message has no payload, calling `SetPayloadMarker()` is harmless, since `SendMessage()` will check and remove the payload marker when there is no payload.

NewNonConfirmablePostMessage()

Allocates and initializes a new CoAP Non-confirmable Post message with normal priority level. The CoAP header is initialized as `kTypeNonConfirmable` and `kCodePost` with a given URI and a randomly generated token (of default length). This method also sets the payload marker (calling `SetPayloadMarker()`). Even if message has no payload, calling `SetPayloadMarker()` is harmless, since `SendMessage()` will check and remove the payload marker when there is no payload.

NewPriorityResponseMessage()

Allocates and initializes a new CoAP response message with Network Control priority level for a given request message. The CoAP header is initialized as `kTypeAck` with `kCodeChanged`. The token and message ID is copied from @p aRequest. This method also sets the payload marker (calling `SetPayloadMarker()`). Even if message has no payload, calling `SetPayloadMarker()` is harmless, since `SendMessage()` will check and remove the payload marker when there is no payload.

NewResponseMessage()

Allocates and initializes a new CoAP response message with regular priority level for a given request message. The CoAP header is initialized as `kTypeAck` with `kCodeChanged`. The token and message ID is copied from @p aRequest. This method also sets the payload marker (calling `SetPayloadMarker()`). Even if message has no payload, calling `SetPayloadMarker()` is harmless, since `SendMessage()` will check and remove the payload marker when there is no payload.

SendMessage()

Sends a CoAP message with custom transmission parameters. If a response for a request is expected, respective function and context information should be provided. If no response is expected, these arguments should be `nullptr` pointers. If Message ID was not set in the header (equal to 0), this method will assign unique Message ID to the message.