Gizmo3D

gzNetwork.h File Reference

Network utilities. More...

#include "gzBasicTypes.h"
#include "gzMemory.h"
#include "gzDynamic.h"
#include "gzThread.h"
#include "gzNotify.h"

Go to the source code of this file.

Classes

class  gzHostAddress
 Host IP address. More...
class  gzHostInfo
 Host info. More...
class  gzSocketAddress
 Socket address (host address and port). More...
class  gzNetData
 Network data. More...
class  gzSocket
 Socket for network communication. More...

Typedefs

typedef UINT_PTR gzSocketHandle

Enumerations

enum  gzSocketFamily { GZ_SOCKET_FAMILY_INET, GZ_SOCKET_FAMILY_IRDA, GZ_SOCKET_FAMILY_INET6 }
 Socket families. More...
enum  gzSocketType { GZ_SOCKET_TYPE_STREAM, GZ_SOCKET_TYPE_DATAGRAM }
 Socket types. More...
enum  gzSocketOption {
  GZ_SOCKET_OPTION_BROADCAST, GZ_SOCKET_OPTION_DONTROUTE, GZ_SOCKET_OPTION_USE_LINGER, GZ_SOCKET_OPTION_DONT_USE_LINGER,
  GZ_SOCKET_OPTION_KEEPALIVE, GZ_SOCKET_OPTION_REUSE_ADDR_PORT, GZ_SOCKET_OPTION_MULTICAST_TTL, GZ_SOCKET_OPTION_MULTICAST_INTERFACE,
  GZ_SOCKET_OPTION_MULTICAST_LOOPBACK, GZ_SOCKET_OPTION_ADD_MULTICAST_MEMBERSHIP, GZ_SOCKET_OPTION_DROP_MULTICAST_MEMBERSHIP, GZ_SOCKET_OPTION_RECEIVE_BUFFER,
  GZ_SOCKET_OPTION_SEND_BUFFER, GZ_SOCKET_OPTION_RECEIVE_TIMEOUT
}
 Socket options. More...
enum  gzSocketError {
  GZ_SOCKET_ERROR_NO_ERROR = 0, GZ_SOCKET_ERROR_CHECK_FOR_ERROR, GZ_SOCKET_ERROR_UNKNOWN_ERROR, GZ_SOCKET_ERROR_PROTOCOL_FAMILY_NOT_SUPPORTED,
  GZ_SOCKET_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED, GZ_SOCKET_ERROR_PERMISSION_DENIED, GZ_SOCKET_ERROR_PROTOCOL_NOT_SUPPORTED, GZ_SOCKET_ERROR_NETWORK_NOT_INITIALISED,
  GZ_SOCKET_ERROR_CONNECTION_CLOSED, GZ_SOCKET_ERROR_UNKNOWN_SOCKET_OPTION, GZ_SOCKET_ERROR_SOCKET_NOT_CONFIGURED, GZ_SOCKET_ERROR_HOST_UNREACHABLE,
  GZ_SOCKET_ERROR_NETWORK_UNREACHABLE, GZ_SOCKET_ERROR_OPTION_NOT_SUPPORTED, GZ_SOCKET_ERROR_INVALID_DESCRIPTOR, GZ_SOCKET_ERROR_INVALID_ARGUMENT,
  GZ_SOCKET_ERROR_ADDRESS_IN_USE, GZ_SOCKET_ERROR_ADDRESS_NOT_AVAILABLE, GZ_SOCKET_ERROR_IS_CONNECTED, GZ_SOCKET_ERROR_NOT_CONNECTED,
  GZ_SOCKET_ERROR_CONNECTION_RESET, GZ_SOCKET_ERROR_CONNECTION_ABORTED, GZ_SOCKET_ERROR_CONNECTION_REFUSED, GZ_SOCKET_ERROR_CONNECTION_TIMEDOUT,
  GZ_SOCKET_ERROR_WOULD_BLOCK, GZ_SOCKET_ERROR_MESSAGE_SIZE, GZ_SOCKET_ERROR_OPERTATION_ABORTED, GZ_SOCKET_ERROR_NO_DEVICE,
  GZ_SOCKET_ERROR_XXX
}
 Socket error codes. More...
enum  gzHostAddressType { GZ_HOST_ADDRESS_TYPE_INVALID, GZ_HOST_ADDRESS_TYPE_DOT_4 }
 Host address types. More...
enum  gzSocketAddressType { GZ_SOCKET_ADDRESS_TYPE_UNKNOWN, GZ_SOCKET_ADDRESS_TYPE_INET }
 Socket address types. More...

Functions

gzHostInfo getHostInfo ()
gzHostAddress getLocalHostAddress ()
gzHostInfo getHostInfo (const gzString &hostName)
gzHostInfo getHostInfo (const gzHostAddress &hostAddress)
gzString getNetworkClientID ()
gzULong gzSwapNetworkBytesL (gzULong value)
gzUShort gzSwapNetworkBytesS (gzUShort value)

Variables

const gzString GZ_NET_DATA = "NetData"


Detailed Description

Network utilities.

Definition in file gzNetwork.h.


Typedef Documentation

typedef UINT_PTR gzSocketHandle
 

Definition at line 39 of file gzNetwork.h.


Enumeration Type Documentation

enum gzHostAddressType
 

Host address types.

