List of all members
Ip::Address Class Reference

#include <Address.h>

Collaboration diagram for Ip::Address:
Collaboration graph
[legend]

Public Member Functions

Constructors
 Address ()
 
 Address (const struct in_addr &)
 
 Address (const struct sockaddr_in &)
 
 Address (const struct in6_addr &)
 
 Address (const struct sockaddr_in6 &)
 
 Address (const struct hostent &)
 
 Address (const struct addrinfo &)
 
 Address (const char *)
 
Assignment Operators
Address & operator= (struct sockaddr_in const &s)
 
Address & operator= (struct sockaddr_storage const &s)
 
Address & operator= (struct in_addr const &s)
 
Address & operator= (struct in6_addr const &s)
 
Address & operator= (struct sockaddr_in6 const &s)
 
bool operator= (const struct hostent &s)
 
bool operator= (const struct addrinfo &s)
 
bool operator= (const char *s)
 

Boolean Operators

struct sockaddr_in6 mSocketAddr_
 
static const unsigned int STRLEN_IP4A = 16
 
static const unsigned int STRLEN_IP4R = 28
 
static const unsigned int STRLEN_IP4S = 21
 
static const unsigned int MAX_IP4_STRLEN = STRLEN_IP4R
 
static const unsigned int STRLEN_IP6A = 42
 
static const unsigned int STRLEN_IP6R = 75
 
static const unsigned int STRLEN_IP6S = 48
 
static const unsigned int MAX_IP6_STRLEN = STRLEN_IP6R
 
static const struct in6_addr v4_localhost
 
static const struct in6_addr v4_anyaddr
 
static const struct in6_addr v4_noaddr
 
static const struct in6_addr v6_noaddr
 
bool operator== (Address const &s) const
 
bool operator!= (Address const &s) const
 
bool operator>= (Address const &rhs) const
 
bool operator<= (Address const &rhs) const
 
bool operator> (Address const &rhs) const
 
bool operator< (Address const &rhs) const
 
bool isIPv4 () const
 
bool isIPv6 () const
 
bool isSockAddr () const
 
bool isAnyAddr () const
 
bool isNoAddr () const
 
bool isLocalhost () const
 
bool isSiteLocal6 () const
 
bool isSiteLocalAuto () const
 
unsigned short port () const
 
unsigned short port (unsigned short port)
 
void setAnyAddr ()
 NOTE: Does NOT clear the Port stored. Only the Address and Type. More...
 
void setNoAddr ()
 
void setLocalhost ()
 
void setEmpty ()
 Fast reset of the stored content to what would be after default constructor. More...
 
bool setIPv4 ()
 
int cidr () const
 
int applyMask (const Address &mask)
 
bool applyMask (const unsigned int cidr, int mtype)
 
void applyClientMask (const Address &mask)
 
char * toStr (char *buf, const unsigned int blen, int force=AF_UNSPEC) const
 
char * toUrl (char *buf, unsigned int len) const
 
unsigned int toHostStr (char *buf, const unsigned int len) const
 
bool fromHost (const char *hostWithoutPort)
 
bool getReverseString (char buf[MAX_IPSTRLEN], int show_type=AF_UNSPEC) const
 
int matchIPAddr (const Address &rhs) const
 
int compareWhole (const Ip::Address &rhs) const
 
void getAddrInfo (struct addrinfo *&ai, int force=AF_UNSPEC) const
 
bool GetHostByName (const char *s)
 
void getSockAddr (struct sockaddr_storage &addr, const int family) const
 
void getSockAddr (struct sockaddr_in &) const
 
bool getInAddr (struct in_addr &) const
 
void getSockAddr (struct sockaddr_in6 &) const
 
void getInAddr (struct in6_addr &) const
 
static void FreeAddr (struct addrinfo *&ai)
 
static void InitAddr (struct addrinfo *&ai)
 
static const Address & NoAddr ()
 
bool getReverseString4 (char buf[MAX_IPSTRLEN], const struct in_addr &dat) const
 
bool getReverseString6 (char buf[MAX_IPSTRLEN], const struct in6_addr &dat) const
 
void map4to6 (const struct in_addr &src, struct in6_addr &dest) const
 
void map6to4 (const struct in6_addr &src, struct in_addr &dest) const
 
bool lookupHostIP (const char *s, bool nodns)
 

Detailed Description

Holds and manipulates IPv4, IPv6, and Socket Addresses.

Definition at line 40 of file Address.h.

Constructor & Destructor Documentation

◆ Address() [1/8]

Ip::Address::Address ( )
inline

Definition at line 46 of file Address.h.

References setEmpty().

