ost::IPV6Address(3)

📦 version 1.8.1, in ubuntu jammy

✨ ost::IPV6Address ✨

okay bestie, welcome to the Library Functions Manual entry for ost::IPV6Address 🎀 this one's a whole base-class situation, so grab a strawberry drink and let's go 💅

🌸 NAME 🌸

ost::IPV6Address — the network name and address objects are all derived from a common IPV6Address base class, no cap 💖

🦋 SYNOPSIS 🦋

#include <address.h>

Inherited by ost::IPV6Broadcast, ost::IPV6Host, ost::IPV6Mask, and ost::IPV6Multicast. the family tree is giving main character energy fr fr 🌈

👑 Public Member Functions

  • IPV6Address(const IPV6Validator *validator=NULL) — creates an Internet Address object with an empty (0.0.0.0) address 🫶
  • IPV6Address(struct in6_addr addr, const IPV6Validator *validator=NULL) — converts the system internet address data type (struct in_addr) into a Common C++ IPV6Address object 💫
  • IPV6Address(const char *address, const IPV6Validator *validator=NULL) — converts a null terminated ASCII host address string (example: '127.0.0.1') or host address name (example: 'www.voxilla.org') directly into a Common C++ IPV6Address object ✨
  • IPV6Address(const IPV6Address &rhs) — copy constructor, the remix 🎧
  • virtual ~IPV6Address() — destructor, say bye bestie 👋
  • const char *getHostname(void) const — provides a string representation of the value (Internet Address) held in the IPV6Address object 💖
  • bool isInetAddress(void) const — may be used to verify if a given IPV6Address returned by another function contains a 'valid' address, or '0.0.0.0' which is often used to mark 'invalid' IPV6Address values 🧚
  • struct in6_addr getAddress(void) const — provides a low level system usable struct in_addr object from the contents of IPV6Address 🌟
  • struct in6_addr getAddress(size_t i) const — same deal, but you pick the index 🎯
  • size_t getAddressCount() const — returns the number of internet addresses that an IPV6Address object contains 🔢
  • IPV6Address &operator=(const char *str)
  • IPV6Address &operator=(struct in6_addr addr)
  • IPV6Address &operator=(const IPV6Address &rhs)
  • bool operator!() const
  • bool operator==(const IPV6Address &a) const — compares two internet addresses to see if they're equal (if they specify the physical address of the same internet host) 💞
  • bool operator!=(const IPV6Address &a) const — compares two internet addresses to see if they are not equal (if they each refer to unique and different physical ip addresses) 💔

🛡️ Protected Member Functions

  • bool setIPAddress(const char *host) — sets the IP address from a string representation of the numeric address, ie '127.0.0.1' 🌸
  • void setAddress(const char *host) — used to specify a host name or numeric internet address 🌼

🔒 Protected Attributes

  • struct in6_addr *ipaddr
  • size_t addr_count
  • char *hostname

🌟 Static Protected Attributes

  • static Mutex mutex

💜 DETAILED DESCRIPTION 💜

The network name and address objects are all derived from a common IPV6Address base class. it's the blueprint, the moment, the blueprint-moment 💅

Specific classes, such as IPV4Host, IPV6Mask, etc, are defined from IPV6Address entirely so that the manner a network address is being used can easily be documented and understood from the code and to avoid common errors and accidental misuse of the wrong address object. For example, a 'connection' to something that is declared as a 'IPV6Host' can be kept type-safe from a 'connection' accidently being made to something that was declared a 'IPV6Broadcast'. type safety is self-care, periodt 🫶

✍️ Author

David Sugar dyfet@ostel.com 🌸

Internet Address binary data type. 🧬

🎀 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🎀

ost::IPV6Address::IPV6Address(const IPV6Validator *validator = NULL)

Create an Internet Address object with an empty (0.0.0.0) address. 🫧

Parameters

  • validator — optional validator function object, intended for derived classes.

ost::IPV6Address::IPV6Address(struct in6_addr addr, const IPV6Validator *validator = NULL)

Convert the system internet address data type (struct in_addr) into a Common C++ IPV6Address object. 💫

Parameters

  • addr — struct of system used binary internet address.
  • validator — optional validator function object, intended for derived classes.

