RakNetTypes.h File Reference

Types used by RakNet, most of which involve user code. More...

#include "RakNetDefines.h"
#include "Export.h"

Namespaces
namespace	RakNet
Classes
struct	SystemAddress
	Unique identifier for a system. Corresponds to a network address. More...
struct	NetworkID
struct	Packet
	This represents a user message from another system. More...
struct	RPCParameters
	All RPC functions have the same parameter list - this structure. More...
Defines
#define	BITS_TO_BYTES(x)   (((x)+7)>>3)
	Given a number of bits, return how many bytes are needed to represent that.
#define	BYTES_TO_BITS(x)   ((x)<<3)
#define	SystemAddress_Size   6
	Size of SystemAddress data.
#define	REGISTER_STATIC_RPC(networkObject, functionName)   (networkObject)->RegisterAsRemoteProcedureCall((#functionName),(functionName))
	RPC Function Implementation.
#define	CLASS_MEMBER_ID(className, functionName)   #className "_" #functionName
	Concatenate two strings.
#define	REGISTER_CLASS_MEMBER_RPC(networkObject, className, functionName)   {union {void (__cdecl className::*cFunc)( RPCParameters *rpcParms ); void* voidFunc;}; cFunc=&className::functionName; networkObject->RegisterClassMemberRPC(CLASS_MEMBER_ID(className, functionName),voidFunc);}
	Register a member function of an instantiated object as a Remote procedure call. RPC member Functions MUST be marked __cdecl!
#define	UNREGISTER_STATIC_RPC(networkObject, functionName)   (networkObject)->UnregisterAsRemoteProcedureCall((#functionName))
#define	UNREGISTER_CLASS_MEMBER_RPC(networkObject, className, functionName)   (networkObject)->UnregisterAsRemoteProcedureCall((#className "_" #functionName))
Typedefs
typedef unsigned char	UniqueIDType
typedef unsigned short	PlayerIndex
typedef unsigned char	RPCIndex
typedef unsigned char	MessageID
	First byte of a network message.
typedef unsigned int	RakNetTime
typedef long long	RakNetTimeNS
Variables
const int	MAX_RPC_MAP_SIZE = ((RPCIndex)-1)-1
const int	UNDEFINED_RPC_INDEX = ((RPCIndex)-1)
const PlayerIndex	UNASSIGNED_PLAYER_INDEX = 65535
	Index of an unassigned player.
const SystemAddress	UNASSIGNED_SYSTEM_ADDRESS
	Index of an invalid SystemAddress.
const NetworkID	UNASSIGNED_NETWORK_ID
	Unassigned object ID.
const int	PING_TIMES_ARRAY_SIZE = 5

---

Detailed Description

Types used by RakNet, most of which involve user code.

This file is part of RakNet Copyright 2003 Kevin Jenkins.

Usage of RakNet is subject to the appropriate license agreement. Creative Commons Licensees are subject to the license found at http://creativecommons.org/licenses/by-nc/2.5/ Single application licensees are subject to the license found at http://www.rakkarsoft.com/SingleApplicationLicense.html Custom license users are subject to the terms therein. GPL license users are subject to the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

---

Typedef Documentation

typedef unsigned char UniqueIDType

See also: NetworkIDGenerator.h

---

Variable Documentation

const NetworkID UNASSIGNED_NETWORK_ID

Initial value: { {0xFFFFFFFF, 0xFFFF}, 65535 } Unassigned object ID.

const SystemAddress UNASSIGNED_SYSTEM_ADDRESS

Initial value: { 0xFFFFFFFF, 0xFFFF } Index of an invalid SystemAddress.

---