◆ Address() [2/8]

Ip::Address::Address ( const struct in_addr &  s)

Definition at line 465 of file Address.cc.

◆ Address() [3/8]

Ip::Address::Address ( const struct sockaddr_in &  s)

Definition at line 423 of file Address.cc.

◆ Address() [4/8]

Ip::Address::Address ( const struct in6_addr &  s)

Definition at line 479 of file Address.cc.

◆ Address() [5/8]

Ip::Address::Address ( const struct sockaddr_in6 &  s)

Definition at line 452 of file Address.cc.

◆ Address() [6/8]

Ip::Address::Address ( const struct hostent &  s)

Definition at line 494 of file Address.cc.

◆ Address() [7/8]

Ip::Address::Address ( const struct addrinfo &  s)

Definition at line 538 of file Address.cc.

◆ Address() [8/8]

Ip::Address::Address ( const char *  s)

Definition at line 359 of file Address.cc.

Member Function Documentation

◆ applyClientMask()

void Ip::Address::applyClientMask ( const Address &  mask)

Apply so-called 'privacy masking' to IPv4 addresses, except localhost IP. IPv6 clients use 'privacy addressing' instead.

Definition at line 105 of file Address.cc.

Referenced by ConnStateData::ConnStateData(), and AccessLogEntry::getLogClientIp().

◆ applyMask() [1/2]

int Ip::Address::applyMask ( const Address &  mask)

Apply a mask to the stored address.

Parameters
maskNetmask format to be bit-mask-AND'd over the stored address.

Definition at line 87 of file Address.cc.

References mSocketAddr_.

Referenced by asnAddNet(), acl_ip_data::DecodeMask(), acl_ip_data::FactoryParse(), networkFromInaddr(), and TestIpAddress::testMasking().

◆ applyMask() [2/2]

bool Ip::Address::applyMask ( const unsigned int  cidr,
int  mtype 
)

Apply a mask to the stored address. CIDR will be converted appropriate to map the stored content.

Parameters
cidrCIDR Mask being applied. As an integer in host format.
mtypeType of CIDR mask being applied (AF_INET or AF_INET6)

Definition at line 112 of file Address.cc.

◆ cidr()

int Ip::Address::cidr ( ) const

Valid results IF and only IF the stored IP address is actually a network bitmask

Return values
Nnumber of bits which are set in the bitmask stored.

Definition at line 44 of file Address.cc.

References isIPv6(), and mSocketAddr_.

Referenced by acl_ip_data::DecodeMask(), acl_ip_data::FactoryParse(), printRadixNode(), TestIpAddress::testMasking(), and acl_ip_data::toStr().

◆ compareWhole()

int Ip::Address::compareWhole ( const Ip::Address &  rhs) const

Compare taking IP, port, protocol, etc. into account. Returns an integer less than, equal to, or greater than zero if the object is found, respectively, to be less than, to match, or to be greater than rhs. The exact ordering algorithm is not specified and may change.

Definition at line 724 of file Address.cc.

Referenced by Ipc::OpenListenerParams::operator<().

◆ FreeAddr()

void Ip::Address::FreeAddr ( struct addrinfo *&  ai)
static

Equivalent to the sysem call freeaddrinfo() but for Ip::Address allocated data

Definition at line 686 of file Address.cc.

Referenced by Comm::TcpAcceptor::acceptInto(), client_comm_bind(), client_comm_connect(), comm_connect_addr(), comm_local_port(), comm_openex(), comm_udp_recvfrom(), comm_udp_sendto(), ftpSendPORT(), getMyHostname(), Ipc::ImportFdIntoComm(), ipc_thread_1(), ipcCreate(), Comm::ConnOpener::lookupLocalAddress(), process_request(), Icmp4::Recv(), Icmp6::Recv(), resolveDestination(), Icmp4::SendEcho(), Icmp6::SendEcho(), Ipc::SharedListenJoined(), and TestIpAddress::testAddrInfo().

◆ fromHost()

bool Ip::Address::fromHost ( const char *  hostWithoutPort)

Empties the address and then slowly imports the IP from a possibly [bracketed] portless host. For the semi-reverse operation, see toHostStr() which does export the port.

Returns
whether the conversion was successful

Definition at line 898 of file Address.cc.

References xfree, and xstrdup.

Referenced by ipcacheCheckNumeric(), and AnyP::Uri::parseHost().

◆ getAddrInfo()

void Ip::Address::getAddrInfo ( struct addrinfo *&  ai,
int  force = AF_UNSPEC 
) const