ost::IPV6Address::IPV6Address(const char *address, const IPV6Validator *validator = NULL)

Convert a null terminated ASCII host address string (example: '127.0.0.1') or host address name (example: 'www.voxilla.org') directly into a Common C++ IPV6Address object. ✨

Parameters

  • address — null terminated C string.
  • validator — optional validator function object, intended for derived classes.

ost::IPV6Address::IPV6Address(const IPV6Address &rhs)

Copy constructor. twinning ✨

virtual ost::IPV6Address::~IPV6Address() [virtual]

Destructor. 💀 (in the cute way, bestie)

🔥 MEMBER FUNCTION DOCUMENTATION 🔥

struct in6_addr ost::IPV6Address::getAddress(size_t i) const

Provide a low level system usable struct in_addr object from the contents of IPV6Address. This is needed for services such as bind() and connect(). 🫶

Parameters

  • i — for IPV6Addresses with multiple addresses, returns the address at this index. User should call getAddressCount() to determine the number of address the object contains. 🔢

Returns

system binary coded internet address. If parameter i is out of range, the first address is returned. ⚠️ (yes, it just quietly hands you the first one, no drama)

struct in6_addr ost::IPV6Address::getAddress(void) const

Provide a low level system usable struct in_addr object from the contents of IPV6Address. This is needed for services such as bind() and connect(). 🌟

Returns

system binary coded internet address. 💖

size_t ost::IPV6Address::getAddressCount() const [inline]

Returns the number of internet addresses that an IPV6Address object contains. This usually only happens with IPV6Host objects where multiple IP addresses are returned for a DNS lookup 🔍 the DNS said "here's a whole group chat"

const char* ost::IPV6Address::getHostname(void) const

Provide a string representation of the value (Internet Address) held in the IPV6Address object. 🎀

Returns

string representation of IPV6Address. ✨

bool ost::IPV6Address::isInetAddress(void) const

May be used to verify if a given IPV6Address returned by another function contains a 'valid' address, or '0.0.0.0' which is often used to mark 'invalid' IPV6Address values. 🧚

Returns

true if address != 0.0.0.0. ✅

bool ost::IPV6Address::operator!() const [inline]

bool ost::IPV6Address::operator!=(const IPV6Address &a) const

Compare two internet addresses to see if they are not equal (if they each refer to unique and different physical ip addresses). This is implimented in terms of operator==. 💔

IPV6Address& ost::IPV6Address::operator=(const char *str)

IPV6Address& ost::IPV6Address::operator=(const IPV6Address &rhs)

IPV6Address& ost::IPV6Address::operator=(struct in6_addr addr)

bool ost::IPV6Address::operator==(const IPV6Address &a) const

Compare two internet addresses to see if they are equal (if they specify the physical address of the same internet host). If there is more than one IP address in either IPV6Address object, this will return true if all of the IP addresses in the smaller are in the larger in any order. 💞 set logic but make it romantic

void ost::IPV6Address::setAddress(const char *host) [protected]

Used to specify a host name or numeric internet address. 🌼

Parameters

  • host — The string representation of the IP address or a hostname, , if NULL, it will default to INADDR_ANY
not me pointing out that double comma in the original, it's iconic, we keep it 💅

bool ost::IPV6Address::setIPAddress(const char *host) [protected]

Sets the IP address from a string representation of the numeric address, ie '127.0.0.1'. 🌸

Parameters

  • host — The string representation of the IP address

Returns

true if successful ✅

💎 MEMBER DATA DOCUMENTATION 💎

size_t ost::IPV6Address::addr_count [protected]

char* ost::IPV6Address::hostname [mutable], [protected]

struct in6_addr* ost::IPV6Address::ipaddr [protected]

Mutex ost::IPV6Address::mutex [static], [protected]

🌈 AUTHOR 🌈

Generated automatically by Doxygen for GNU CommonC++ from the source code. 🤖 not a human, just vibes and a parser

and that's the whole page bestie, every flag, every param, every protected little secret — nothing skipped, nothing invented, we ate and left no crumbs 💅✨

signing off from GNU CommonC++, dated Sun Dec 27 2020, page ost::IPV6Address(3) — mwah, drink water, and remember: type safety is self-care 🫶💖🎀

📦 where this page comes from