G3D::NetworkDevice Class Reference

Abstraction of network (socket) functionality. More...

#include <NetworkDevice.h>

Classes
class	EthernetAdapter
	Description of an ethernet or wireless ethernet adapter. More...

Public Member Functions
	~NetworkDevice ()
const Array< EthernetAdapter > &	adapterArray () const
const Array< uint32 > &	broadcastAddressArray () const
void	describeSystem (TextOutput &t)
void	describeSystem (std::string &s)
std::string	localHostName () const
void	localHostAddresses (Array< NetAddress > &array) const

Static Public Member Functions
static std::string	formatIP (uint32 ip)
static std::string	formatMAC (const uint8 mac[6])
static NetworkDevice *	instance ()
static void	cleanup ()

Private Member Functions
void	closesocket (SOCKET &sock) const
bool	bind (SOCKET sock, const NetAddress &addr) const
	NetworkDevice ()
bool	init ()
void	_cleanup ()
void	addAdapter (const EthernetAdapter &a)

Private Attributes
bool	initialized
Array< EthernetAdapter >	m_adapterArray
Array< uint32 >	m_broadcastAddresses

Static Private Attributes
static NetworkDevice *	s_instance = NULL

Friends
class	Conduit
class	LightweightConduit
class	ReliableConduit
class	NetListener

Detailed Description

Abstraction of network (socket) functionality.

An abstraction over sockets that provides a message-based network infrastructure optimized for sending many small (~500 bytes) messages. All functions always return immediately.

Create only one NetworkDevice per process (a WinSock restriction).

NetworkDevice is technically not thread safe. However, as long as you use different conduits on different threads (or lock conduits before sending), you will encounter no problems sharing the single NetworkDevice across multiple threads. That is, do not invoke the same Conduit's send or receive method on two threads at once.