Get RFC 3493 addrinfo structure from the Ip::Address data for protocol-neutral socket operations. Should be passed a NULL pointer of type struct addrinfo* it will allocate memory for the structures involved. (see FreeAddr() to clear). Defaults to a TCP streaming socket, if other values (such as UDP) are needed the caller MUST override these default settings. Some situations may also require an actual call to the system getaddrinfo() to pull relevant OS details for the socket.

Ip::Address allocated objects MUST be destructed by Ip::Address::FreeAddr System getaddrinfo() allocated objects MUST be freed with system freeaddrinfo()
Parameters
aistructure to be filled out.
forcea specific sockaddr type is needed. default: don't care.

Definition at line 599 of file Address.cc.

References Ip::EnableIpv6, and IASSERT.

Referenced by client_comm_bind(), client_comm_connect(), comm_connect_addr(), comm_openex(), comm_udp_sendto(), ftpSendPORT(), getMyHostname(), process_request(), resolveDestination(), Icmp4::SendEcho(), Icmp6::SendEcho(), Ipc::SharedListenJoined(), and TestIpAddress::testAddrInfo().

◆ GetHostByName()

bool Ip::Address::GetHostByName ( const char *  s)

Lookup a Host by Name. Equivalent to system call gethostbyname(char*)

Parameters
sThe textual FQDN of the host being located.
Return values
truelookup was successful and an IPA was located.
falselookup failed or FQDN has no IP associated.

Definition at line 372 of file Address.cc.

Referenced by ProxyProtocol::One::ExtractIp(), GetHostWithPort(), parse_address(), and resolveDestination().

◆ getInAddr() [1/2]

void Ip::Address::getInAddr ( struct in6_addr &  buf) const

Definition at line 1014 of file Address.cc.

◆ getInAddr() [2/2]

bool Ip::Address::getInAddr ( struct in_addr &  buf) const

Definition at line 1020 of file Address.cc.

References assert, DBG_IMPORTANT, and debugs.

Referenced by addr2oid(), idnsPTRLookup(), Ip::Intercept::IpfInterception(), Eui::Eui64::lookupSlaac(), ClassCHostPool::makeHostKey(), ClassCHostPool::makeKey(), IndividualPool::makeKey(), ClassCNetPool::makeKey(), netdbBinaryExchange(), networkFromInaddr(), Ip::Intercept::PfInterception(), TestIpAddress::testBugNullingDisplay(), TestIpAddress::testHostentConstructor(), TestIpAddress::testInAddr6Constructor(), TestIpAddress::testInAddrConstructor(), TestIpAddress::testMasking(), TestIpAddress::testStringConstructor(), and wccp2Init().

◆ getReverseString()

bool Ip::Address::getReverseString ( char  buf[MAX_IPSTRLEN],
int  show_type = AF_UNSPEC 
) const

Convert the content into a Reverse-DNS string. The buffer sent MUST be allocated large enough to hold the resulting string. Name truncation will occur if buf does not have enough space. The constant MAX_IPSTRLEN is defined to provide for sizing arrays correctly.

Parameters
show_typemay be one of: AF_INET, AF_INET6 for the format of rDNS string wanted. AF_UNSPEC the default displays the IP in its most advanced native form.
bufbuffer to receive the text string output.

Definition at line 338 of file Address.cc.

References DBG_CRITICAL, debugs, and MAX_IPSTRLEN.

Referenced by TestIpAddress::testgetReverseString().

◆ getReverseString4()

bool Ip::Address::getReverseString4 ( char  buf[MAX_IPSTRLEN],
const struct in_addr &  dat 
) const
private

Definition at line 326 of file Address.cc.

References int.

◆ getReverseString6()

bool Ip::Address::getReverseString6 ( char  buf[MAX_IPSTRLEN],
const struct in6_addr &  dat 
) const
private

Definition at line 299 of file Address.cc.

◆ getSockAddr() [1/3]

void Ip::Address::getSockAddr ( struct sockaddr_in &  buf) const

Definition at line 946 of file Address.cc.

References assert, DBG_CRITICAL, and debugs.

◆ getSockAddr() [2/3]

void Ip::Address::getSockAddr ( struct sockaddr_in6 &  buf) const

Definition at line 966 of file Address.cc.

◆ getSockAddr() [3/3]

void Ip::Address::getSockAddr ( struct sockaddr_storage &  addr,
const int  family 
) const

Definition at line 924 of file Address.cc.

References assert, DBG_CRITICAL, debugs, and IASSERT.

Referenced by Eui::Eui48::lookup(), Ip::Intercept::NetfilterInterception(), TestIpAddress::testCopyConstructor(), TestIpAddress::testSockAddr6Constructor(), TestIpAddress::testSockAddrConstructor(), wccp2HandleUdp(), and wccpConnectionOpen().

