Symbols

loading...

Files

loading (2/5)...

Summary Syntax Methods References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Ip6::Tcp::Listener

ot::Ip6::Tcp::Listener class

Represents a TCP/IPv6 listener.

Syntax

Show:

Summary

Declaration

from tcp6.hpp:396

class Listener : public otTcpListener, public LinkedListEntry<Listener>, public GetProvider<Listener> { friend class LinkedList<Listener>; public: Error Initialize(Instance &aInstance, const otTcpListenerInitializeArgs &aArgs); Instance &GetInstance(void) const; void *GetContext(void) { return mContext; } Error Listen(const SockAddr &aSockName); Error StopListening(void); Error Deinitialize(void); static Listener &FromTcbListen(struct tcpcb_listen &aTcbListen) { return *reinterpret_cast<Listener *>(&aTcbListen); } struct tcpcb_listen &GetTcbListen(void) { return *reinterpret_cast<struct tcpcb_listen *>(&mTcbListen); } const struct tcpcb_listen &GetTcbListen(void) const { return *reinterpret_cast<const struct tcpcb_listen *>(&mTcbListen); } bool IsClosed(void) const; private: Address &GetLocalIp6Address(void); const Address &GetLocalIp6Address(void) const; bool Matches(const MessageInfo &aMessageInfo) const; };

Methods

Initialize()

Initializes a TCP listener. Calling this function causes OpenThread to keep track of the TCP listener and store and retrieve TCP data inside this Listener. The application should refrain from directly accessing or modifying the fields in this Listener. If the application needs to reclaim the memory backing this Listener, it should call otTcpListenerDeinitialize(). @sa otTcpListenerInitialize.

GetInstance() const

Obtains the otInstance that was associated with this Listener upon initialization. @sa otTcpListenerGetInstance.

GetContext()

Obtains the context pointer that was associated with this Listener upon initialization. @sa otTcpListenerGetContext.

Listen()

Causes incoming TCP connections that match the specified IP address and port to trigger this TCP listener's callbacks. @sa otTcpListen.

StopListening()

Causes this TCP listener to stop listening for incoming connections. @sa otTcpStopListening.

Deinitialize()

Deinitializes this TCP listener. This means that OpenThread no longer keeps track of this TCP listener and deallocates all resources it has internally allocated for this TCP endpoint. The application can reuse the memory backing the TCP listener as it sees fit. If the TCP listener is currently listening, it stops listening. @sa otTcpListenerDeinitialize.

FromTcbListen()

Converts a reference to a struct tcpcb_listen to a reference to its enclosing Listener.

GetTcbListen()

Obtains a reference to this Listener's struct tcpcb_listen.

GetTcbListen() const

Obtains a const reference to this Listener's struct tcpcb_listen.

IsClosed() const

Checks if this Listener is in the closed state.

GetLocalIp6Address()

GetLocalIp6Address() const

Matches() const

References

Code

Location

Scope

Referrer

class Listener : public otTcpListener, public LinkedListEntry<Listener>, public GetProvider<Listener>

DefineCoreType(otCacheEntryIterator, AddressResolver::Iterator);

address_resolver.hpp:400

DefineCoreType(otCacheEntryInfo, AddressResolver::EntryInfo);

address_resolver.hpp:401

DefineCoreType(otBorderAgentId, MeshCoP::BorderAgent::Id);

border_agent.hpp:353

DefineCoreType(otChildInfo, Child::Info);

DefineCoreType(otCoapTxParameters, Coap::TxParameters);

DefineCoreType(otCoapResource, Coap::Resource);

DefineCoreType(otCoapOption, Coap::Option);

coap_message.hpp:1175

DefineCoreType(otCoapOptionIterator, Coap::Option::Iterator);

coap_message.hpp:1176

DefineCoreType(otOperationalDatasetComponents, MeshCoP::Dataset::Components);

dataset.hpp:783

DefineCoreType(otOperationalDataset, MeshCoP::Dataset::Info);

dataset.hpp:784

DefineCoreType(otDnsQueryConfig, Dns::Client::QueryConfig);

