Symbols

Files

Summary Syntax Arguments References Call Tree Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Coap::Option::Iterator::ReadOptionValue() const

ot::Coap::Option::Iterator::ReadOptionValue() const method

Reads the current Option Value into a given buffer.

Syntax

Show:

Summary

Declaration

Definition

from coap_message.hpp:1108

Error ReadOptionValue(void *aValue) const;

Implemented in coap_message.cpp:570

Arguments

Argument

Description

aValue

The pointer to a buffer to copy the Option Value. The buffer is assumed to be sufficiently large (i.e. at least `GetOption()->GetLength()` bytes).

Return value

kErrorNone Successfully read and copied the Option Value into given buffer. kErrorNotFound Iterator is done (not pointing to any option).

References

Code

Location

Scope

Referrer

Error Option::Iterator::ReadOptionValue(void *aValue) const

coap_message.cpp:570

Error Option::Iterator::ReadOptionValue(uint64_t &aUintValue) const

coap_message.cpp:581

Error ReadOptionValue(void *aValue) const;

coap_message.hpp:1108

Error ReadOptionValue(uint64_t &aUintValue) const;

coap_message.hpp:1119

IgnoreError(iterator.ReadOptionValue(curUriPath));

coap_message.cpp:258

ot::Coap::Message

ot::Coap::Message::ReadUriPathOptions() const

IgnoreError(ReadOptionValue(buffer));

coap_message.cpp:589

ot::Coap::Option::Iterator

ot::Coap::Option::Iterator::ReadOptionValue() const

Call Tree

ot::Coap::Option::Iterator::ReadOptionValue() const is called by 2 functions and calls 4 functions:

ot::Coap::Message::ReadUriPathOptions() const

ot::Coap::Option::Iterator::ReadOptionValue() const

ot::Coap::Option::Iterator::IsDone() const

ot::Coap::Option::Iterator::GetMessage() const

IgnoreError()

ot::Coap::Option::Iterator::ReadOptionValue() const

Data Use

ot::Coap::Option::Iterator::ReadOptionValue() const reads 7 variables:

ot::kErrorNone

ot::kErrorNotFound

otCoapOption::mLength

otCoapOptionIterator::mOption

otCoapOptionIterator::mNextOptionOffset

ot::kErrorNoBufs

ot::kBitsPerByte

ot::Coap::Option::Iterator::ReadOptionValue() const

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Lifecycle

All items filtered out