ot::Ip6::Udp - syntax, references, description

Methods

AddReceiver()

Adds a UDP receiver.

RemoveReceiver()

Removes a UDP receiver.

Open()

Opens a UDP socket.

IsOpen() const

Returns if a UDP socket is open.

Bind()

Binds a UDP socket.

Connect()

Connects a UDP socket.

Close()

Closes the UDP socket.

SendTo()

Sends a UDP message using a socket.

GetEphemeralPort()

Returns a new ephemeral port.

NewMessage()

Returns a new UDP message with default settings (link security enabled and `kPriorityNormal`).

NewMessage()

Returns a new UDP message with default settings (link security enabled and `kPriorityNormal`).

NewMessage()

Returns a new UDP message with default settings (link security enabled and `kPriorityNormal`).

SendDatagram()

Sends an IPv6 datagram.

HandleMessage()

Handles a received UDP message.

HandlePayload()

Handles a received UDP message with offset set to the payload.

GetUdpSockets()

Returns the head of UDP Sockets list.

IsPortInUse() const

Returns whether a udp port is being used by OpenThread or any of it's optional features, e.g. CoAP API.

ShouldUsePlatformUdp() const

Returns whether a udp port belongs to the platform or the stack.

IsPortReserved()

AddSocket()

RemoveSocket()

ShouldUsePlatformUdp() const

Returns whether a udp port belongs to the platform or the stack.

SetBackboneSocket()

GetBackboneSockets() const

IsBackboneSocket() const

ShouldUsePlatformUdp() const

Returns whether a udp port belongs to the platform or the stack.

References

Code

Location

Scope

Referrer

class Udp : public InstanceLocator, private NonCopyable

udp6.hpp:81

using Udp = Ip6::Udp; // UDP in IPv4 is the same as UDP in IPv6

ip4_types.hpp:653

class Udp;

udp6.hpp:53

VerifyOrExit((message = Get<Ip6::Udp>().NewMessage()) != nullptr, error = kErrorNoBufs);

border_agent.cpp:356

ot::MeshCoP::BorderAgent::HandleTmf()

SuccessOrExit(error = Get<Ip6::Udp>().SendDatagram(*message, messageInfo));

border_agent.cpp:365

ot::MeshCoP::BorderAgent::HandleTmf()

Ip6::Udp::Receiver mUdpReceiver;

border_agent.hpp:325

headerOffset = Ip6::Udp::Header::kChecksumFieldOffset;

checksum.cpp:183

ot::Checksum::UpdateMessageChecksum()

headerOffset = Ip4::Udp::Header::kChecksumFieldOffset;

checksum.cpp:218

ot::Checksum::UpdateMessageChecksum()

VerifyOrExit((message = AsCoapMessagePtr(Get<Ip6::Udp>().NewMessage(0, aSettings))) != nullptr);

coap.cpp:101

ot::Coap::CoapBase::NewMessage()

sizeof(Ip6::Udp::Header),

coap_message.hpp:906

template <> inline Ip6::Udp &Instance::Get(void) { return mIp6.mUdp; }

instance.hpp:871

ot::Instance

ot::Instance::Get()

using Udp = Ip6::Udp; // UDP in IPv4 is the same as UDP in IPv6

ip4_types.hpp:653

ot::Ip4::Udp

Udp::Header udp;

ip6.cpp:972

ot::Ip6::Ip6::PassToHost()

