GNE Namespace Reference

 {
  "No error.",
  "The remote end did not follow the specifications of the GNE protocol.",
  "The remote end uses an earlier version of the GNE protocol.",
  "The remote end uses a later version of the GNE protocol.",
  "The connecting game names differ.",
  "The user protocol version numbers do not match.",
  "Could not open a network socket.",
  "Could not contact the host due to connection timeout.",
  "The connection attempt was aborted.",
  "The remote end decided to refuse your connection request.",
  "Remote computer suddenly disconnected without warning, or dropped.",
  "The operation was canceled because the SyncConnection is released.",
  "The remote end sent a connection close notice.",
  "Network error when trying to read from connection.",
  "Network error when trying to write to connection.",
  "Unknown packet type encountered -- possible additional data loss.",
  "Packet type received does not match next packet type expected.",
  "An object with the given ID already exists.",
  "The given object ID does not match a known object.",
  "A packet of the wrong type was passed to the ObjectBroker.",
  "The packet ID is not registered as a valid object creation packet.",
  "Buffer underflow error (attempt to read more bytes than available).",
  "Buffer overflow error (attempt to write more bytes than the buffer can hold).",
  "An invalid value for position was given to Buffer::setPosition",
  "An invalid value for limit was given to Buffer::setLimit",
  "Other GNE (not a low-level network) error.",
  "Low-level HawkNL error:",
  "User-defined Error"
}


Compounds
class	Address
class	Buffer
	The Buffer class provides functionality to pull data types out of a raw binary data buffer. More...
class	BufferError
class	ChannelPacket
class	ChannelProvider
struct	ChannelProvider::Channel
class	ClientConnection
class	ClientConnectionParams
	Simply just a class to temporarily hold connection parameters until the ClientConnection is connected, then it is useless. More...
class	ConditionVariable
struct	ConditionVariable::ConditionVariableData
class	Connection
class	Connection::Listener
class	ConnectionEventGenerator
class	ConnectionListener
class	ConnectionParams
struct	ConnectionStats
class	ConsoleBuffer
class	Counter
class	CustomPacket
class	Error
class	EventThread
class	ExitPacket
struct	GNEProtocolVersionNumber
class	ListServerConnection
struct	ListServerConnection::GameListData
	Data about each game. More...
class	Lock
class	LockEx
class	LowLevelError
class	Mutex
struct	Mutex::MutexData
class	NetworkObject
class	NullDeleter
	Deleter that does nothing for the SmartPtr. More...
class	ObjectBroker
class	ObjectBrokerClient
class	ObjectBrokerPacket
class	ObjectBrokerServer
class	ObjectCreationPacket
class	ObjectDeathPacket
class	ObjectUpdatePacket
class	Packet
class	PacketFeeder
class	PacketStream
class	PacketTypeMismatch
struct	PingInformation
class	PingPacket
class	ProtocolViolation
class	RateAdjustPacket
class	ReceiveEventListener
class	SafeCount
class	ServerConnection
class	ServerConnectionListener
class	ServerConnectionListener::ServerListener
class	ServerConnectionParams
	Simply just a class to temporarily hold connection parameters until the ClientConnection is connected, then it is useless. More...
class	SmartPtr
class	SocketPair
class	SyncConnection
class	SynchronizedObject
class	Thread
struct	Thread::ThreadIDData
class	Time
class	Timer
class	TimerCallback
class	UnknownPacket
class	UserError
class	UserVersionMismatch
class	WeakPtr
class	WrapperPacket
class	WrongGame
Typedefs
typedef std::list< Connection * >::iterator	ChannelIterator
typedef std::vector< ServerConnectionListener::sptr >	SCLList
typedef SCLList::iterator	SCLListIter
typedef pthread_t	ID
typedef std::map< ID, Thread::sptr >	ThreadMap
typedef ThreadMap::iterator	ThreadMapIter
typedef signed char	gint8
	Typedefs for the variable types that are common to all GNE implementations (as defined in the GNE protocol document).
