Symbols

loading (2/5)...

Files

loading (3/5)...

Summary Syntax Methods Related References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Ip4::Cidr

ot::Ip4::Cidr class

This module includes definitions for the IPv4 network layer. This module includes definitions for IPv4 networking used by NAT64.

Syntax

Show:

Summary

Declaration

Definition

from ip4_types.hpp:86

class Cidr; OT_TOOL_PACKED_BEGIN class Address : public otIp4Address, public Equatable<Address>, public Clearable<Address> { public: static constexpr uint16_t kSize = 4; static constexpr uint16_t kAddressStringSize = 17; typedef String<kAddressStringSize> InfoString; const uint8_t *GetBytes(void) const { return mFields.m8; } void SetBytes(const uint8_t *aBuffer) { memcpy(mFields.m8, aBuffer, kSize); } Error ExtractFromIp4MappedIp6Address(const Ip6::Address &aIp6Address); void ExtractFromIp6Address(uint8_t aPrefixLength, const Ip6::Address &aIp6Address); void SynthesizeFromCidrAndHost(const Cidr &aCidr, uint32_t aHost); Error FromString(const char *aString, char aTerminatorChar = kNullChar); void ToString(char *aBuffer, uint16_t aSize) const; InfoString ToString(void) const; private: void ToString(StringWriter &aWriter) const; } OT_TOOL_PACKED_END; class Cidr : public otIp4Cidr;

Implemented in ip4_types.hpp:190

Fields

Field

ot::Ip4::Cidr::kCidrSuffixSize

Methods

FromString()

Converts the IPv4 CIDR string to binary. The string format uses quad-dotted notation of four bytes in the address with the length of prefix (e.g., "127.0.0.1/32").

ToString() const

Converts the IPv4 CIDR to a string. The string format uses quad-dotted notation of four bytes in the address with the length of prefix (e.g., "127.0.0.1/32"). If the resulting string does not fit in @p aBuffer (within its @p aSize characters), the string will be truncated but the outputted string is always null-terminated.

ToString() const

Converts the IPv4 CIDR to a string. The string format uses quad-dotted notation of four bytes in the address with the length of prefix (e.g., "127.0.0.1/32"). If the resulting string does not fit in @p aBuffer (within its @p aSize characters), the string will be truncated but the outputted string is always null-terminated.

GetBytes() const

Gets the prefix as a pointer to a byte array.

operator() const

Overloads operator `==` to evaluate whether or not two prefixes are equal.

Set()

Sets the CIDR.

HostMask() const

SubnetMask() const

ToString() const

Converts the IPv4 CIDR to a string. The string format uses quad-dotted notation of four bytes in the address with the length of prefix (e.g., "127.0.0.1/32"). If the resulting string does not fit in @p aBuffer (within its @p aSize characters), the string will be truncated but the outputted string is always null-terminated.

References

Code

Location

Scope

Referrer

class Cidr : public otIp4Cidr, public Unequatable<Cidr>, public Clearable<Address>

ip4_types.hpp:190

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

class Cidr;

ip4_types.hpp:86

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

void Address::SynthesizeFromCidrAndHost(const Cidr &aCidr, const uint32_t aHost)

ip4_types.cpp:121

ot::Ip4::Address::SynthesizeFromCidrAndHost()

ot::Ip4::Address::SynthesizeFromCidrAndHost()::aCidr

Error Cidr::FromString(const char *aString)

ip4_types.cpp:147

ot::Ip4::Cidr::FromString()

void Cidr::ToString(StringWriter &aWriter) const

ip4_types.cpp:170

ot::Ip4::Cidr::ToString() const

void Cidr::ToString(char *aBuffer, uint16_t aSize) const

ip4_types.cpp:175

ot::Ip4::Cidr::ToString() const

Cidr::InfoString Cidr::ToString(void) const

ip4_types.cpp:182

ot::Ip4::Cidr::ToString() const

bool Cidr::operator==(const Cidr &aOther) const

ip4_types.cpp:191

ot::Ip4::Cidr::operator() const

ot::Ip4::Cidr::operator() const::aOther

void Cidr::Set(const uint8_t *aAddress, uint8_t aLength)

ip4_types.cpp:197

ot::Ip4::Cidr::Set()

void SynthesizeFromCidrAndHost(const Cidr &aCidr, uint32_t aHost);

ip4_types.hpp:146

ot::Ip4::Address::SynthesizeFromCidrAndHost()

ot::Ip4::Address::SynthesizeFromCidrAndHost()::aCidr

bool operator==(const Cidr &aOther) const;

ip4_types.hpp:254

ot::Ip4::Cidr::operator() const

ot::Ip4::Cidr::operator() const::aOther

DefineCoreType(otIp4Cidr, Ip4::Cidr);

ip4_types.hpp:662

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::Ip4::Cidr is inherited by 1 classes:

ot::Ip4::Cidr

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Instance

Scope

Location

Project

ot::Ip4::Address::SynthesizeFromCidrAndHost()::aCidr

ot::Ip4::Address::SynthesizeFromCidrAndHost()

ip4_types.hpp:146

ot::Ip4::Cidr::operator() const::aOther

ot::Ip4::Cidr::operator() const

ip4_types.hpp:254

ot::CoreType::Type

ip4_types.hpp:662

ot::Ip4::Address::SynthesizeFromCidrAndHost()::aCidr

ot::Ip4::Address::SynthesizeFromCidrAndHost()

ip4_types.cpp:121

ot::Ip4::Cidr::operator() const::aOther

ot::Ip4::Cidr::operator() const

ip4_types.cpp:191

Lifecycle

All items filtered out

All items filtered out