VerifyOrExit(Get<Udp>().ShouldUsePlatformUdp(udp.GetDestinationPort()) &&

ip6.cpp:975

ot::Ip6::Ip6::PassToHost()

!Get<Udp>().IsPortInUse(udp.GetDestinationPort()),

ip6.cpp:976

ot::Ip6::Ip6::PassToHost()

Udp::Header udpHeader;

ip6.cpp:1228

ot::Ip6::Ip6::HandleDatagram()

Udp mUdp;

ip6.hpp:398

ot::Ip6::Ip6

ot::Ip6::Ip6::mUdp

const Udp::Header &GetUdpHeader(void) const { return mHeader.mUdp; }

ip6.hpp:521

ot::Ip6::Headers::GetUdpHeader() const

Udp::Header mUdp;

ip6.hpp:566

Ip6::Udp::Header udpHeader;

lowpan.cpp:505

ot::Lowpan::Lowpan::CompressUdp()

SuccessOrExit(error = aFrameBuilder.AppendBytes(&udpHeader, Ip6::Udp::Header::kLengthFieldOffset));

lowpan.cpp:534

ot::Lowpan::Lowpan::CompressUdp()

Error Lowpan::DecompressUdpHeader(Ip6::Udp::Header &aUdpHeader, FrameData &aFrameData)

lowpan.cpp:877

ot::Lowpan::Lowpan::DecompressUdpHeader()

Ip6::Udp::Header udpHeader;

lowpan.cpp:941

ot::Lowpan::Lowpan::DecompressUdpHeader()

Error DecompressUdpHeader(Ip6::Udp::Header &aUdpHeader, FrameData &aFrameData);

lowpan.hpp:179

length = info.mMessage->GetLength() + sizeof(Ip6::Udp::Header) + sizeof(Ip6::Header);

srp_client.cpp:1000

ot::Srp::Client::SendUpdate()

static constexpr uint16_t kUdpPayloadSize = Ip6::kMaxDatagramLength - sizeof(Ip6::Udp::Header);

srp_client.hpp:761

Ip6::Udp::Socket &dnsSocket = Get<Dns::ServiceDiscovery::Server>().mSocket;

srp_server.cpp:647

ot::Srp::Server::PrepareSocket()

Ip6::Udp::Socket &Server::GetSocket(void)

srp_server.cpp:675

ot::Srp::Server::GetSocket()

Ip6::Udp::Socket *socket = &mSocket;

srp_server.cpp:677

ot::Srp::Server::GetSocket()

Ip6::Udp::Socket &dnsSocket = Get<Dns::ServiceDiscovery::Server>().mSocket;

srp_server.cpp:680

ot::Srp::Server::GetSocket()

signerNameMessage = Get<Ip6::Udp>().NewMessage();

srp_server.cpp:1316

ot::Srp::Server::VerifySignature() const

static constexpr uint16_t kUdpPayloadSize = Ip6::kMaxDatagramLength - sizeof(Ip6::Udp::Header);

srp_server.hpp:835

Ip6::Udp::Socket &GetSocket(void);

srp_server.hpp:911

bool Udp::SocketHandle::Matches(const MessageInfo &aMessageInfo) const

udp6.cpp:44

ot::Ip6::Udp::SocketHandle::Matches() const

Udp::Socket::Socket(Instance &aInstance, ReceiveHandler aHandler, void *aContext)

udp6.cpp:71

ot::Ip6::Udp::Socket::Socket()

Message *Udp::Socket::NewMessage(void) { return NewMessage(0); }

udp6.cpp:79

ot::Ip6::Udp::Socket::NewMessage()

Message *Udp::Socket::NewMessage(uint16_t aReserved) { return NewMessage(aReserved, Message::Settings::GetDefault()); }

udp6.cpp:81

ot::Ip6::Udp::Socket::NewMessage()

Message *Udp::Socket::NewMessage(uint16_t aReserved, const Message::Settings &aSettings)

udp6.cpp:83

ot::Ip6::Udp::Socket::NewMessage()

return Get<Udp>().NewMessage(aReserved, aSettings);

udp6.cpp:85

ot::Ip6::Udp::Socket::NewMessage()

Error Udp::Socket::Open(void) { return Get<Udp>().Open(*this, mHandler, mContext); }

udp6.cpp:88

ot::Ip6::Udp::Socket::Open()

bool Udp::Socket::IsOpen(void) const { return Get<Udp>().IsOpen(*this); }

udp6.cpp:90

ot::Ip6::Udp::Socket::IsOpen() const

Error Udp::Socket::Bind(const SockAddr &aSockAddr, NetifIdentifier aNetifIdentifier)

udp6.cpp:92

ot::Ip6::Udp::Socket::Bind()

return Get<Udp>().Bind(*this, aSockAddr, aNetifIdentifier);

udp6.cpp:94

ot::Ip6::Udp::Socket::Bind()

Error Udp::Socket::Bind(uint16_t aPort, NetifIdentifier aNetifIdentifier)

udp6.cpp:97

ot::Ip6::Udp::Socket::Bind()

Error Udp::Socket::Connect(const SockAddr &aSockAddr) { return Get<Udp>().Connect(*this, aSockAddr); }

udp6.cpp:102

ot::Ip6::Udp::Socket::Connect()

Error Udp::Socket::Connect(uint16_t aPort) { return Connect(SockAddr(aPort)); }

udp6.cpp:104

ot::Ip6::Udp::Socket::Connect()

Error Udp::Socket::Close(void) { return Get<Udp>().Close(*this); }

udp6.cpp:106

ot::Ip6::Udp::Socket::Close()

Error Udp::Socket::SendTo(Message &aMessage, const MessageInfo &aMessageInfo)

udp6.cpp:108

ot::Ip6::Udp::Socket::SendTo()

return Get<Udp>().SendTo(*this, aMessage, aMessageInfo);

udp6.cpp:110

ot::Ip6::Udp::Socket::SendTo()

Error Udp::Socket::JoinNetifMulticastGroup(NetifIdentifier aNetifIdentifier, const Address &aAddress)

udp6.cpp:114

ot::Ip6::Udp::Socket::JoinNetifMulticastGroup()

Error Udp::Socket::LeaveNetifMulticastGroup(NetifIdentifier aNetifIdentifier, const Address &aAddress)

udp6.cpp:131

ot::Ip6::Udp::Socket::LeaveNetifMulticastGroup()

Udp::Udp(Instance &aInstance)

udp6.cpp:152

ot::Ip6::Udp::Udp()

Error Udp::AddReceiver(Receiver &aReceiver) { return mReceivers.Add(aReceiver); }

udp6.cpp:161

ot::Ip6::Udp::AddReceiver()

Error Udp::RemoveReceiver(Receiver &aReceiver)

udp6.cpp:163

ot::Ip6::Udp::RemoveReceiver()

Error Udp::Open(SocketHandle &aSocket, ReceiveHandler aHandler, void *aContext)

udp6.cpp:174

ot::Ip6::Udp::Open()

Error Udp::Bind(SocketHandle &aSocket, const SockAddr &aSockAddr, NetifIdentifier aNetifIdentifier)

udp6.cpp:195

ot::Ip6::Udp::Bind()

void Udp::SetBackboneSocket(SocketHandle &aSocket)

udp6.cpp:239

ot::Ip6::Udp::SetBackboneSocket()

const Udp::SocketHandle *Udp::GetBackboneSockets(void) const

udp6.cpp:253

ot::Ip6::Udp::GetBackboneSockets() const

bool Udp::IsBackboneSocket(const SocketHandle &aSocket) const

udp6.cpp:258

ot::Ip6::Udp::IsBackboneSocket() const

Error Udp::Connect(SocketHandle &aSocket, const SockAddr &aSockAddr)

udp6.cpp:275

ot::Ip6::Udp::Connect()

Error Udp::Close(SocketHandle &aSocket)

udp6.cpp:297

ot::Ip6::Udp::Close()

Error Udp::SendTo(SocketHandle &aSocket, Message &aMessage, const MessageInfo &aMessageInfo)

udp6.cpp:316

ot::Ip6::Udp::SendTo()

bool Udp::IsPortReserved(uint16_t aPort)

udp6.cpp:366

ot::Ip6::Udp::IsPortReserved()

void Udp::AddSocket(SocketHandle &aSocket)

udp6.cpp:371

ot::Ip6::Udp::AddSocket()

void Udp::RemoveSocket(SocketHandle &aSocket)

udp6.cpp:385

ot::Ip6::Udp::RemoveSocket()

uint16_t Udp::GetEphemeralPort(void)

udp6.cpp:405

ot::Ip6::Udp::GetEphemeralPort()

Message *Udp::NewMessage(void) { return NewMessage(0); }

udp6.cpp:422

ot::Ip6::Udp::NewMessage()

Message *Udp::NewMessage(uint16_t aReserved) { return NewMessage(aReserved, Message::Settings::GetDefault()); }

udp6.cpp:424

ot::Ip6::Udp::NewMessage()

Message *Udp::NewMessage(uint16_t aReserved, const Message::Settings &aSettings)

udp6.cpp:426

ot::Ip6::Udp::NewMessage()

Error Udp::SendDatagram(Message &aMessage, MessageInfo &aMessageInfo)

udp6.cpp:431

ot::Ip6::Udp::SendDatagram()

Error Udp::HandleMessage(Message &aMessage, MessageInfo &aMessageInfo)

udp6.cpp:462

ot::Ip6::Udp::HandleMessage()

void Udp::HandlePayload(Message &aMessage, MessageInfo &aMessageInfo)

udp6.cpp:492

ot::Ip6::Udp::HandlePayload()

bool Udp::IsPortInUse(uint16_t aPort) const

udp6.cpp:528

ot::Ip6::Udp::IsPortInUse() const

bool Udp::ShouldUsePlatformUdp(uint16_t aPort) const

udp6.cpp:544

ot::Ip6::Udp::ShouldUsePlatformUdp() const

bool Udp::ShouldUsePlatformUdp(const Udp::SocketHandle &aSocket) const

udp6.cpp:566

ot::Ip6::Udp::ShouldUsePlatformUdp() const

friend class Udp;

udp6.hpp:91

friend class Udp;

udp6.hpp:145

friend class Udp;

udp6.hpp:335

DefineCoreType(otUdpSocket, Ip6::Udp::SocketHandle);

udp6.hpp:669

DefineCoreType(otUdpReceiver, Ip6::Udp::Receiver);

udp6.hpp:670

return AsCoreType(aInstance).Get<Ip6::Udp>().NewMessage(0, Message::Settings::From(aSettings));

udp_api.cpp:42

otUdpNewMessage()

return AsCoreType(aInstance).Get<Ip6::Udp>().Open(AsCoreType(aSocket), aCallback, aContext);

udp_api.cpp:47

otUdpOpen()

return AsCoreType(aInstance).Get<Ip6::Udp>().IsOpen(AsCoreType(aSocket));

udp_api.cpp:52

otUdpIsOpen()

return AsCoreType(aInstance).Get<Ip6::Udp>().Close(AsCoreType(aSocket));

udp_api.cpp:57

otUdpClose()

return AsCoreType(aInstance).Get<Ip6::Udp>().Bind(AsCoreType(aSocket), AsCoreType(aSockName), MapEnum(aNetif));

udp_api.cpp:62

otUdpBind()

return AsCoreType(aInstance).Get<Ip6::Udp>().Connect(AsCoreType(aSocket), AsCoreType(aSockName));

udp_api.cpp:67

otUdpConnect()

error = AsCoreType(aInstance).Get<Ip6::Udp>().SendTo(AsCoreType(aSocket), AsCoreType(aMessage),

udp_api.cpp:76

otUdpSend()

otUdpSocket *otUdpGetSockets(otInstance *aInstance) { return AsCoreType(aInstance).Get<Ip6::Udp>().GetUdpSockets(); }

udp_api.cpp:82

otUdpGetSockets()

return AsCoreType(aInstance).Get<Ip6::Udp>().AddReceiver(AsCoreType(aUdpReceiver));

udp_api.cpp:112

otUdpAddReceiver()

return AsCoreType(aInstance).Get<Ip6::Udp>().RemoveReceiver(AsCoreType(aUdpReceiver));

udp_api.cpp:117

otUdpRemoveReceiver()

return AsCoreType(aInstance).Get<Ip6::Udp>().SendDatagram(AsCoreType(aMessage), AsCoreType(aMessageInfo));

udp_api.cpp:126

otUdpSendDatagram()

return AsCoreType(aInstance).Get<Ip6::Udp>().IsPortInUse(port);

udp_api.cpp:133

otUdpIsPortInUse()

Call Tree

All items filtered out

Data Use

All items filtered out

Class Tree

ot::Ip6::Udp is inherited by 2 classess:

ot::Ip6::Udp

ot::NonCopyable

ot::InstanceLocator

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Instance

Scope

Location

Project

return

Lifecycle

All items filtered out

ot::Ip6::Udp class

Syntax

Fields

Methods

AddReceiver()

RemoveReceiver()

Open()

IsOpen() const

Bind()

Connect()

Close()

SendTo()

GetEphemeralPort()

NewMessage()

NewMessage()

NewMessage()

SendDatagram()

HandleMessage()

HandlePayload()

GetUdpSockets()

IsPortInUse() const

ShouldUsePlatformUdp() const

IsPortReserved()

AddSocket()

RemoveSocket()

ShouldUsePlatformUdp() const

SetBackboneSocket()

GetBackboneSockets() const

IsBackboneSocket() const

ShouldUsePlatformUdp() const

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle