XPSession Index Page
1
A network session class. This handles machines joining and leaving a session.
This is a general purpose class for interfacing with the known transports and maintaining a stable interface between various connected machines. This class enables packets of data to be sent to a specific session ID or to all sessions as a broadcast. In addition to this the class also offers a standard time interface that gives a synchronised shared time between all connected machines. A RNReplicaNet::XPSession is used as the main basis underneath a RNReplicaNet::ReplicaNet session.
Include files are in the Includes directory. Use "RNXPSession/Inc/XPSession.h" to access all of the C++ interface to the RNReplicaNet::XPSession class.
RNReplicaNet::XPSession is primarily a multi-threaded library as the framework uses threads to reduce CPU load. Single-threading is supported by means of using a Poll() call to ensure data is processed regularly.
Libraries for static linking are called:
RNXPSessionDM and RNXPSessionRM for debug and release multi-thread applications.
RNXPSessionDS and RNXPSessionRS for debug and release single-thread applications.
RNXPSessionDMDLL and RNXPSessionRMDLL for debug and release multi-thread DLL applications.
The following library files can be used to force the module to use DLL files to link at runtime.
DLLRNXPSessionDM and DLLRNXPSessionRM for debug and release multi-thread applications.
DLLRNXPSessionDS and DLLRNXPSessionRS for debug and release single-thread applications.
DLLRNXPSessionDMDLL and DLLRNXPSessionRMDLL for debug and release multi-thread DLL applications.
The libraries that start with "DLL" will force the library DLL to be loaded at run time. When using the DLL libraries you must define DOREPNETEXPORTAPI in the preprocessor. This ensures importing of the correct dll functions. It also automatically does #include "RNPlatform/Inc/MemoryTracking.h" The memory tracking header is needed to ensure that the dll calling method accounts for memory properly. The automatic inclusion of the header during DLL builds can be turned off by defining REPLICANET_NOAUTOMATICINCLUDEMEMORYTRACKING For non-dll builds the memory tracking header is not included. Specifically for ReplicaNet and DLL builds, REPLICANET_DLLPREREGISTER() must used called before the ReplicaNet class is allocated. This ties the object classes to the DLL. REPLICANET_DLLPREREGISTER() can also be called in a non-DLL build without any adverse side effects.
The memory tracking header ("RNPlatform/Inc/MemoryTracking.h") can be auto included by defining REPLICANET_ALWAYSDOMEMORYTRACKING for non-dll based builds.
Generated on Sun Oct 30 01:12:10 2005 for XPSession by
1.4.1