◆ InitAddr()

void Ip::Address::InitAddr ( struct addrinfo *&  ai)
static

Initializes an empty addrinfo properly for use. It is intended for use in cases such as getsockopt() where the addrinfo is about to be changed and the stored details may not match the new ones coming.

Parameters
aiaddrinfo struct to be initialized as AF_UNSPEC with large address buffer

Definition at line 668 of file Address.cc.

Referenced by Comm::TcpAcceptor::acceptInto(), comm_local_port(), comm_udp_recvfrom(), ipc_thread_1(), ipcCreate(), Comm::ConnOpener::lookupLocalAddress(), Icmp4::Recv(), and Icmp6::Recv().

◆ isAnyAddr()

bool Ip::Address::isAnyAddr ( ) const

Content-neutral test for whether the specific IP case ANY_ADDR is stored. This is the default content of a new undefined Ip::Address object.

Return values
trueIPv4 0.0.0.0
trueIPv6 ::
falseanything else.

Definition at line 170 of file Address.cc.

Referenced by aclIpAddrNetworkCompare(), asnMatchIp(), client_Inst(), Adaptation::Ecap::XactionRep::clientIpValue(), comm_apply_flags(), comm_open(), FindListeningPortAddress(), IdleConnList::findUseable(), fqdncache_gethostbyaddr(), getMyHostname(), PeerSelector::handleHtcpParentMiss(), PeerSelector::handleIcpParentMiss(), Ftp::Server::handleUserRequest(), htcpOpenPorts(), icpOpenPorts(), internalRemoteUri(), Adaptation::Icap::ModXact::makeRequestHeaders(), netdbExchangeHandleReply(), operator<(), operator<=(), Ftp::ParseIpPort(), Ftp::ParseProtoIpPort(), process_request(), PeerSelector::selectSomeNeighborReplies(), Ssl::setClientSNI(), snmpOpenPorts(), TestIpAddress::testBugNullingDisplay(), TestIpAddress::testCopyConstructor(), TestIpAddress::testDefaults(), TestIpAddress::testHostentConstructor(), TestIpAddress::testInAddr6Constructor(), TestIpAddress::testInAddrConstructor(), TestIpAddress::testMasking(), TestIpAddress::testsetEmpty(), TestIpAddress::testSockAddr6Constructor(), TestIpAddress::testSockAddrConstructor(), TestIpAddress::testStringConstructor(), acl_ip_data::toStr(), wccp2Init(), wccpConnectionOpen(), and wccpInit().

◆ isIPv4()

bool Ip::Address::isIPv4 ( ) const

Test whether content can be used as an IPv4 address

Return values
trueif content was received as an IPv4-Mapped address
falseif content was received as a non-mapped IPv6 native address.

Definition at line 158 of file Address.cc.

Referenced by Comm::TcpAcceptor::acceptInto(), Format::Format::assemble(), client_Inst(), comm_connect_addr(), Ftp::Server::createDataConnection(), acl_ip_data::DecodeMask(), Log::TcpLogger::doConnect(), ftpSendPORT(), VectorPool::id(), ClassCHostPool::id(), Dns::Init(), logfile_mod_udp_open(), ClassCHostPool::makeHostKey(), ClassCHostPool::makeKey(), IndividualPool::makeKey(), ClassCNetPool::makeKey(), ACLARP::match(), netdbBinaryExchange(), netdbExchangeUpdatePeer(), PeerSelector::noteIp(), Ip::Intercept::ProbeForTproxy(), IcmpPinger::Recv(), snmp_meshCtblFn(), snmp_meshPtblFn(), TestIpAddress::testBugNullingDisplay(), TestIpAddress::testCopyConstructor(), TestIpAddress::testDefaults(), TestIpAddress::testHostentConstructor(), TestIpAddress::testInAddr6Constructor(), TestIpAddress::testInAddrConstructor(), TestIpAddress::testMasking(), TestIpAddress::testsetEmpty(), TestIpAddress::testSockAddr6Constructor(), TestIpAddress::testSockAddrConstructor(), TestIpAddress::testStringConstructor(), and acl_ip_data::toStr().

◆ isIPv6()

bool Ip::Address::isIPv6 ( ) const

Test whether content can be used as an IPv6 address.

Return values
trueif content is a non IPv4-mapped address.
falseif content is IPv4-mapped.

Definition at line 164 of file Address.cc.