This assumes that the underlying WinSock/BSD sockets implementation is thread safe. That is not guaranteed, but in practice seems to always be true (see http://tangentsoft.net/wskfaq/intermediate.html#threadsafety)

---

IP networks use "network byte order" (big-endian) for communicating integers. "Host byte order" is the endian-ness of the local machine (typically little-endian; see System::endian). The C functions htonl() and ntohl() convert 32-bit values between these formats. G3D only ever exposes host byte order, so programmers rarely need to be aware of the distinction.

Deprecated:

Constructor & Destructor Documentation

G3D::NetworkDevice::NetworkDevice ( )

private

 {
 initialized = false;
}

Here is the caller graph for this function:

G3D::NetworkDevice::~NetworkDevice

(

)

 {
}

Member Function Documentation

void G3D::NetworkDevice::_cleanup ( )

private

 {
 debugAssert(initialized);

# ifdef G3D_WINDOWS
 // Now handled through enet
// WSACleanup();
# endif
}

Here is the caller graph for this function:

const Array<EthernetAdapter>& G3D::NetworkDevice::adapterArray ( ) const

inline

Returns the available ethernet adapters for the current machine that are online. Does not include the loopback adapter for localhost.

 {
 return m_adapterArray;
 }

void G3D::NetworkDevice::addAdapter ( const EthernetAdapter &  a )

private

Called from init to update m_adapterArray and m_broadcastAddresses.

 {
 m_adapterArray.append(a);
 if (a.broadcast != 0) {
 int i = m_broadcastAddresses.findIndex(a.broadcast);
 if (i == -1) {
 m_broadcastAddresses.append(a.broadcast);
 }
 }
}

Here is the call graph for this function:

bool G3D::NetworkDevice::bind ( SOCKET  sock, const NetAddress &  addr  ) const

private

Utility method. Returns true on success.

 {
 Log::common()->printf("Binding socket %d on port %d ", 
 sock, htons(addr.addr.sin_port));
 if (::bind(sock, (struct sockaddr*)&(addr.addr), sizeof(addr.addr)) == 
 SOCKET_ERROR) {

 Log::common()->println("FAIL");
 Log::common()->println(socketErrorCode());
 closesocket(sock);
 return false;
 }

 Log::common()->println("Ok");
 return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

const Array<uint32>& G3D::NetworkDevice::broadcastAddressArray ( ) const

inline

Returns the (unique) IP addresses for UDP broadcasting extracted from adapterArray(). All are in host byte order.

 {
 return m_broadcastAddresses;
 }

void G3D::NetworkDevice::cleanup ( )

static

Shuts down the network device (destroying the global instance).

 {
 if (s_instance) {
 s_instance->_cleanup();
 delete s_instance;
 s_instance = NULL;
 }
}

Here is the call graph for this function:

void G3D::NetworkDevice::closesocket ( SOCKET &  sock ) const

private

Utility method.

 {
 if (sock != 0) {
 #ifdef G3D_WINDOWS
 ::closesocket(sock);
 #else
 close(sock);
 #endif

 Log::common()->printf("Closed socket %d\n", sock);
 sock = 0;
 }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G3D::NetworkDevice::describeSystem

(

TextOutput &

t

)

Prints a human-readable description of this machine to the text output stream.

 {

 t.writeSymbols("Network", "=", "{");
 t.writeNewline();
 t.pushIndent();
 
 for (int i = 0; i < m_adapterArray.size(); ++i) {
 t.printf("Adapter%d =", i);
 m_adapterArray[i].describe(t);
 }

 t.popIndent();
 t.writeSymbols("};");
 t.writeNewline();
 t.writeNewline();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G3D::NetworkDevice::describeSystem

(

std::string &

s

)

 {

 TextOutput t;
 describeSystem(t);
 t.commitString(s);
}

Here is the call graph for this function:

std::string G3D::NetworkDevice::formatIP ( uint32  ip )

static

Prints an IP address to a string.

Parameters

ip	In host byte order.

 {
 return format("%3d.%3d.%3d.%3d", (addr >> 24) & 0xFF, (addr >> 16) & 0xFF,
 (addr >> 8) & 0xFF, addr & 0xFF);
}

Here is the call graph for this function:

Here is the caller graph for this function:

std::string G3D::NetworkDevice::formatMAC ( const uint8  mac[6] )

static

Prints a MAC address to a string.

 {
 return format("%02x:%02x:%02x:%02x:%02x:%02x", MAC[0], MAC[1], MAC[2], MAC[3], MAC[4], MAC[5]);
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool G3D::NetworkDevice::init ( )

private

Here is the caller graph for this function:

NetworkDevice * G3D::NetworkDevice::instance ( )

static

Returns NULL if there was a problem initializing the network.

 {
 if (s_instance == NULL) {
 s_instance = new NetworkDevice();
 if (! s_instance->init()) {
 delete s_instance;
 s_instance = NULL;
 }
 }
 return s_instance;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G3D::NetworkDevice::localHostAddresses

(

Array< NetAddress > &

array

)

const

There is often more than one address for the local host. This returns all of them.

Deprecated:

Use adapterArray()

 {
 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:

Here is the caller graph for this function:

std::string G3D::NetworkDevice::localHostName

(

)

const

Returns the name (or one of the names) of this computer

 { 
 char ac[128];
 if (gethostname(ac, sizeof(ac)) == -1) {
 Log::common()->printf("Error while getting local host name\n");
 return "localhost";
 }
 return gethostbyname(ac)->h_name;
}

Here is the call graph for this function:

Friends And Related Function Documentation

friend class Conduit

friend

friend class LightweightConduit

friend

friend class NetListener

friend

friend class ReliableConduit

friend

Member Data Documentation

bool G3D::NetworkDevice::initialized

private

Array<EthernetAdapter> G3D::NetworkDevice::m_adapterArray

private

Array<uint32> G3D::NetworkDevice::m_broadcastAddresses

private

Broadcast addresses available on this machine, extracted from m_adapterArray.

NetworkDevice * G3D::NetworkDevice::s_instance = NULL

staticprivate

The global instance

---

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

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