dns_client.hpp:892

DefineCoreType(otDnsAddressResponse, Dns::Client::AddressResponse);

dns_client.hpp:893

DefineCoreType(otDnsBrowseResponse, Dns::Client::BrowseResponse);

dns_client.hpp:895

DefineCoreType(otDnsServiceResponse, Dns::Client::ServiceResponse);

dns_client.hpp:896

DefineCoreType(otDnsServiceInfo, Dns::Client::ServiceInfo);

dns_client.hpp:897

DefineCoreType(otDnsTxtEntry, Dns::TxtEntry);

dns_types.hpp:2734

DefineCoreType(otDnsTxtEntryIterator, Dns::TxtEntry::Iterator);

dns_types.hpp:2735

DefineCoreType(otPlatCryptoEcdsaSignature, Crypto::Ecdsa::P256::Signature);

DefineCoreType(otPlatCryptoEcdsaKeyPair, Crypto::Ecdsa::P256::KeyPair);

DefineCoreType(otPlatCryptoEcdsaPublicKey, Crypto::Ecdsa::P256::PublicKey);

DefineCoreType(otExtendedPanId, MeshCoP::ExtendedPanId);

extended_panid.hpp:106

DefineCoreType(otIcmp6Header, Ip6::Icmp::Header);

DefineCoreType(otIcmp6Handler, Ip6::Icmp::Handler);

DefineCoreType(otInstance, Instance);

instance.hpp:741

DefineCoreType(otBufferInfo, Instance::BufferInfo);

instance.hpp:742

DefineCoreType(otIp4Address, Ip4::Address);

ip4_types.hpp:661

DefineCoreType(otIp4Cidr, Ip4::Cidr);

ip4_types.hpp:662

DefineCoreType(otIp6NetworkPrefix, Ip6::NetworkPrefix);

ip6_address.hpp:986

DefineCoreType(otIp6Prefix, Ip6::Prefix);

ip6_address.hpp:987

DefineCoreType(otIp6InterfaceIdentifier, Ip6::InterfaceIdentifier);

ip6_address.hpp:988

DefineCoreType(otIp6Address, Ip6::Address);

ip6_address.hpp:989

DefineCoreType(otSecurityPolicy, SecurityPolicy);

key_manager.hpp:646

DefineCoreType(otNetworkKey, NetworkKey);

key_manager.hpp:647

DefineCoreType(otPskc, Pskc);

key_manager.hpp:648

DefineCoreType(otExtAddress, Mac::ExtAddress);

mac_types.hpp:923

DefineCoreType(otMacKey, Mac::Key);

mac_types.hpp:924

DefineCoreType(otMeshDiagIp6AddrIterator, Utils::MeshDiag::Ip6AddrIterator);

mesh_diag.hpp:314

DefineCoreType(otMeshDiagRouterInfo, Utils::MeshDiag::RouterInfo);

mesh_diag.hpp:315

DefineCoreType(otMeshDiagChildInfo, Utils::MeshDiag::ChildInfo);

mesh_diag.hpp:316

DefineCoreType(otMeshDiagChildIterator, Utils::MeshDiag::ChildIterator);

mesh_diag.hpp:317

DefineCoreType(otThreadLinkInfo, ThreadLinkInfo);

mesh_forwarder.hpp:662

DefineCoreType(otJoinerPskd, MeshCoP::JoinerPskd);

meshcop.hpp:515

DefineCoreType(otJoinerDiscerner, MeshCoP::JoinerDiscerner);

meshcop.hpp:516

DefineCoreType(otSteeringData, MeshCoP::SteeringData);

meshcop.hpp:517

DefineCoreType(otCommissioningDataset, MeshCoP::CommissioningDataset);

meshcop.hpp:518

DefineCoreType(otMessageBuffer, Buffer);

message.hpp:1901

DefineCoreType(otMessageSettings, Message::Settings);

message.hpp:1902

DefineCoreType(otMessage, Message);

message.hpp:1903

DefineCoreType(otMessageQueue, MessageQueue);

message.hpp:1904