Referenced by Comm::TcpAcceptor::acceptInto(), addr2oid(), cidr(), comm_openex(), idnsPTRLookup(), Dns::Init(), ipcacheAddEntryFromHosts(), Ip::Intercept::IpfInterception(), ACLEui64::match(), Ip::Intercept::NetfilterInterception(), networkFromInaddr(), Ftp::ParseProtoIpPort(), Ip::Intercept::PfInterception(), Ip::Intercept::ProbeForTproxy(), IcmpPinger::Recv(), TestIpAddress::testBugNullingDisplay(), TestIpAddress::testCopyConstructor(), TestIpAddress::testDefaults(), TestIpAddress::testHostentConstructor(), TestIpAddress::testInAddr6Constructor(), TestIpAddress::testInAddrConstructor(), TestIpAddress::testMasking(), TestIpAddress::testsetEmpty(), TestIpAddress::testSockAddr6Constructor(), TestIpAddress::testSockAddrConstructor(), and TestIpAddress::testStringConstructor().

◆ isLocalhost()

bool Ip::Address::isLocalhost ( ) const

Content-neutral test for whether the specific IP case LOCALHOST is stored. This is the default content of a new undefined Ip::Address object.

Return values
trueIPv4 127.0.0.1
trueIPv6 ::1
falseanything else.

Definition at line 249 of file Address.cc.

◆ isNoAddr()

bool Ip::Address::isNoAddr ( ) const

Content-neutral test for whether the specific IP case NO_ADDR is stored.

Return values
trueIPv4 255.255.255.255
trueIPv6 ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff
falseanything else.

Definition at line 284 of file Address.cc.

Referenced by asnMatchIp(), Adaptation::Ecap::XactionRep::clientIpValue(), comm_apply_flags(), DelayId::DelayClient(), AccessLogEntry::detailCodeContext(), fqdncache_gethostbyaddr(), AccessLogEntry::getLogClientIp(), htcpIncomingConnectionOpened(), htcpOpenPorts(), HttpStateData::httpBuildRequestHeader(), icpIncomingConnectionOpened(), icpOpenPorts(), idnsInitVC(), Dns::Init(), Adaptation::Icap::ModXact::makeRequestHeaders(), operator>(), operator>=(), snmpOpenPorts(), FwdState::Start(), TestIpAddress::testBugNullingDisplay(), TestIpAddress::testCopyConstructor(), TestIpAddress::testDefaults(), TestIpAddress::testHostentConstructor(), TestIpAddress::testInAddr6Constructor(), TestIpAddress::testInAddrConstructor(), TestIpAddress::testMasking(), TestIpAddress::testsetEmpty(), TestIpAddress::testSockAddr6Constructor(), TestIpAddress::testSockAddrConstructor(), TestIpAddress::testStringConstructor(), acl_ip_data::toStr(), and tunnelStart().

◆ isSiteLocal6()

bool Ip::Address::isSiteLocal6 ( ) const

Test whether content is an IPv6 Site-Local address.

Return values
trueif address begins with fd00::/8.
falseif –disable-ipv6 has been compiled.
falseif address does not match fd00::/8

Definition at line 267 of file Address.cc.

Referenced by Eui::Eui64::lookupSlaac().

◆ isSiteLocalAuto()

bool Ip::Address::isSiteLocalAuto ( ) const

Test whether content is an IPv6 address with SLAAC EUI-64 embedded.

Return values
trueif address matches ::ff:fe00:0
falseif –disable-ipv6 has been compiled.
falseif address does not match ::ff:fe00:0

Definition at line 277 of file Address.cc.

Referenced by Eui::Eui64::lookupSlaac().

◆ isSockAddr()

bool Ip::Address::isSockAddr ( ) const

Test whether content can be used as a Socket address.

Return values
trueif address AND port are both set
trueif content was received as a Socket address with port
falseif port in unset (zero)

Definition at line 152 of file Address.cc.

Referenced by TestIpAddress::testBugNullingDisplay(), TestIpAddress::testCopyConstructor(), TestIpAddress::testDefaults(), TestIpAddress::testHostentConstructor(), TestIpAddress::testInAddr6Constructor(), TestIpAddress::testInAddrConstructor(), TestIpAddress::testsetEmpty(), TestIpAddress::testSockAddr6Constructor(), TestIpAddress::testSockAddrConstructor(), and TestIpAddress::testStringConstructor().

◆ lookupHostIP()

bool Ip::Address::lookupHostIP ( const char *  s,
bool  nodns 
)
private

Definition at line 378 of file Address.cc.

References debugs, Ip::EnableIpv6, and port.

◆ map4to6()

void Ip::Address::map4to6 ( const struct in_addr &  src,
struct in6_addr &  dest 
) const
private

