G3D::NetAddress Class Reference

#include <NetAddress.h>

Public Types
enum	{ DEFAULT_ADAPTER_HOST = 0 }

Public Member Functions
	NetAddress (uint32 host, uint16 port=0)
	NetAddress (const std::string &hostname, uint16 port)
	NetAddress (const std::string &hostnameAndPort)
	NetAddress ()
void	serialize (class BinaryOutput &b) const
void	deserialize (class BinaryInput &b)
bool	ok () const
	Returns true if this is not an illegal address. More...
uint32	ip () const
	Returns a value in host format (i.e., don't worry about endian issues) More...
uint16	port () const
std::string	ipString () const
std::string	toString () const
std::string	hostname () const

Static Public Member Functions
static NetAddress	broadcastAddress (uint16 port)
	Creates a UDP broadcast address for use with a G3D::LightweightConduit. More...
static void	localHostAddresses (Array< NetAddress > &array)
static std::string	localHostname ()

Private Member Functions
void	init (uint32 host, uint16 port)
void	init (const std::string &hostname, uint16 port)
	NetAddress (const SOCKADDR_IN &a)
	NetAddress (const struct in_addr &addr, uint16 port=0)

Private Attributes
SOCKADDR_IN	addr

Friends
class	NetworkDevice
class	LightweightConduit
class	ReliableConduit

Member Enumeration Documentation

anonymous enum

Enumerator
DEFAULT_ADAPTER_HOST	Use the host portion of the IP address of the default adapter on this machine.

 { 
 // Must match ENET_HOST_ANY
 DEFAULT_ADAPTER_HOST = 0
 };

Constructor & Destructor Documentation

G3D::NetAddress::NetAddress ( const SOCKADDR_IN &  a )

private

 {
 addr = a;
}

G3D::NetAddress::NetAddress ( const struct in_addr &  addr, uint16  port = 0  )

private

 {
 #ifdef G3D_WINDOWS
 init(ntohl(addr.S_un.S_addr), port);
 #else
 init(htonl(addr.s_addr), port);
 #endif
}

Here is the call graph for this function:

G3D::NetAddress::NetAddress ( uint32  host, uint16  port = 0  )

explicit

In host byte order.

See also

DEFAULT_ADAPTER_HOST

 {
 init(hostip, port);
}

Here is the call graph for this function:

G3D::NetAddress::NetAddress	(	const std::string &	hostname,
		uint16	port
	)

Parameters

port	Specified in host byte order (i.e., don't worry about endian issues)

 {
 init(hostname, port);
}

G3D::NetAddress::NetAddress ( const std::string &  hostnameAndPort )

explicit

Parameters

hostnameAndPort

in the form "hostname:port" or "ip:port"

 {

 Array<std::string> part = stringSplit(hostnameAndPort, ':');

 debugAssert(part.length() == 2);
 init(part[0], atoi(part[1].c_str()));
}

Here is the call graph for this function:

G3D::NetAddress::NetAddress

(

)

 {
 System::memset(&addr, 0, sizeof(addr));
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

NetAddress G3D::NetAddress::broadcastAddress ( uint16  port )

static

Creates a UDP broadcast address for use with a G3D::LightweightConduit.

Deprecated:

Use G3D::NetworkDevice::broadcastAddressArray()

UDP broadcast allows one machine to send a packet to all machines on the same local network. The IP portion of the address is 0xFFFFFFFF, which indicates "broadcast" to the underlying socket API. This feature is not available with the connection-based TCP protocol abstracted by G3D::ReliableConduit; use multisend instead.

 {
 return NetAddress(NetworkDevice::instance()->broadcastAddressArray()[0], port);
}

Here is the call graph for this function:

void G3D::NetAddress::deserialize

(

class BinaryInput &

b

)

 {
 uint32 i;
 uint16 p;

 i = b.readUInt32();
 p = b.readUInt16();

 init(i, p);
}

Here is the call graph for this function:

std::string G3D::NetAddress::hostname

(

)

const

Name of this address, without the domain. Performs reverse DNS lookup on this address. This may make a network connection to a DNS server and block until that communication completes if the address is one that has not been recently checked.

void G3D::NetAddress::init ( uint32  host, uint16  port  )

private

Host byte order

 {
 if ((host != 0) || (port != 0)) {
 addr.sin_family = AF_INET;
 addr.sin_port = htons(port);
 if (host == 0) {
 host = INADDR_ANY;
 }
 addr.sin_addr.s_addr = htonl(host);
 } else {
 System::memset(&addr, 0, sizeof(addr));
 }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G3D::NetAddress::init ( const std::string &  hostname, uint16  port  )

private

 {

 uint32 addr;
 
 if (hostname == "") {
 addr = INADDR_NONE;
 } else {
 addr = inet_addr(hostname.c_str());
 }

 // The address wasn't in numeric form, resolve it
 if (addr == INADDR_NONE) {
 // Get the IP address of the server and store it in host
 struct hostent* host = gethostbyname(hostname.c_str());

 if (host == NULL) {
 init(0, 0);
 return;
 }

 System::memcpy(&addr, host->h_addr_list[0], host->h_length);
 }

 if (addr != INADDR_NONE) {
 addr = ntohl(addr);
 }
 init(addr, port);
}

Here is the call graph for this function:

uint32 G3D::NetAddress::ip ( ) const

inline

Returns a value in host format (i.e., don't worry about endian issues)

 {
 return ntohl(addr.sin_addr.s_addr);
 //return ntohl(addr.sin_addr.S_un.S_addr);
 }

Here is the caller graph for this function:

std::string G3D::NetAddress::ipString

(

)

const

 {
 return format("%s", inet_ntoa(*(in_addr*)&(addr.sin_addr)));
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G3D::NetAddress::localHostAddresses ( Array< NetAddress > &  array )

static

 {
 array.resize(0);

 char ac[256];

 if (gethostname(ac, sizeof(ac)) == SOCKET_ERROR) {
 Log::common()->printf("Error while getting local host name\n");
 return;
 }

 struct hostent* phe = gethostbyname(ac);
 if (phe == 0) {
 Log::common()->printf("Error while getting local host address\n");
 return;
 }

 for (int i = 0; (phe->h_addr_list[i] != 0); ++i) {
 struct in_addr addr;
 memcpy(&addr, phe->h_addr_list[i], sizeof(struct in_addr));
 array.append(NetAddress(addr));
 } 
}

Here is the call graph for this function:

static std::string G3D::NetAddress::localHostname ( )

static

Name of the local machine machine, without the domain. The value is cached after the first call.

bool G3D::NetAddress::ok

(

)

const

Returns true if this is not an illegal address.

 {
 return addr.sin_family != 0;
}

uint16 G3D::NetAddress::port ( ) const

inline

 {
 return ntohs(addr.sin_port);
 }

Here is the caller graph for this function:

void G3D::NetAddress::serialize

(

class BinaryOutput &

b

)

const

 {
 b.writeUInt32(ip());
 b.writeUInt16(port());
}

Here is the call graph for this function:

std::string G3D::NetAddress::toString

(

)

const

 {
 return ipString() + format(":%d", ntohs(addr.sin_port));
}

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class LightweightConduit

friend

friend class NetworkDevice

friend

friend class ReliableConduit

friend

Member Data Documentation

SOCKADDR_IN G3D::NetAddress::addr

private

---

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

• dep/g3dlite/include/G3D/NetAddress.h
• dep/g3dlite/source/NetAddress.cpp