namespace Core::Sockets::Network

Overview

namespace Network {

// global functions

bool startup();
void shutdown();
bool getLocalHostname(CString256& hostname);
bool getLocalIPAddress(IPAddress& address);
void getLocalIPAddressList(Vector<IPAddress>& addressList);
int getLocalIPAddressList(IPAddress addressList[], int maxCount);
int getLocalIPAddressListUnique(IPAddress addressList[], int maxCount);
bool getInterfaceNameForIP(CString32& interfaceName, const IPAddress& ip);
bool getLocalMACAddress(uint8 mac[6]);
bool getLocalMACAddress(CString32& address);
void getMACAddressString(CString32& address, const uint8 mac[6]);
bool getAddressByHost(SocketAddress& address, CStringPtr hostname);
bool getHostByAddress(CString256& hostname, const SocketAddress& address);
bool getAddressString(CString256& string, const SocketAddress& address);
bool getAddressFromString(SocketAddress& address, CStringPtr string);

} // namespace Network

Detailed Documentation

Network utility functions.

Global Functions

bool startup()

Start underlying network APIs (WSAStartup on Windows).

void shutdown()

Shutdown underlying network APIs.

bool getLocalHostname(CString256& hostname)

Get local host name.

bool getLocalIPAddress(IPAddress& address)

Get local IP address.

void getLocalIPAddressList(Vector<IPAddress>& addressList)

Get list of all local IP addresses.

int getLocalIPAddressListUnique(IPAddress addressList[], int maxCount)

Get list of all local IP addresses.

Return unique subnet addresses only.

bool getInterfaceNameForIP(CString32& interfaceName, const IPAddress& ip)

Get network adapter name for local IP address.

bool getLocalMACAddress(uint8 mac[6])

Get local MAC address.

void getMACAddressString(CString32& address, const uint8 mac[6])

Convert MAC address to string representation.

bool getAddressByHost(SocketAddress& address, CStringPtr hostname)

Resolve hostname to socket address.

bool getHostByAddress(CString256& hostname, const SocketAddress& address)

Resolve socket address to host name.

bool getAddressString(CString256& string, const SocketAddress& address)

Convert socket address to string representation.

bool getAddressFromString(SocketAddress& address, CStringPtr string)

Scan socket address from string representation.