Definition at line 979 of file Address.cc.

◆ map6to4()

void Ip::Address::map6to4 ( const struct in6_addr &  src,
struct in_addr &  dest 
) const
private

Definition at line 1000 of file Address.cc.

◆ matchIPAddr()

int Ip::Address::matchIPAddr ( const Address &  rhs) const

Test how two IP relate to each other.

Return values
0IP are equal
1IP rhs is greater (numerically) than that stored.
-1IP rhs is less (numerically) than that stored.

Definition at line 703 of file Address.cc.

References mSocketAddr_.

Referenced by IdleConnList::findUseable(), and TestIpAddress::testBooleans().

◆ NoAddr()

static const Address & Ip::Address::NoAddr ( )
inlinestatic
Returns
an Address with true isNoAddr()
See also
isNoAddr() for more details

Definition at line 302 of file Address.h.

References v6_noaddr.

Referenced by clientBuildError().

◆ operator!=()

bool Ip::Address::operator!= ( Address const &  s) const

Definition at line 736 of file Address.cc.

References operator==().

◆ operator<()

bool Ip::Address::operator< ( Address const &  rhs) const

Definition at line 768 of file Address.cc.

References isAnyAddr().

◆ operator<=()

bool Ip::Address::operator<= ( Address const &  rhs) const

Definition at line 741 of file Address.cc.

References isAnyAddr().

◆ operator=() [1/8]

bool Ip::Address::operator= ( const char *  s)

Definition at line 366 of file Address.cc.

◆ operator=() [2/8]

bool Ip::Address::operator= ( const struct addrinfo &  s)

Definition at line 545 of file Address.cc.

References assert.

◆ operator=() [3/8]

bool Ip::Address::operator= ( const struct hostent &  s)

Definition at line 501 of file Address.cc.

References IASSERT.

◆ operator=() [4/8]

Ip::Address & Ip::Address::operator= ( struct in6_addr const &  s)

Definition at line 486 of file Address.cc.

◆ operator=() [5/8]

Ip::Address & Ip::Address::operator= ( struct in_addr const &  s)

Definition at line 472 of file Address.cc.

◆ operator=() [6/8]

Ip::Address & Ip::Address::operator= ( struct sockaddr_in const &  s)

Definition at line 430 of file Address.cc.

◆ operator=() [7/8]

Ip::Address & Ip::Address::operator= ( struct sockaddr_in6 const &  s)

Definition at line 459 of file Address.cc.

◆ operator=() [8/8]

Ip::Address & Ip::Address::operator= ( struct sockaddr_storage const &  s)

Definition at line 439 of file Address.cc.

◆ operator==()

bool Ip::Address::operator== ( Address const &  s) const

Definition at line 730 of file Address.cc.

◆ operator>()

bool Ip::Address::operator> ( Address const &  rhs) const

Definition at line 760 of file Address.cc.

References isNoAddr().

◆ operator>=()

bool Ip::Address::operator>= ( Address const &  rhs) const

Definition at line 751 of file Address.cc.

References isNoAddr().

◆ port() [1/2]

unsigned short Ip::Address::port ( ) const

Retrieve the Port if stored.

Return values
0Port is unset or an error occurred.
nPort associated with this address in host native -endian.

Definition at line 778 of file Address.cc.

Referenced by Comm::TcpAcceptor::acceptInto(), Format::Format::assemble(), ClientRequestContext::clientAccessCheck(), clientBeginRequest(), comm_apply_flags(), comm_connect_addr(), comm_local_port(), comm_open(), ProxyProtocol::One::ExtractPort(), ConnStateData::fakeAConnectRequest(), FindListeningPortNumber(), IdleConnList::findUseable(), ftpOpenListenSocket(), GetHostWithPort(), Ftp::Client::handleEpsvReply(), ClientRequestContext::hostHeaderVerify(), htcpHandleTstResponse(), htcpOpenPorts(), icpOpenPorts(), idnsFromKnownNameserver(), ConnStateData::initiateTunneledRequest(), Eui::Eui48::lookup(), PeerSelector::noteIp(), Ftp::ParseIpPort(), Ftp::ParseProtoIpPort(), peerDNSConfigure(), Ip::Intercept::PfInterception(), ConnStateData::postHttpsAccept(), Ip::Intercept::ProbeForTproxy(), process_request(), resolveDestination(), snmpOpenPorts(), TestIpAddress::testBugNullingDisplay(), TestIpAddress::testCopyConstructor(), TestIpAddress::testDefaults(), TestIpAddress::testHostentConstructor(), TestIpAddress::testInAddr6Constructor(), TestIpAddress::testInAddrConstructor(), TestIpAddress::testsetEmpty(), TestIpAddress::testSockAddr6Constructor(), TestIpAddress::testSockAddrConstructor(), TestIpAddress::testStringConstructor(), wccp2ConnectionOpen(), wccp2HereIam(), wccpConnectionOpen(), and whichPeer().

