E-MailRelay
Public Types | Public Member Functions | Static Public Member Functions | List of all members
GNet::Address4 Class Reference

A 'sockaddr' wrapper class for IPv4 addresses. More...

#include <gaddress4.h>

Public Types

using sockaddr_type = sockaddr_in
 

Public Member Functions

 Address4 (unsigned int)
 
 Address4 (std::string_view)
 
 Address4 (std::string_view, std::string_view)
 
 Address4 (unsigned int port, int)
 
 Address4 (const sockaddr *addr, socklen_t len)
 
const sockaddr * address () const
 
sockaddr * address ()
 
unsigned long scopeId (unsigned long default_=0UL) const
 
unsigned int port () const
 
void setPort (unsigned int port)
 
bool setZone (std::string_view ipv6_zone_name_or_scope_id)
 
void setScopeId (unsigned long ipv6_scope_id)
 
bool same (const Address4 &other, bool ipv6_compare_with_scope=false) const
 
bool sameHostPart (const Address4 &other) const
 
bool isLoopback () const
 
bool isLocal (std::string &) const
 
bool isLinkLocal () const
 
bool isUniqueLocal () const
 
bool isMulticast () const
 
bool isAny () const
 
unsigned int bits () const
 
std::string displayString (bool ipv6_with_scope=false) const
 
std::string hostPartString () const
 
std::string queryString () const
 
G::StringArray wildcards () const
 

Static Public Member Functions

static int domain () noexcept
 
static unsigned short af () noexcept
 
static socklen_t length () noexcept
 
static bool validString (std::string_view, std::string *=nullptr)
 
static bool validStrings (std::string_view, std::string_view, std::string *=nullptr)
 
static bool validPort (unsigned int port)
 
static bool validData (const sockaddr *addr, socklen_t len)
 
static bool format (std::string_view)
 

Detailed Description

A 'sockaddr' wrapper class for IPv4 addresses.

Definition at line 37 of file gaddress4.h.

Member Typedef Documentation

◆ sockaddr_type

using GNet::Address4::sockaddr_type = sockaddr_in

Definition at line 40 of file gaddress4.h.

Constructor & Destructor Documentation

◆ Address4() [1/5]

GNet::Address4::Address4 ( unsigned int  port)
explicit

Definition at line 62 of file gaddress4.cpp.

◆ Address4() [2/5]

GNet::Address4::Address4 ( std::string_view  display_string)
explicit

Definition at line 99 of file gaddress4.cpp.

◆ Address4() [3/5]

GNet::Address4::Address4 ( std::string_view  host_part,
std::string_view  port_part 
)

Definition at line 89 of file gaddress4.cpp.

◆ Address4() [4/5]

GNet::Address4::Address4 ( unsigned int  port,
int   
)

Definition at line 70 of file gaddress4.cpp.

◆ Address4() [5/5]

GNet::Address4::Address4 ( const sockaddr *  addr,
socklen_t  len 
)

Definition at line 78 of file gaddress4.cpp.

Member Function Documentation

◆ address() [1/2]

sockaddr * GNet::Address4::address ( )

Definition at line 261 of file gaddress4.cpp.

◆ address() [2/2]

const sockaddr * GNet::Address4::address ( ) const

Definition at line 255 of file gaddress4.cpp.

◆ af()

unsigned short GNet::Address4::af ( )
staticnoexcept

Definition at line 45 of file gaddress4.cpp.

◆ bits()

unsigned int GNet::Address4::bits ( ) const

Definition at line 394 of file gaddress4.cpp.

◆ displayString()

std::string GNet::Address4::displayString ( bool  ipv6_with_scope = false) const

Definition at line 163 of file gaddress4.cpp.

◆ domain()

int GNet::Address4::domain ( )
staticnoexcept

Definition at line 50 of file gaddress4.cpp.

◆ format()

bool GNet::Address4::format ( std::string_view  s)
static

Definition at line 373 of file gaddress4.cpp.

◆ hostPartString()

std::string GNet::Address4::hostPartString ( ) const

Definition at line 171 of file gaddress4.cpp.

◆ isAny()

bool GNet::Address4::isAny ( ) const

Definition at line 444 of file gaddress4.cpp.

◆ isLinkLocal()

bool GNet::Address4::isLinkLocal ( ) const

Definition at line 423 of file gaddress4.cpp.

◆ isLocal()

bool GNet::Address4::isLocal ( std::string &  reason) const

Definition at line 403 of file gaddress4.cpp.

◆ isLoopback()

bool GNet::Address4::isLoopback ( ) const

Definition at line 417 of file gaddress4.cpp.

◆ isMulticast()

bool GNet::Address4::isMulticast ( ) const

Definition at line 438 of file gaddress4.cpp.

◆ isUniqueLocal()

bool GNet::Address4::isUniqueLocal ( ) const

Definition at line 429 of file gaddress4.cpp.

◆ length()

socklen_t GNet::Address4::length ( )
staticnoexcept

Definition at line 266 of file gaddress4.cpp.

◆ port()

unsigned int GNet::Address4::port ( ) const

Definition at line 244 of file gaddress4.cpp.

◆ queryString()

std::string GNet::Address4::queryString ( ) const

Definition at line 182 of file gaddress4.cpp.

◆ same()

bool GNet::Address4::same ( const Address4 other,
bool  ipv6_compare_with_scope = false 
) const

Definition at line 222 of file gaddress4.cpp.

◆ sameHostPart()

bool GNet::Address4::sameHostPart ( const Address4 other) const

Definition at line 231 of file gaddress4.cpp.

◆ scopeId()

unsigned long GNet::Address4::scopeId ( unsigned long  default_ = 0UL) const

Definition at line 249 of file gaddress4.cpp.

◆ setPort()

void GNet::Address4::setPort ( unsigned int  port)

Definition at line 132 of file gaddress4.cpp.

◆ setScopeId()

void GNet::Address4::setScopeId ( unsigned long  ipv6_scope_id)

Definition at line 159 of file gaddress4.cpp.

◆ setZone()

bool GNet::Address4::setZone ( std::string_view  ipv6_zone_name_or_scope_id)

Definition at line 154 of file gaddress4.cpp.

◆ validData()

bool GNet::Address4::validData ( const sockaddr *  addr,
socklen_t  len 
)
static

Definition at line 189 of file gaddress4.cpp.

◆ validPort()

bool GNet::Address4::validPort ( unsigned int  port)
static

Definition at line 215 of file gaddress4.cpp.

◆ validString()

bool GNet::Address4::validString ( std::string_view  s,
std::string *  reason_p = nullptr 
)
static

Definition at line 194 of file gaddress4.cpp.

◆ validStrings()

bool GNet::Address4::validStrings ( std::string_view  host_part,
std::string_view  port_part,
std::string *  reason_p = nullptr 
)
static

Definition at line 203 of file gaddress4.cpp.

◆ wildcards()

G::StringArray GNet::Address4::wildcards ( ) const

Definition at line 271 of file gaddress4.cpp.


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