typedef unsigned char	guint8
typedef guint8	gbyte
typedef guint8	gbool
	A gbool is 'false' only when its value is 0, else it is 'true'.
typedef signed short	gint16
typedef unsigned short	guint16
typedef signed int	gint32
typedef unsigned int	guint32
typedef float	gsingle
	A single precision 32-bit IEEE 754 floating point variable.
typedef double	gdouble
	A double precision 64-bit IEEE 754 floating point variable.
typedef Lock< Mutex >	LockMutex
typedef Lock< ConditionVariable >	LockCV
typedef Lock< SynchronizedObject >	LockObject
	Locks a SynchronizedObject.
typedef LockEx< Mutex >	LockMutexEx
typedef LockEx< ConditionVariable >	LockCVEx
typedef LockEx< SynchronizedObject >	LockObjectEx
typedef NetworkObject (	ObjCreationFunc )(int objectId, const Packet &)
Functions
bool	initGNE (NLenum networkType, int(atexit_ptr)(void(func)(void)), int timeToClose)
	Initalizes GNE and HawkNL.
void	shutdownGNE ()
	Shuts down GNE and HawkNL.
Address	getLocalAddress ()
	Use this function to get the address of the default networking device on this system, if possible.
ConnectionStats	getGlobalStats ()
	Gets the global stats.
void	enableStats ()
	Enables stats gathering, which is off by default.
void	disableStats ()
	Disables stats gathering, which is the default mode.
void	clearStats ()
	Clears all global stats.
int	getOpenConnections ()
	Returns the number of open low-level connections GNE has opened.
GNEProtocolVersionNumber	getGNEProtocolVersion ()
	Returns the GNE Protocol version number.
const char *	getGameName ()
	This function is used internally by GNE to get the name that you set in setGameInformation.
guint32	getUserVersion ()
	This function is used internally by GNE to get the version that you set in setGameInformation.
void	setGameInformation (std::string gameName, guint32 version)
	The user's game information.
void	checkVersions (const GNEProtocolVersionNumber &otherGNE, std::string otherName, guint32 otherUser)
	Compares other versions against this library.
bool	initDebug (int levelMask, const char *fileName=NULL)
	Function to initalize debugging.
void	killDebug ()
	Function to deinitialize debugging.
void	doTrace (int level, const char fn, int lineno, const char msg,...)
	A function available in a debug compile that does trace logging to a file.
template<class T> void	swap (SmartPtr< T > &a, SmartPtr< T > &b)
template<class T, class U> SmartPtr< T >	static_pointer_cast (SmartPtr< U > const &r)
template<class T, class U> SmartPtr< T >	dynamic_pointer_cast (SmartPtr< U > const &r)
template<class T> void	swap (WeakPtr< T > &a, WeakPtr< T > &b)
Variables
const int	MINLEN = 8
const int	REFLEN = 44
const int	CAPLEN = 12
const std::string	ErrorStrings []
const std::string	ViolationStrings []
char	gameNameBuf [32] = {0}
guint32	userVersion = 0
ConnectionEventGenerator::sptr	eGen
	The global event generator.
const int	CRPLEN = 48
const int	MAX_GAME_NAME_LEN = 31
	The maximum number of ASCII characters in game name that is passed into the setGameInformation function.
const double	VER = 0.70
	A numeric representation of the current version of this library.
const std::string	VER_STR = "GNE v0.70"
	A string representation of the name of the library and the current version.
const int	UDP_HEADER_SIZE = 28
	The low-level header size of a UDP header, which is used with the HawkNL internet driver that GNE uses.
const NLenum	NO_NET = 128
	Normally you would pass a network type to GNE::init, but passing this value means that no network should be initalized.
const int	DLEVEL1 = 1
	Debugging level constants for the levelMask.
const int	DLEVEL2 = 2
const int	DLEVEL3 = 4
const int	DLEVEL4 = 8
const int	DLEVEL5 = 16
const gbool	gTrue = 1
	One possible true value for a gbool.
const gbool	gFalse = 0
	The only false value for a gbool.

GNE Namespace Reference

Compounds

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

Function Documentation

Variable Documentation