◆ port() [2/2]

unsigned short Ip::Address::port ( unsigned short  port)

Set the Port value for an address. Replaces any previously existing Port value.

Parameters
portPort being assigned in host native -endian.
Return values
0Port is unset or an error occurred.
nPort associated with this address in host native -endian.

Definition at line 784 of file Address.cc.

◆ setAnyAddr()

void Ip::Address::setAnyAddr ( )

Set object to contain the specific IP case ANY_ADDR (format-neutral). see isAnyAddr() for more detail.

Definition at line 177 of file Address.cc.

Referenced by client_Inst(), Log::TcpLogger::doConnect(), acl_ip_data::FactoryParse(), GetHostWithPort(), logfile_mod_udp_open(), netdbExchangeHandleReply(), parse_address(), TestIpAddress::testBooleans(), TestIpAddress::testMasking(), and TestIpAddress::testtoStr().

◆ setEmpty()

void Ip::Address::setEmpty ( )

NOTE: completely empties the Ip::Address structure. Address, Port, Type, everything.

Definition at line 184 of file Address.cc.

Referenced by ACLFilledChecklist::ACLFilledChecklist(), Address(), Comm::TcpAcceptor::acceptInto(), AnyP::Uri::clear(), acl_ip_data::FactoryParse(), free_address(), HttpRequest::init(), ipcCreate(), ACLIP::match(), peerDNSConfigure(), resolveDestination(), and TestIpAddress::testsetEmpty().

◆ setIPv4()

bool Ip::Address::setIPv4 ( )

Require an IPv4-only address for this usage. Converts the object to prefer only IPv4 output.

Return values
trueContent can be IPv4
falseContent CANNOT be IPv4

Definition at line 224 of file Address.cc.

Referenced by comm_local_port(), comm_openex(), Log::TcpLogger::doConnect(), htcpOpenPorts(), icpOpenPorts(), Dns::Init(), logfile_mod_udp_open(), IcmpSquid::Open(), parse_externalAclHelper(), Ip::Intercept::ProbeForTproxy(), snmpOpenPorts(), wccp2ConnectionOpen(), wccp2HandleUdp(), and wccpConnectionOpen().

◆ setLocalhost()

void Ip::Address::setLocalhost ( )

Set object to contain the specific IP case LOCALHOST (format-neutral). see isLocalhost() for more detail.

Definition at line 255 of file Address.cc.

References Ip::EnableIpv6.

Referenced by external_acl::external_acl(), DiskdIOStrategy::init(), logfile_mod_daemon_open(), IcmpSquid::Open(), and unlinkdInit().

◆ setNoAddr()

void Ip::Address::setNoAddr ( )

Set object to contain the specific IP case NO_ADDR (format-neutral). see isNoAddr() for more detail.

Definition at line 292 of file Address.cc.

Referenced by AccessLogEntry::CacheDetails::CacheDetails(), asnAddNet(), clientBeginRequest(), acl_ip_data::DecodeMask(), acl_ip_data::FactoryParse(), htcpAccessAllowed(), icpAccessAllowed(), Acl::DestinationAsnCheck::match(), parse_address(), TestIpAddress::testBooleans(), TestIpAddress::testMasking(), and TestIpAddress::testtoStr().

◆ toHostStr()

unsigned int Ip::Address::toHostStr ( char *  buf,
const unsigned int  len 
) const

Return a properly hostname formatted copy of the address Provides a URL formatted version of the content. If buffer is not large enough the data is truncated silently. eg. 127.0.0.1 (IPv4) or [::1] (IPv6)

Parameters
bufAllocated buffer to write address to
lenbyte length of buffer available for writing.
Returns
amount of buffer filled.

Definition at line 842 of file Address.cc.

Referenced by ConnStateData::fakeAConnectRequest(), Ftp::Server::handleUserRequest(), internalRemoteUri(), and TestIpAddress::testBugNullingDisplay().

◆ toStr()

char * Ip::Address::toStr ( char *  buf,
const unsigned int  blen,
int  force = AF_UNSPEC 
) const

Return the ASCII equivalent of the address Semantically equivalent to the IPv4 inet_ntoa() eg. 127.0.0.1 (IPv4) or ::1 (IPv6) But for memory safety it requires a buffer as input instead of producing one magically. If buffer is not large enough the data is truncated silently.