DefineCoreType(otLeaderData, Mle::LeaderData);

mle_types.hpp:699

DefineCoreType(otDeviceProperties, Mle::DeviceProperties);

mle_types.hpp:702

DefineCoreType(otNeighborInfo, Neighbor::Info);

neighbor.hpp:773

DefineCoreType(otNetifAddress, Ip6::Netif::UnicastAddress);

DefineCoreType(otNetifMulticastAddress, Ip6::Netif::MulticastAddress);

DefineCoreType(otBorderRouterConfig, NetworkData::OnMeshPrefixConfig);

network_data_types.hpp:400

DefineCoreType(otExternalRouteConfig, NetworkData::ExternalRouteConfig);

network_data_types.hpp:401

DefineCoreType(otLowpanContextInfo, NetworkData::LowpanContextInfo);

network_data_types.hpp:402

DefineCoreType(otServiceConfig, NetworkData::ServiceConfig);

network_data_types.hpp:403

DefineCoreType(otServerConfig, NetworkData::ServiceConfig::ServerConfig);

network_data_types.hpp:404

DefineCoreType(otNetworkName, MeshCoP::NetworkName);

network_name.hpp:262

DefineCoreType(otPingSenderReply, Utils::PingSender::Reply);

ping_sender.hpp:179

DefineCoreType(otPingSenderConfig, Utils::PingSender::Config);

ping_sender.hpp:180

DefineCoreType(otPingSenderStatistics, Utils::PingSender::Statistics);

ping_sender.hpp:181

DefineCoreType(otRouterInfo, Router::Info);

DefineCoreType(otCryptoSha256Hash, Crypto::Sha256::Hash);

DefineCoreType(otMessageInfo, Ip6::MessageInfo);

DefineCoreType(otSockAddr, Ip6::SockAddr);

DefineCoreType(otSrpClientHostInfo, Srp::Client::HostInfo);

srp_client.hpp:1116

DefineCoreType(otSrpClientService, Srp::Client::Service);

srp_client.hpp:1117

DefineCoreType(otSrpClientBuffersServiceEntry, Utils::SrpClientBuffers::ServiceEntry);

srp_client_buffers.hpp:248

DefineCoreType(otSrpServerTtlConfig, Srp::Server::TtlConfig);

srp_server.hpp:1019

DefineCoreType(otSrpServerLeaseConfig, Srp::Server::LeaseConfig);

srp_server.hpp:1020

DefineCoreType(otSrpServerHost, Srp::Server::Host);

srp_server.hpp:1021

DefineCoreType(otSrpServerService, Srp::Server::Service);

srp_server.hpp:1022

DefineCoreType(otCryptoKey, Crypto::Key);

storage.hpp:323

DefineCoreType(otTcpEndpoint, Ip6::Tcp::Endpoint);

DefineCoreType(otTcpListener, Ip6::Tcp::Listener);

DefineCoreType(otTcpCircularSendBuffer, Ip6::TcpCircularSendBuffer);

tcp6_ext.hpp:129

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

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

friend class LinkedList<Listener>;

static Listener &FromTcbListen(struct tcpcb_listen &aTcbListen)

ot::Ip6::Tcp::Listener

ot::Ip6::Tcp::Listener::FromTcbListen()

return *reinterpret_cast<Listener *>(&aTcbListen);

ot::Ip6::Tcp::Listener::FromTcbListen()

bool IsInitialized(const Listener &aListener) const { return mListeners.Contains(aListener); }

ot::Ip6::Tcp::IsInitialized() const

LinkedList<Listener> mListeners;

DefineCoreType(otTcpListener, Ip6::Tcp::Listener);

ot::CoreType::Type

Call Tree

All items filtered out

All items filtered out

Data Use

All items filtered out

All items filtered out

Class Tree

ot::Ip6::Tcp::Listener is inherited by 1 classes:

ot::Ip6::Tcp::Listener

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Instance

Scope

Location

Project

return

ot::Ip6::Tcp::Listener::FromTcbListen()

ot::CoreType::Type

Lifecycle

All items filtered out

All items filtered out