Symbols

Files

Summary Syntax Methods References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Ip6::Udp::Socket

ot::Ip6::Udp::Socket class

Implements a UDP/IPv6 socket.

Syntax

Show:

Summary

Declaration

from udp6.hpp:143

class Socket : public InstanceLocator, public SocketHandle { friend class Udp; public: Socket(Instance &aInstance, ReceiveHandler aHandler, void *aContext); Message *NewMessage(void); Message *NewMessage(uint16_t aReserved); Message *NewMessage(uint16_t aReserved, const Message::Settings &aSettings); Error Open(void); bool IsOpen(void) const; Error Bind(const SockAddr &aSockAddr, NetifIdentifier aNetifIdentifier = kNetifThread); Error Bind(uint16_t aPort, NetifIdentifier aNetifIdentifier = kNetifThread); Error Bind(void) { return Bind(0); } Error Connect(const SockAddr &aSockAddr); Error Connect(uint16_t aPort); Error Connect(void) { return Connect(0); } Error Close(void); Error SendTo(Message &aMessage, const MessageInfo &aMessageInfo); #if OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE Error JoinNetifMulticastGroup(NetifIdentifier aNetifIdentifier, const Address &aAddress); Error LeaveNetifMulticastGroup(NetifIdentifier aNetifIdentifier, const Address &aAddress); #endif };

Methods

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`).

Open()

Opens the UDP socket.

IsOpen() const

Returns if the UDP socket is open.

Bind()

Binds the UDP socket.

Bind()

Binds the UDP socket.

Bind()

Binds the UDP socket.

Connect()

Connects the UDP socket.

Connect()

Connects the UDP socket.

Connect()

Connects the UDP socket.

Close()

Closes the UDP socket.

SendTo()

Sends a UDP message.

JoinNetifMulticastGroup()

Configures the UDP socket to join a multicast group on a Host network interface.

LeaveNetifMulticastGroup()

Configures the UDP socket to leave a multicast group on a Host network interface.

References

Code

Location

Scope

Referrer

class Socket : public InstanceLocator, public SocketHandle

udp6.hpp:143

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

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()

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

srp_server.hpp:911

ot::Srp::Server

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

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()

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()

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()

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()

class SocketIn : public Socket

udp6.hpp:309

Call Tree

All items filtered out

Data Use

All items filtered out

Class Tree

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

ot::Ip6::Udp::Socket

ot::Ip6::Udp::SocketHandle

ot::InstanceLocator

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Instance

Scope

Location

Project

return

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

srp_server.hpp:911

return

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

srp_server.cpp:675

Lifecycle

All items filtered out