Enumerator:
GZ_HOST_ADDRESS_TYPE_INVALID 
GZ_HOST_ADDRESS_TYPE_DOT_4 

Definition at line 123 of file gzNetwork.h.

enum gzSocketAddressType
 

Socket address types.

Enumerator:
GZ_SOCKET_ADDRESS_TYPE_UNKNOWN 
GZ_SOCKET_ADDRESS_TYPE_INET 

Definition at line 185 of file gzNetwork.h.

enum gzSocketError
 

Socket error codes.

Enumerator:
GZ_SOCKET_ERROR_NO_ERROR 
GZ_SOCKET_ERROR_CHECK_FOR_ERROR 
GZ_SOCKET_ERROR_UNKNOWN_ERROR 
GZ_SOCKET_ERROR_PROTOCOL_FAMILY_NOT_SUPPORTED 
GZ_SOCKET_ERROR_ADDRESS_FAMILY_NOT_SUPPORTED 
GZ_SOCKET_ERROR_PERMISSION_DENIED 
GZ_SOCKET_ERROR_PROTOCOL_NOT_SUPPORTED 
GZ_SOCKET_ERROR_NETWORK_NOT_INITIALISED 
GZ_SOCKET_ERROR_CONNECTION_CLOSED 
GZ_SOCKET_ERROR_UNKNOWN_SOCKET_OPTION 
GZ_SOCKET_ERROR_SOCKET_NOT_CONFIGURED 
GZ_SOCKET_ERROR_HOST_UNREACHABLE 
GZ_SOCKET_ERROR_NETWORK_UNREACHABLE 
GZ_SOCKET_ERROR_OPTION_NOT_SUPPORTED 
GZ_SOCKET_ERROR_INVALID_DESCRIPTOR 
GZ_SOCKET_ERROR_INVALID_ARGUMENT 
GZ_SOCKET_ERROR_ADDRESS_IN_USE 
GZ_SOCKET_ERROR_ADDRESS_NOT_AVAILABLE 
GZ_SOCKET_ERROR_IS_CONNECTED 
GZ_SOCKET_ERROR_NOT_CONNECTED 
GZ_SOCKET_ERROR_CONNECTION_RESET 
GZ_SOCKET_ERROR_CONNECTION_ABORTED 
GZ_SOCKET_ERROR_CONNECTION_REFUSED 
GZ_SOCKET_ERROR_CONNECTION_TIMEDOUT 
GZ_SOCKET_ERROR_WOULD_BLOCK 
GZ_SOCKET_ERROR_MESSAGE_SIZE 
GZ_SOCKET_ERROR_OPERTATION_ABORTED 
GZ_SOCKET_ERROR_NO_DEVICE 
GZ_SOCKET_ERROR_XXX 

Definition at line 83 of file gzNetwork.h.

enum gzSocketFamily
 

Socket families.

Enumerator:
GZ_SOCKET_FAMILY_INET  IPv4.
GZ_SOCKET_FAMILY_IRDA  IrDA.
GZ_SOCKET_FAMILY_INET6  IPv6.

Definition at line 46 of file gzNetwork.h.

enum gzSocketOption
 

Socket options.

Enumerator:
GZ_SOCKET_OPTION_BROADCAST  Enable broadcast.
GZ_SOCKET_OPTION_DONTROUTE 
GZ_SOCKET_OPTION_USE_LINGER  Enable linger with given time value.
GZ_SOCKET_OPTION_DONT_USE_LINGER  Disable linger (value is ignored).
GZ_SOCKET_OPTION_KEEPALIVE 
GZ_SOCKET_OPTION_REUSE_ADDR_PORT 
GZ_SOCKET_OPTION_MULTICAST_TTL 
GZ_SOCKET_OPTION_MULTICAST_INTERFACE 
GZ_SOCKET_OPTION_MULTICAST_LOOPBACK 
GZ_SOCKET_OPTION_ADD_MULTICAST_MEMBERSHIP 
GZ_SOCKET_OPTION_DROP_MULTICAST_MEMBERSHIP 
GZ_SOCKET_OPTION_RECEIVE_BUFFER  Set receive buffer size.
GZ_SOCKET_OPTION_SEND_BUFFER  set send buffer size
GZ_SOCKET_OPTION_RECEIVE_TIMEOUT  set receive timout values

Definition at line 63 of file gzNetwork.h.

enum gzSocketType
 

Socket types.

Enumerator:
GZ_SOCKET_TYPE_STREAM 
GZ_SOCKET_TYPE_DATAGRAM 

Definition at line 55 of file gzNetwork.h.


Function Documentation

gzHostInfo getHostInfo const gzHostAddress hostAddress  ) 
 

gzHostInfo getHostInfo const gzString hostName  ) 
 

gzHostInfo getHostInfo  ) 
 

gzHostAddress getLocalHostAddress  ) 
 

gzString getNetworkClientID  ) 
 

gzULong gzSwapNetworkBytesL gzULong  value  ) 
 

gzUShort gzSwapNetworkBytesS gzUShort  value  ) 
 


Variable Documentation

const gzString GZ_NET_DATA = "NetData"
 

Definition at line 119 of file gzNetwork.h.


Documentation for Gizmo3D generated at Wed Feb 20 11:54:13 2008 by   Saab Training Systems AB, ¸ (c) 2003-and beyond