Parameters
bufAllocated buffer to write address to
lenbyte length of buffer available for writing.
force(optional) require the IPA in a specific format.
Returns
pointer to buffer received.

Definition at line 792 of file Address.cc.

References assert, DBG_CRITICAL, debugs, and min().

Referenced by ClientInfo::ClientInfo(), Comm::TcpAcceptor::acceptInto(), Format::Format::assemble(), client_entry(), clientdbCutoffDenied(), clientdbEstablished(), clientdbGetInfo(), clientdbUpdate(), Adaptation::Ecap::XactionRep::clientIpValue(), comm_connect_addr(), ErrorState::compileLegacyCode(), ErrorState::Dump(), dump_address(), dump_IpAddress_list(), fqdncache_gethostbyaddr(), fqdncache_nbgethostbyaddr(), AccessLogEntry::getLogClientIp(), HttpStateData::httpBuildRequestHeader(), idnsPTRLookup(), ConnStateData::initiateTunneledRequest(), Adaptation::Icap::ModXact::makeRequestHeaders(), netdbHashInsert(), netdbLookupAddr(), peerSourceHashSelectParent(), ConnStateData::postHttpsAccept(), printRadixNode(), snmp_meshCtblFn(), snmp_meshPtblFn(), Log::Format::SquidIcap(), Log::Format::SquidNative(), TestIpAddress::testBugNullingDisplay(), TestIpAddress::testMasking(), TestIpAddress::testtoStr(), and acl_ip_data::toStr().

◆ toUrl()

char * Ip::Address::toUrl ( char *  buf,
unsigned int  len 
) const

Return the ASCII equivalent of the address:port combination Provides a URL formatted version of the content. If buffer is not large enough the data is truncated silently. eg. 127.0.0.1:80 (IPv4) or [::1]:80 (IPv6)

Parameters
bufAllocated buffer to write address:port to
lenbyte length of buffer available for writing.
Returns
pointer to buffer received.

Definition at line 874 of file Address.cc.

References port.

Referenced by Transport::Connect(), PconnPool::key(), Ip::operator<<(), peerCountMcastPeersCreateAndSend(), ConnStateData::pinConnection(), process_request(), fde::remoteAddr(), TestIpAddress::testBugNullingDisplay(), TestIpAddress::testtoUrl_fromInAddr(), and TestIpAddress::testtoUrl_fromSockAddr().

Member Data Documentation

◆ MAX_IP4_STRLEN

const unsigned int Ip::Address::MAX_IP4_STRLEN = STRLEN_IP4R
staticprivate

Definition at line 343 of file Address.h.

◆ MAX_IP6_STRLEN

const unsigned int Ip::Address::MAX_IP6_STRLEN = STRLEN_IP6R
staticprivate

Definition at line 347 of file Address.h.

◆ mSocketAddr_

struct sockaddr_in6 Ip::Address::mSocketAddr_
private

Definition at line 336 of file Address.h.

Referenced by applyMask(), cidr(), and matchIPAddr().

◆ STRLEN_IP4A

const unsigned int Ip::Address::STRLEN_IP4A = 16
staticprivate

Definition at line 340 of file Address.h.

◆ STRLEN_IP4R

const unsigned int Ip::Address::STRLEN_IP4R = 28
staticprivate

Definition at line 341 of file Address.h.

◆ STRLEN_IP4S

const unsigned int Ip::Address::STRLEN_IP4S = 21
staticprivate

Definition at line 342 of file Address.h.

◆ STRLEN_IP6A

const unsigned int Ip::Address::STRLEN_IP6A = 42
staticprivate

Definition at line 344 of file Address.h.

◆ STRLEN_IP6R

const unsigned int Ip::Address::STRLEN_IP6R = 75
staticprivate

Definition at line 345 of file Address.h.

◆ STRLEN_IP6S

const unsigned int Ip::Address::STRLEN_IP6S = 48
staticprivate

Definition at line 346 of file Address.h.

◆ v4_anyaddr

const struct in6_addr Ip::Address::v4_anyaddr
staticprivate

Definition at line 349 of file Address.h.

◆ v4_localhost

const struct in6_addr Ip::Address::v4_localhost
staticprivate

Definition at line 348 of file Address.h.

◆ v4_noaddr

const struct in6_addr Ip::Address::v4_noaddr
staticprivate

Definition at line 350 of file Address.h.

◆ v6_noaddr

const struct in6_addr Ip::Address::v6_noaddr
staticprivate

Definition at line 351 of file Address.h.

Referenced by NoAddr().

The documentation for this class was generated from the following files:

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors