gzDistBase.h File Reference

Type definitions and constants for GizmoDistribution. More...

#include "gzBaseLibrary.h"

Go to the source code of this file.

Classes
class	gzDistThreadSafeReference
	Thread safe reference base class for GizmoDistribution. More...
class	gzDistTrigger
class	gzDistRemoteChannelInterface
	Remote distribution channel interface class (abstract). More...
class	gzDistInstanceID
	Instance identifier. More...
class	gzDistClientID
	Client identifier. More...
class	gzDistInternals
Defines
#define	GZ_DIST_EXPORT
	< Build a WIN32 DLL Not defined for other systems (Unix, Mac etc.)
#define	GZ_REMOTE_EXPORT
	Not defined for other systems (Unix, Mac etc.).
#define	GZ_DIST_ASSERT(expr)   GZ_MODULE_ASSERT(GZ_DIST_IDENTIFIER, expr)
	Assert.
#define	GZ_DIST_ASSERT_TEXT(expr, text)   GZ_MODULE_ASSERT_TEXT(GZ_DIST_IDENTIFIER, expr, text)
	Assert with additional text.
#define	GZ_DIST_DEBUG   GZ_DIST_IDENTIFIER, GZ_MESSAGE_DEBUG
	Debug level message.
#define	GZ_DIST_NOTICE   GZ_DIST_IDENTIFIER, GZ_MESSAGE_NOTICE
	Notice level message.
#define	GZ_DIST_WARNING   GZ_DIST_IDENTIFIER, GZ_MESSAGE_WARNING
	Warning level message.
#define	GZ_DIST_FATAL   GZ_DIST_IDENTIFIER, GZ_MESSAGE_FATAL
	Fatal level message.
#define	GZ_DIST_DEBUG_WARNING   GZ_MESSAGE_DEBUG
	Debug level message.
#define	GZ_DIST_TRACE0(text)   GZTRACES(GZ_DIST_IDENTIFIER, text)
	Trace with no argument.
#define	GZ_DIST_TRACE1(format, arg1)   GZTRACES(GZ_DIST_IDENTIFIER, format, arg1)
	Trace with one argument.
#define	GZ_DIST_TRACE2(format, arg1, arg2)   GZTRACES(GZ_DIST_IDENTIFIER, format, arg1, arg2)
	Trace with two arguments.
#define	GZ_DIST_TRACE3(format, arg1, arg2, arg3)   GZTRACES(GZ_DIST_IDENTIFIER, format, arg1, arg2, arg3)
	Trace with three arguments.
#define	GZ_DIST_OPTIMIZED_MEMORY
#define	GZ_DIST_DECLARE_MEMBASE(cls)   GZ_DECLARE_MEMBASE(cls)
#define	GZ_DIST_DECLARE_MEMBASE_EXPORT(cls, exp)   GZ_DECLARE_MEMBASE_EXPORT(cls, exp)
#define	GZ_DIST_MEMBASE(cls)   , public GZ_MEMBASE(cls)
#define	GZ_DIST_MEMBASE_SINGLE(cls)   : public GZ_MEMBASE(cls)
#define	GZ_DIST_MEMBASE_IMP(cls)   GZ_MEMBASE_IMP(cls)
#define	GZ_DIST_DECLARE_MEMBASE_IMP(cls, size)   GZ_DECLARE_MEMBASE_IMP(cls, size)
#define	GZ_DIST_MEMBASE_CALL(className)
#define	GZ_DIST_PTR(x)   class x; typedef gzRefPointer<x> x##Ptr
	Forward declaration and definition of a GizmoDistribution thread safe smart pointer macro.
#define	GZ_DIST_LIST(x)
	Definition of a GizmoDistribution reference pointer list macro.
Functions
gzUInt	gzDistGetCurrentProcessID ()
	Get an ID for the current process.
gzULong	gzDistGetCurrentMachineID ()
	Get an ID for the current machine.
const gzDistInstanceID &	gzDistGetCurrentInstanceID ()
	Get an ID for the current instance.
Variables
const gzString	GZ_DIST_IDENTIFIER = "GizmoDistribution"
	GizmoDistribution module identifier.
const gzString	GZ_DIST_EVENT = gzUniqueString("gzDistEvent", 90)
	Name if class gzDistEvent.
const gzString	GZ_DIST_OBJECT = gzUniqueString("gzDistObject", 91)
	Name of class gzDistObject.
const gzString	GZ_DIST_NO_NAME
	No name.
const gzInt	GZ_DIST_SYNCHRONOUS = -1
	Infinite timeout.
const gzInt	GZ_DIST_ASYNCHRONOUS = 0
	Don't wait at all.
const gzULong	GZ_DIST_IDLE_SLEEP_TIME = 10
	Standard idle sleep time (ms).
const gzULong	GZ_DIST_POOL_ID_DEFAULT = 0
	Default pool id.
const gzULong	GZ_DIST_POOL_ID_CUSTOM = 0xFFFFFFFF
	Use this to be notified by a custom thread e.g. a GUI thread.
const gzULong	GZ_DIST_POOL_ID_DEBUG = 0xDEBA6
	This id is reserved for internal debugging and may not be used.
const gzString	GZ_DIST_DEFAULT_IP_ADDRESS = "234.5.6.7"
	Default multicast group IP-address.
const gzUShort	GZ_DIST_DEFAULT_SERVER_PORT = 1122
	Default server data port.
const gzUShort	GZ_DIST_DEFAULT_SESSION_PORT = 2211
	Default session data port.
	gzDistThreadSafeReference
	gzDistThreadSafeReferencePtr
	gzDistEvent
	gzDistEventPtr
	gzDistObject
	gzDistObjectPtr
	gzDistTransaction
	gzDistTransactionPtr
	gzDistSession
	gzDistSessionPtr
	gzDistManager
	gzDistManagerPtr
	gzDistManagerMessage
	gzDistManagerMessagePtr
	gzDistClientMessage
	gzDistClientMessagePtr
	gzDistNotification
	gzDistNotificationPtr
	gzDistNotificationData
	gzDistNotificationDataPtr
	gzDistEvaluatorInterface
	gzDistEvaluatorInterfacePtr
	gzDistRemoteMessage
	gzDistRemoteMessagePtr
	gzDistRouterBuffer
	gzDistRouterBufferPtr
	gzDistClientMessage
	gzDistManagerMessage
	gzDistNotification
const gzDistInstanceID	GZ_DIST_NULL_INSTANCE (0, 0)
	A null instance.
const gzDistClientID	GZ_DIST_NULL_CLIENT (GZ_EMPTY_STRING, GZ_DIST_NULL_INSTANCE)
	A null client.

---

Detailed Description

Type definitions and constants for GizmoDistribution.

This file provides the basic definitions of types used in GizmoDistribution. It also sets the export symbols for .dll export/import

Definition in file gzDistBase.h.

---

Function Documentation

gzUInt gzDistGetCurrentProcessID (   )

Get an ID for the current process. See also: gzDistGetCurrentMachineID() gzDistGetCurrentInstanceID() Examples: encoder.cpp, and gizmochat.cpp.

gzULong gzDistGetCurrentMachineID (   )

Get an ID for the current machine. See also: gzDistGetCurrentProcessID() gzDistGetCurrentInstanceID()

const gzDistInstanceID& gzDistGetCurrentInstanceID (   )

Get an ID for the current instance. See also: gzDistGetCurrentProcessID() gzDistGetCurrentMachineID()

---