Classes | Namespaces | Defines | Typedefs | Functions | Variables

RakNetTypes.h File Reference

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

#include "RakNetDefines.h"
#include "NativeTypes.h"
#include "RakNetTime.h"
#include "Export.h"
Include dependency graph for RakNetTypes.h:

Go to the source code of this file.

Classes

struct  SocketDescriptor
 Describes the local socket to use for RakPeer::Startup. More...
struct  SystemAddress
 Network address for a system. More...
struct  RPCParameters
struct  RakNetGUID
struct  AddressOrGUID
struct  NetworkID
struct  Packet
 This represents a user message from another system. More...
struct  uint24_t

Namespaces

namespace  RakNet
 

Forward declaration.


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 PRINTF_64_BIT_MODIFIER   "ll"
#define SystemAddress_Size   6
 Size of SystemAddress data.
#define REGISTER_STATIC_RPC(networkObject, functionName)   (networkObject)->RegisterAsRemoteProcedureCall((#functionName),(functionName))
 RPC Function Implementation Use RPC3.
#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.
#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 SystemIndex
typedef unsigned char RPCIndex
typedef unsigned char MessageID
 First byte of a network message.
typedef uint32_t BitSize_t

Functions

bool NonNumericHostString (const char *host)
const SystemAddress UNASSIGNED_SYSTEM_ADDRESS (0xFFFFFFFF, 0xFFFF)
 Index of an invalid SystemAddress.
const RakNetGUID UNASSIGNED_RAKNET_GUID ((uint64_t)-1)

Variables

const int MAX_RPC_MAP_SIZE = ((RPCIndex)-1)-1
const int UNDEFINED_RPC_INDEX = ((RPCIndex)-1)
const SystemIndex UNASSIGNED_PLAYER_INDEX = 65535
 Index of an unassigned player.
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 Jenkins Software LLC

Usage of RakNet is subject to the appropriate license agreement.

Definition in file RakNetTypes.h.


Define Documentation

#define BITS_TO_BYTES (   x  )     (((x)+7)>>3)

Given a number of bits, return how many bytes are needed to represent that.

Definition at line 24 of file RakNetTypes.h.

#define BYTES_TO_BITS (   x  )     ((x)<<3)

Definition at line 25 of file RakNetTypes.h.

#define PRINTF_64_BIT_MODIFIER   "ll"

Definition at line 42 of file RakNetTypes.h.

#define SystemAddress_Size   6

Size of SystemAddress data.

Definition at line 111 of file RakNetTypes.h.

#define UNREGISTER_CLASS_MEMBER_RPC (   networkObject,
  className,
  functionName 
)    (networkObject)->UnregisterAsRemoteProcedureCall((#className "_" #functionName))

Definition at line 404 of file RakNetTypes.h.


Typedef Documentation

Definition at line 37 of file RakNetTypes.h.

typedef unsigned char MessageID

First byte of a network message.

Definition at line 35 of file RakNetTypes.h.

typedef unsigned char RPCIndex

Definition at line 30 of file RakNetTypes.h.

typedef unsigned short SystemIndex

Definition at line 29 of file RakNetTypes.h.

typedef unsigned char UniqueIDType
See also:
NetworkIDObject.h

Definition at line 28 of file RakNetTypes.h.


Function Documentation

bool NonNumericHostString ( const char *  host  ) 

Definition at line 29 of file RakNetTypes.cpp.

Here is the caller graph for this function:

const RakNetGUID UNASSIGNED_RAKNET_GUID ( (uint64_t)-  1  ) 

Here is the caller graph for this function:

const SystemAddress UNASSIGNED_SYSTEM_ADDRESS ( 0xFFFFFFFF  ,
0xFFFF   
)

Index of an invalid SystemAddress.


Variable Documentation

const int MAX_RPC_MAP_SIZE = ((RPCIndex)-1)-1

Definition at line 31 of file RakNetTypes.h.

const int PING_TIMES_ARRAY_SIZE = 5

Definition at line 319 of file RakNetTypes.h.

Unassigned object ID.

Definition at line 317 of file RakNetTypes.h.

Index of an unassigned player.

Definition at line 314 of file RakNetTypes.h.

const int UNDEFINED_RPC_INDEX = ((RPCIndex)-1)

Definition at line 32 of file RakNetTypes.h.