RakPeerInterface Class Reference

The main interface for network communications. More...

#include <RakPeerInterface.h>

Inheritance diagram for RakPeerInterface:

RakPeer

List of all members.

Public Member Functions

virtual ~RakPeerInterface ()
 Destructor.
virtual bool Startup (unsigned short maxConnections, int _threadSleepTimer, SocketDescriptor *socketDescriptors, unsigned socketDescriptorCount)=0
 Starts the network threads, opens the listen port. You must call this before calling Connect(). Multiple calls while already active are ignored. To call this function again with different settings, you must first call Shutdown().
virtual void InitializeSecurity (const char *pubKeyE, const char *pubKeyN, const char *privKeyP, const char *privKeyQ)=0
virtual void DisableSecurity (void)=0
virtual void AddToSecurityExceptionList (const char *ip)=0
virtual void RemoveFromSecurityExceptionList (const char *ip)=0
virtual bool IsInSecurityExceptionList (const char *ip)=0
virtual void SetMaximumIncomingConnections (unsigned short numberAllowed)=0
virtual unsigned short GetMaximumIncomingConnections (void) const =0
virtual unsigned short NumberOfConnections (void) const =0
virtual void SetIncomingPassword (const char *passwordData, int passwordDataLength)=0
virtual void GetIncomingPassword (char *passwordData, int *passwordDataLength)=0
virtual bool Connect (const char *host, unsigned short remotePort, const char *passwordData, int passwordDataLength, unsigned connectionSocketIndex=0)=0
 Connect to the specified host (ip or domain name) and server port. Calling Connect and not calling SetMaximumIncomingConnections acts as a dedicated client. Calling both acts as a true peer. This is a non-blocking connection. You know the connection is successful when IsConnected() returns true or Receive() gets a message with the type identifier ID_CONNECTION_ACCEPTED. If the connection is not successful, such as a rejected connection or no response then neither of these things will happen.
virtual void Shutdown (unsigned int blockDuration, unsigned char orderingChannel=0)=0
 Connect to the specified network ID (Platform specific console function) Does built-in NAt traversal.
virtual bool IsActive (void) const =0
virtual bool GetConnectionList (SystemAddress *remoteSystems, unsigned short *numberOfSystems) const =0
virtual bool Send (const char *data, const int length, PacketPriority priority, PacketReliability reliability, char orderingChannel, SystemAddress systemAddress, bool broadcast)=0
virtual void SendLoopback (const char *data, const int length)=0
virtual bool Send (const RakNet::BitStream *bitStream, PacketPriority priority, PacketReliability reliability, char orderingChannel, SystemAddress systemAddress, bool broadcast)=0
virtual bool SendList (char **data, const int *lengths, const int numParameters, PacketPriority priority, PacketReliability reliability, char orderingChannel, SystemAddress systemAddress, bool broadcast)=0
virtual PacketReceive (void)=0
virtual void DeallocatePacket (Packet *packet)=0
virtual unsigned short GetMaximumNumberOfPeers (void) const =0
 Return the total number of connections we are allowed.
virtual void RegisterAsRemoteProcedureCall (const char *uniqueID, void(*functionPointer)(RPCParameters *rpcParms))=0
virtual void RegisterClassMemberRPC (const char *uniqueID, void *functionPointer)=0
virtual void UnregisterAsRemoteProcedureCall (const char *uniqueID)=0
virtual void SetNetworkIDManager (NetworkIDManager *manager)=0
virtual NetworkIDManagerGetNetworkIDManager (void) const =0
virtual bool RPC (const char *uniqueID, const char *data, BitSize_t bitLength, PacketPriority priority, PacketReliability reliability, char orderingChannel, SystemAddress systemAddress, bool broadcast, RakNetTime *includedTimestamp, NetworkID networkID, RakNet::BitStream *replyFromTarget)=0
virtual bool RPC (const char *uniqueID, const RakNet::BitStream *bitStream, PacketPriority priority, PacketReliability reliability, char orderingChannel, SystemAddress systemAddress, bool broadcast, RakNetTime *includedTimestamp, NetworkID networkID, RakNet::BitStream *replyFromTarget)=0
virtual void CloseConnection (const SystemAddress target, bool sendDisconnectionNotification, unsigned char orderingChannel=0)=0
virtual bool IsConnected (const SystemAddress systemAddress, bool includeInProgress=false, bool includeDisconnecting=false)=0
virtual int GetIndexFromSystemAddress (const SystemAddress systemAddress)=0
virtual SystemAddress GetSystemAddressFromIndex (int index)=0
virtual void AddToBanList (const char *IP, RakNetTime milliseconds=0)=0
virtual void RemoveFromBanList (const char *IP)=0
virtual void ClearBanList (void)=0
 Allows all previously banned IPs to connect.
virtual bool IsBanned (const char *IP)=0
virtual void Ping (const SystemAddress target)=0
virtual bool Ping (const char *host, unsigned short remotePort, bool onlyReplyOnAcceptingConnections, unsigned connectionSocketIndex=0)=0
virtual int GetAveragePing (const SystemAddress systemAddress)=0
virtual int GetLastPing (const SystemAddress systemAddress) const =0
virtual int GetLowestPing (const SystemAddress systemAddress) const =0
virtual void SetOccasionalPing (bool doPing)=0
virtual void SetOfflinePingResponse (const char *data, const unsigned int length)=0
virtual void GetOfflinePingResponse (char **data, unsigned int *length)=0
virtual SystemAddress GetInternalID (const SystemAddress systemAddress=UNASSIGNED_SYSTEM_ADDRESS, const int index=0) const =0
virtual SystemAddress GetExternalID (const SystemAddress target) const =0
virtual RakNetGUID GetGuidFromSystemAddress (const SystemAddress input) const =0
virtual SystemAddress GetSystemAddressFromGuid (const RakNetGUID input) const =0
virtual void SetTimeoutTime (RakNetTime timeMS, const SystemAddress target)=0
virtual bool SetMTUSize (int size, const SystemAddress target=UNASSIGNED_SYSTEM_ADDRESS)=0
virtual int GetMTUSize (const SystemAddress target) const =0
virtual unsigned GetNumberOfAddresses (void)=0
 Returns the number of IP addresses this system has internally. Get the actual addresses from GetLocalIP().
virtual const char * GetLocalIP (unsigned int index)=0
virtual bool IsLocalIP (const char *ip)=0
virtual void AllowConnectionResponseIPMigration (bool allow)=0
virtual bool AdvertiseSystem (const char *host, unsigned short remotePort, const char *data, int dataLength, unsigned connectionSocketIndex=0)=0
virtual void SetSplitMessageProgressInterval (int interval)=0
virtual int GetSplitMessageProgressInterval (void) const =0
virtual void SetUnreliableTimeout (RakNetTime timeoutMS)=0
virtual void SendTTL (const char *host, unsigned short remotePort, int ttl, unsigned connectionSocketIndex=0)=0
virtual void SetCompileFrequencyTable (bool doCompile)=0
virtual bool GetOutgoingFrequencyTable (unsigned int outputFrequencyTable[256])=0
virtual bool GenerateCompressionLayer (unsigned int inputFrequencyTable[256], bool inputLayer)=0
virtual bool DeleteCompressionLayer (bool inputLayer)=0
virtual float GetCompressionRatio (void) const =0
virtual float GetDecompressionRatio (void) const =0
virtual void AttachPlugin (PluginInterface *plugin)=0
virtual void DetachPlugin (PluginInterface *messageHandler)=0
virtual void PushBackPacket (Packet *packet, bool pushAtHead)=0
virtual void SetRouterInterface (RouterInterface *routerInterface)=0
 
virtual void RemoveRouterInterface (RouterInterface *routerInterface)=0
 
virtual PacketAllocatePacket (unsigned dataSize)=0
virtual void ApplyNetworkSimulator (double maxSendBPS, unsigned short minExtraPing, unsigned short extraPingVariance)=0
virtual void SetPerConnectionOutgoingBandwidthLimit (unsigned maxBitsPerSecond)=0
virtual bool IsNetworkSimulatorActive (void)=0
virtual void UseUserSocket (int socket, bool haveRakNetCloseSocket, unsigned connectionSocketIndex)=0
virtual void RebindSocketAddress (unsigned connectionSocketIndex, SocketDescriptor &sd)=0
virtual RakNetStatistics *const GetStatistics (const SystemAddress systemAddress, RakNetStatistics *rns=0)=0


Detailed Description

The main interface for network communications.

The primary interface for RakNet, RakPeer contains all major functions for the library. See the individual functions for what the class can do.


Member Function Documentation

virtual void RakPeerInterface::AddToBanList ( const char *  IP,
RakNetTime  milliseconds = 0 
) [pure virtual]

Bans an IP from connecting. Banned IPs persist between connections but are not saved on shutdown nor loaded on startup. param[in] IP Dotted IP address. Can use * as a wildcard, such as 128.0.0.* will ban all IP addresses starting with 128.0.0

Parameters:
[in] milliseconds how many ms for a temporary ban. Use 0 for a permanent ban

Implemented in RakPeer.

virtual void RakPeerInterface::AddToSecurityExceptionList ( const char *  ip  )  [pure virtual]

If secure connections are on, do not use secure connections for a specific IP address. This is useful if you have a fixed-address internal server behind a LAN.

Note:
Secure connections are determined by the recipient of an incoming connection. This has no effect if called on the system attempting to connect.
Parameters:
[in] ip IP address to add. * wildcards are supported.

Implemented in RakPeer.

virtual bool RakPeerInterface::AdvertiseSystem ( const char *  host,
unsigned short  remotePort,
const char *  data,
int  dataLength,
unsigned  connectionSocketIndex = 0 
) [pure virtual]

Sends a one byte message ID_ADVERTISE_SYSTEM to the remote unconnected system. This will tell the remote system our external IP outside the LAN along with some user data.

Precondition:
The sender and recipient must already be started via a successful call to Initialize
Parameters:
[in] host Either a dotted IP address or a domain name
[in] remotePort Which port to connect to on the remote machine.
[in] data Optional data to append to the packet.
[in] dataLength length of data in bytes. Use 0 if no data.
[in] connectionSocketIndex Index into the array of socket descriptors passed to socketDescriptors in RakPeer::Startup() to send on.
Returns:
false if IsActive()==false or the host is unresolvable. True otherwise

Implemented in RakPeer.

virtual Packet* RakPeerInterface::AllocatePacket ( unsigned  dataSize  )  [pure virtual]

Returns:
a packet for you to write to if you want to create a Packet for some reason. You can add it to the receive buffer with PushBackPacket
Parameters:
[in] dataSize How many bytes to allocate for the buffer
Returns:
A packet you can write to

Implemented in RakPeer.

virtual void RakPeerInterface::AllowConnectionResponseIPMigration ( bool  allow  )  [pure virtual]

Allow or disallow connection responses from any IP. Normally this should be false, but may be necessary when connecting to servers with multiple IP addresses.

Parameters:
[in] allow - True to allow this behavior, false to not allow. Defaults to false. Value persists between connections

Implemented in RakPeer.

virtual void RakPeerInterface::ApplyNetworkSimulator ( double  maxSendBPS,
unsigned short  minExtraPing,
unsigned short  extraPingVariance 
) [pure virtual]

Adds simulated ping and packet loss to the outgoing data flow. To simulate bi-directional ping and packet loss, you should call this on both the sender and the recipient, with half the total ping and maxSendBPS value on each. You can exclude network simulator code with the _RELEASE define to decrease code size Use http://www.jenkinssoftware.com/raknet/forum/index.php?topic=1671.0 instead.

Parameters:
[in] maxSendBPS Maximum bits per second to send. Packetloss grows linearly. 0 to disable. (CURRENTLY BROKEN - ALWAYS DISABLED)
[in] minExtraPing The minimum time to delay sends.
[in] extraPingVariance The additional random time to delay sends.

Implemented in RakPeer.

virtual void RakPeerInterface::AttachPlugin ( PluginInterface plugin  )  [pure virtual]

Attatches a Plugin interface to run code automatically on message receipt in the Receive call

Note:
If plugins have dependencies on each other then the order does matter - for example the router plugin should go first because it might route messages for other plugins
Parameters:
[in] messageHandler Pointer to a plugin to attach

Implemented in RakPeer.

virtual void RakPeerInterface::CloseConnection ( const SystemAddress  target,
bool  sendDisconnectionNotification,
unsigned char  orderingChannel = 0 
) [pure virtual]

Close the connection to another host (if we initiated the connection it will disconnect, if they did it will kick them out).

Parameters:
[in] target Which system to close the connection to.
[in] sendDisconnectionNotification True to send ID_DISCONNECTION_NOTIFICATION to the recipient. False to close it silently.
[in] channel Which ordering channel to send the disconnection notification on, if any

Implemented in RakPeer.

virtual bool RakPeerInterface::Connect ( const char *  host,
unsigned short  remotePort,
const char *  passwordData,
int  passwordDataLength,
unsigned  connectionSocketIndex = 0 
) [pure virtual]

Connect to the specified host (ip or domain name) and server port. Calling Connect and not calling SetMaximumIncomingConnections acts as a dedicated client. Calling both acts as a true peer. This is a non-blocking connection. You know the connection is successful when IsConnected() returns true or Receive() gets a message with the type identifier ID_CONNECTION_ACCEPTED. If the connection is not successful, such as a rejected connection or no response then neither of these things will happen.

Precondition:
Requires that you first call Initialize
Parameters:
[in] host Either a dotted IP address or a domain name
[in] remotePort Which port to connect to on the remote machine.
[in] passwordData A data block that must match the data block on the server passed to SetIncomingPassword. This can be a string or can be a stream of data. Use 0 for no password.
[in] passwordDataLength The length in bytes of passwordData
[in] connectionSocketIndex Index into the array of socket descriptors passed to socketDescriptors in RakPeer::Startup() to send on.
Returns:
True on successful initiation. False on incorrect parameters, internal error, or too many existing peers. Returning true does not mean you connected!

Implemented in RakPeer.

virtual void RakPeerInterface::DeallocatePacket ( Packet packet  )  [pure virtual]

Call this to deallocate a message returned by Receive() when you are done handling it.

Parameters:
[in] packet The message to deallocate.

Implemented in RakPeer.

virtual bool RakPeerInterface::DeleteCompressionLayer ( bool  inputLayer  )  [pure virtual]

Delete the output or input layer as specified. This is not necessary to call and is only valuable for freeing memory.

Precondition:
You should only call this when disconnected
Parameters:
[in] inputLayer True to mean the inputLayer, false to mean the output layer
Returns:
false (failure) if connected. Otherwise true (success)

Implemented in RakPeer.

virtual void RakPeerInterface::DetachPlugin ( PluginInterface messageHandler  )  [pure virtual]

Detaches a Plugin interface to run code automatically on message receipt

Parameters:
[in] messageHandler Pointer to a plugin to detach

Implemented in RakPeer.

virtual void RakPeerInterface::DisableSecurity ( void   )  [pure virtual]

Disables all security.

Note:
Must be called while offline

Implemented in RakPeer.

virtual bool RakPeerInterface::GenerateCompressionLayer ( unsigned int  inputFrequencyTable[256],
bool  inputLayer 
) [pure virtual]

This is an optional function to generate the compression layer based on the input frequency table. If you want to use it you should call this twice - once with inputLayer as true and once as false. The frequency table passed here with inputLayer=true should match the frequency table on the recipient with inputLayer=false. Likewise, the frequency table passed here with inputLayer=false should match the frequency table on the recipient with inputLayer=true. Calling this function when there is an existing layer will overwrite the old layer.

Precondition:
You should only call this when disconnected
Parameters:
[in] inputFrequencyTable A frequency table for your data
[in] inputLayer Is this the input layer?
Returns:
false (failure) if connected. Otherwise true (success)
See also:
Compression.cpp

Implemented in RakPeer.

virtual int RakPeerInterface::GetAveragePing ( const SystemAddress  systemAddress  )  [pure virtual]

Returns the average of all ping times read for the specific system or -1 if none read yet

Parameters:
[in] systemAddress Which system we are referring to
Returns:
The ping time for this system, or -1

Implemented in RakPeer.

virtual float RakPeerInterface::GetCompressionRatio ( void   )  const [pure virtual]

Returns the compression ratio. A low compression ratio is good. Compression is for outgoing data

Returns:
The compression ratio

Implemented in RakPeer.

virtual bool RakPeerInterface::GetConnectionList ( SystemAddress remoteSystems,
unsigned short *  numberOfSystems 
) const [pure virtual]

Fills the array remoteSystems with the SystemAddress of all the systems we are connected to

Parameters:
[out] remoteSystems An array of SystemAddress structures to be filled with the SystemAddresss of the systems we are connected to. Pass 0 to remoteSystems to only get the number of systems we are connected to
[in,out] numberOfSystems As input, the size of remoteSystems array. As output, the number of elements put into the array

Implemented in RakPeer.

virtual float RakPeerInterface::GetDecompressionRatio ( void   )  const [pure virtual]

Returns the decompression ratio. A high decompression ratio is good. Decompression is for incoming data

Returns:
The decompression ratio

Implemented in RakPeer.

virtual SystemAddress RakPeerInterface::GetExternalID ( const SystemAddress  target  )  const [pure virtual]

Return the unique address identifier that represents you on the the network and is based on your externalIP / port (the IP / port the specified player uses to communicate with you)

Parameters:
[in] target Which remote system you are referring to for your external ID. Usually the same for all systems, unless you have two or more network cards.

Implemented in RakPeer.

virtual RakNetGUID RakPeerInterface::GetGuidFromSystemAddress ( const SystemAddress  input  )  const [pure virtual]

Given a connected system, give us the unique GUID representing that instance of RakPeer. This will be the same on all systems connected to that instance of RakPeer, even if the external system addresses are different Currently O(log(n)), but this may be improved in the future. If you use this frequently, you may want to cache the value as it won't change. If input is UNASSIGNED_SYSTEM_ADDRESS, will return your own GUID

Precondition:
Call Startup() first, or the function will return UNASSIGNED_RAKNET_GUID
Parameters:
[in] input The system address of the system we are connected to

Implemented in RakPeer.

virtual void RakPeerInterface::GetIncomingPassword ( char *  passwordData,
int *  passwordDataLength 
) [pure virtual]

Gets the password passed to SetIncomingPassword

Parameters:
[out] passwordData Should point to a block large enough to hold the password data you passed to SetIncomingPassword()
[in,out] passwordDataLength Maximum size of the array passwordData. Modified to hold the number of bytes actually written

Implemented in RakPeer.

virtual int RakPeerInterface::GetIndexFromSystemAddress ( const SystemAddress  systemAddress  )  [pure virtual]

Given a systemAddress, returns an index from 0 to the maximum number of players allowed - 1.

Parameters:
[in] systemAddress The SystemAddress we are referring to
Returns:
The index of this SystemAddress or -1 on system not found.

Implemented in RakPeer.

virtual SystemAddress RakPeerInterface::GetInternalID ( const SystemAddress  systemAddress = UNASSIGNED_SYSTEM_ADDRESS,
const int  index = 0 
) const [pure virtual]

Return the unique address identifier that represents you or another system on the the network and is based on your local IP / port.

Parameters:
[in] systemAddress Use UNASSIGNED_SYSTEM_ADDRESS to get your behind-LAN address. Use a connected system to get their behind-LAN address
[in] index When you have multiple internal IDs, which index to return? Currently limited to MAXIMUM_NUMBER_OF_INTERNAL_IDS (so the maximum value of this variable is MAXIMUM_NUMBER_OF_INTERNAL_IDS-1)
Returns:
the identifier of your system internally, which may not be how other systems see if you if you are behind a NAT or proxy

Implemented in RakPeer.

virtual int RakPeerInterface::GetLastPing ( const SystemAddress  systemAddress  )  const [pure virtual]

Returns the last ping time read for the specific system or -1 if none read yet

Parameters:
[in] systemAddress Which system we are referring to
Returns:
The last ping time for this system, or -1

Implemented in RakPeer.

virtual const char* RakPeerInterface::GetLocalIP ( unsigned int  index  )  [pure virtual]

Returns an IP address at index 0 to GetNumberOfAddresses-1

Parameters:
[in] index index into the list of IP addresses
Returns:
The local IP address at this index

Implemented in RakPeer.

virtual int RakPeerInterface::GetLowestPing ( const SystemAddress  systemAddress  )  const [pure virtual]

Returns the lowest ping time read or -1 if none read yet

Parameters:
[in] systemAddress Which system we are referring to
Returns:
The lowest ping time for this system, or -1

Implemented in RakPeer.

virtual unsigned short RakPeerInterface::GetMaximumIncomingConnections ( void   )  const [pure virtual]

Returns the value passed to SetMaximumIncomingConnections()

Returns:
the maximum number of incoming connections, which is always <= maxConnections

Implemented in RakPeer.

virtual int RakPeerInterface::GetMTUSize ( const SystemAddress  target  )  const [pure virtual]

Returns the current MTU size

Parameters:
[in] target Which system to get this for. UNASSIGNED_SYSTEM_ADDRESS to get the default
Returns:
The current MTU size

Implemented in RakPeer.

virtual NetworkIDManager* RakPeerInterface::GetNetworkIDManager ( void   )  const [pure virtual]

Returns:
Returns the value passed to SetNetworkIDManager or 0 if never called.

Implemented in RakPeer.

virtual void RakPeerInterface::GetOfflinePingResponse ( char **  data,
unsigned int *  length 
) [pure virtual]

Returns pointers to a copy of the data passed to SetOfflinePingResponse

Parameters:
[out] data A pointer to a copy of the data passed to SetOfflinePingResponse()
[out] length A pointer filled in with the length parameter passed to SetOfflinePingResponse()
See also:
SetOfflinePingResponse

Implemented in RakPeer.

virtual bool RakPeerInterface::GetOutgoingFrequencyTable ( unsigned int  outputFrequencyTable[256]  )  [pure virtual]

Returns the frequency of outgoing bytes into output frequency table The purpose is to save to file as either a master frequency table from a sample game session for passing to GenerateCompressionLayer()

Precondition:
You should only call this when disconnected. Requires that you first enable data frequency tracking by calling SetCompileFrequencyTable(true)
Parameters:
[out] outputFrequencyTable The frequency of each corresponding byte
Returns:
False (failure) if connected or if frequency table tracking is not enabled. Otherwise true (success)

Implemented in RakPeer.

virtual int RakPeerInterface::GetSplitMessageProgressInterval ( void   )  const [pure virtual]

Returns what was passed to SetSplitMessageProgressInterval()

Returns:
What was passed to SetSplitMessageProgressInterval(). Default to 0.

Implemented in RakPeer.

virtual RakNetStatistics* const RakPeerInterface::GetStatistics ( const SystemAddress  systemAddress,
RakNetStatistics rns = 0 
) [pure virtual]

Returns a structure containing a large set of network statistics for the specified system. You can map this data to a string using the C style StatisticsToString() function

Parameters:
[in] systemAddress,: Which connected system to get statistics for
[in] rns If you supply this structure, it will be written to it. Otherwise it will use a static struct, which is not threadsafe
Returns:
0 on can't find the specified system. A pointer to a set of data otherwise.
See also:
RakNetStatistics.h

Implemented in RakPeer.

virtual SystemAddress RakPeerInterface::GetSystemAddressFromGuid ( const RakNetGUID  input  )  const [pure virtual]

Given the GUID of a connected system, give us the system address of that system. The GUID will be the same on all systems connected to that instance of RakPeer, even if the external system addresses are different Currently O(log(n)), but this may be improved in the future. If you use this frequently, you may want to cache the value as it won't change. If input is UNASSIGNED_RAKNET_GUID, will return UNASSIGNED_SYSTEM_ADDRESS

Parameters:
[in] input The RakNetGUID of the system we are checking to see if we are connected to

Implemented in RakPeer.

virtual SystemAddress RakPeerInterface::GetSystemAddressFromIndex ( int  index  )  [pure virtual]

This function is only useful for looping through all systems Given an index, will return a SystemAddress.

Parameters:
[in] index Index should range between 0 and the maximum number of players allowed - 1.
Returns:
The SystemAddress

Implemented in RakPeer.

virtual void RakPeerInterface::InitializeSecurity ( const char *  pubKeyE,
const char *  pubKeyN,
const char *  privKeyP,
const char *  privKeyQ 
) [pure virtual]

Secures connections though a combination of SHA1, AES128, SYN Cookies, and RSA to prevent connection spoofing, replay attacks, data eavesdropping, packet tampering, and MitM attacks. There is a significant amount of processing and a slight amount of bandwidth overhead for this feature. If you accept connections, you must call this or else secure connections will not be enabled for incoming connections. If you are connecting to another system, you can call this with values for the (e and p,q) public keys before connecting to prevent MitM

Precondition:
Must be called while offline
Parameters:
[in] pubKeyE A pointer to the public keys from the RSACrypt class.
[in] pubKeyN A pointer to the public keys from the RSACrypt class.
[in] privKeyP Public key generated from the RSACrypt class.
[in] privKeyQ Public key generated from the RSACrypt class. If the private keys are 0, then a new key will be generated when this function is called
See also:
the Encryption sample

Implemented in RakPeer.

virtual bool RakPeerInterface::IsActive ( void   )  const [pure virtual]

Returns if the network thread is running

Returns:
true if the network thread is running, false otherwise

Implemented in RakPeer.

virtual bool RakPeerInterface::IsBanned ( const char *  IP  )  [pure virtual]

Returns true or false indicating if a particular IP is banned.

Parameters:
[in] IP - Dotted IP address.
Returns:
true if IP matches any IPs in the ban list, accounting for any wildcards. False otherwise.

Implemented in RakPeer.

virtual bool RakPeerInterface::IsConnected ( const SystemAddress  systemAddress,
bool  includeInProgress = false,
bool  includeDisconnecting = false 
) [pure virtual]

Returns if a particular systemAddress is connected to us (this also returns true if we are in the process of connecting)

Parameters:
[in] systemAddress The SystemAddress we are referring to
[in] includeInProgress If true, also return true for connections that are in progress but haven't completed
[in] includeDisconnecting If true, also return true for connections that are in the process of disconnecting
Returns:
True if this system is connected and active, false otherwise.

Implemented in RakPeer.

virtual bool RakPeerInterface::IsInSecurityExceptionList ( const char *  ip  )  [pure virtual]

Checks to see if a given IP is in the security exception list

Parameters:
[in] IP address to check.

Implemented in RakPeer.

virtual bool RakPeerInterface::IsLocalIP ( const char *  ip  )  [pure virtual]

Is this a local IP?

Parameters:
[in] An IP address to check, excluding the port
Returns:
True if this is one of the IP addresses returned by GetLocalIP

Implemented in RakPeer.

virtual bool RakPeerInterface::IsNetworkSimulatorActive ( void   )  [pure virtual]

Returns if you previously called ApplyNetworkSimulator

Returns:
If you previously called ApplyNetworkSimulator

Implemented in RakPeer.

virtual unsigned short RakPeerInterface::NumberOfConnections ( void   )  const [pure virtual]

Returns how many open connections there are at this time

Returns:
the number of open connections

Implemented in RakPeer.

virtual bool RakPeerInterface::Ping ( const char *  host,
unsigned short  remotePort,
bool  onlyReplyOnAcceptingConnections,
unsigned  connectionSocketIndex = 0 
) [pure virtual]

Send a ping to the specified unconnected system. The remote system, if it is Initialized, will respond with ID_PONG followed by sizeof(RakNetTime) containing the system time the ping was sent.(Default is 4 bytes - See __GET_TIME_64BIT in RakNetTypes.h

Parameters:
[in] host Either a dotted IP address or a domain name. Can be 255.255.255.255 for LAN broadcast.
[in] remotePort Which port to connect to on the remote machine.
[in] onlyReplyOnAcceptingConnections Only request a reply if the remote system is accepting connections
[in] connectionSocketIndex Index into the array of socket descriptors passed to socketDescriptors in RakPeer::Startup() to send on.
Returns:
true on success, false on failure (unknown hostname)

Implemented in RakPeer.

virtual void RakPeerInterface::Ping ( const SystemAddress  target  )  [pure virtual]

Send a ping to the specified connected system.

Precondition:
The sender and recipient must already be started via a successful call to Startup()
Parameters:
[in] target Which system to ping

Implemented in RakPeer.

virtual void RakPeerInterface::PushBackPacket ( Packet packet,
bool  pushAtHead 
) [pure virtual]

Put a message back at the end of the receive queue in case you don't want to deal with it immediately

Parameters:
[in] packet The packet you want to push back.
[in] pushAtHead True to push the packet so that the next receive call returns it. False to push it at the end of the queue (obviously pushing it at the end makes the packets out of order)

Implemented in RakPeer.

virtual void RakPeerInterface::RebindSocketAddress ( unsigned  connectionSocketIndex,
SocketDescriptor sd 
) [pure virtual]

Have RakNet recreate a socket using a different port. The socket should not be in use - it is up to you to either shutdown or close the connections using it. Otherwise existing connections on that socket will eventually disconnect

Parameters:
[in] connectionSocketIndex Index into the array of socket descriptors passed to socketDescriptors in RakPeer::Startup() to send on.
[in] sd Address to bind on

Implemented in RakPeer.

virtual Packet* RakPeerInterface::Receive ( void   )  [pure virtual]

Gets a message from the incoming message queue. Use DeallocatePacket() to deallocate the message after you are done with it. User-thread functions, such as RPC calls and the plugin function PluginInterface::Update occur here.

Returns:
0 if no packets are waiting to be handled, otherwise a pointer to a packet.
Note:
COMMON MISTAKE: Be sure to call this in a loop, once per game tick, until it returns 0. If you only process one packet per game tick they will buffer up. sa RakNetTypes.h contains struct Packet

Implemented in RakPeer.

virtual void RakPeerInterface::RemoveFromBanList ( const char *  IP  )  [pure virtual]

Allows a previously banned IP to connect. param[in] Dotted IP address. Can use * as a wildcard, such as 128.0.0.* will banAll IP addresses starting with 128.0.0

Implemented in RakPeer.

virtual void RakPeerInterface::RemoveFromSecurityExceptionList ( const char *  ip  )  [pure virtual]

Remove a specific connection previously added via AddToSecurityExceptionList

Parameters:
[in] ip IP address to remove. Pass 0 to remove all IP addresses. * wildcards are supported.

Implemented in RakPeer.

virtual bool RakPeerInterface::Send ( const RakNet::BitStream bitStream,
PacketPriority  priority,
PacketReliability  reliability,
char  orderingChannel,
SystemAddress  systemAddress,
bool  broadcast 
) [pure virtual]

Sends a block of data to the specified system that you are connected to. Same as the above version, but takes a BitStream as input.

Parameters:
[in] bitStream The bitstream to send
[in] priority What priority level to send on. See PacketPriority.h
[in] reliability How reliability to send this data. See PacketPriority.h
[in] orderingChannel When using ordered or sequenced messages, what channel to order these on. Messages are only ordered relative to other messages on the same stream
[in] systemAddress Who to send this packet to, or in the case of broadcasting who not to send it to. Use UNASSIGNED_SYSTEM_ADDRESS to specify none
[in] broadcast True to send this packet to all connected systems. If true, then systemAddress specifies who not to send the packet to.
Returns:
False if we are not connected to the specified recipient. True otherwise
Note:
COMMON MISTAKE: When writing the first byte, bitStream->Write((unsigned char) ID_MY_TYPE) be sure it is casted to a byte, and you are not writing a 4 byte enumeration.

Implemented in RakPeer.

virtual bool RakPeerInterface::Send ( const char *  data,
const int  length,
PacketPriority  priority,
PacketReliability  reliability,
char  orderingChannel,
SystemAddress  systemAddress,
bool  broadcast 
) [pure virtual]

Sends a block of data to the specified system that you are connected to. This function only works while the connected The first byte should be a message identifier starting at ID_USER_PACKET_ENUM

Parameters:
[in] data The block of data to send
[in] length The size in bytes of the data to send
[in] priority What priority level to send on. See PacketPriority.h
[in] reliability How reliability to send this data. See PacketPriority.h
[in] orderingChannel When using ordered or sequenced messages, what channel to order these on. Messages are only ordered relative to other messages on the same stream
[in] systemAddress Who to send this packet to, or in the case of broadcasting who not to send it to. Use UNASSIGNED_SYSTEM_ADDRESS to specify none
[in] broadcast True to send this packet to all connected systems. If true, then systemAddress specifies who not to send the packet to.
Returns:
False if we are not connected to the specified recipient. True otherwise

Implemented in RakPeer.

virtual bool RakPeerInterface::SendList ( char **  data,
const int *  lengths,
const int  numParameters,
PacketPriority  priority,
PacketReliability  reliability,
char  orderingChannel,
SystemAddress  systemAddress,
bool  broadcast 
) [pure virtual]

Sends multiple blocks of data, concatenating them automatically.

This is equivalent to: RakNet::BitStream bs; bs.WriteAlignedBytes(block1, blockLength1); bs.WriteAlignedBytes(block2, blockLength2); bs.WriteAlignedBytes(block3, blockLength3); Send(&bs, ...)

This function only works while the connected

Parameters:
[in] data An array of pointers to blocks of data
[in] lengths An array of integers indicating the length of each block of data
[in] numParameters Length of the arrays data and lengths
[in] priority What priority level to send on. See PacketPriority.h
[in] reliability How reliability to send this data. See PacketPriority.h
[in] orderingChannel When using ordered or sequenced messages, what channel to order these on. Messages are only ordered relative to other messages on the same stream
[in] systemAddress Who to send this packet to, or in the case of broadcasting who not to send it to. Use UNASSIGNED_SYSTEM_ADDRESS to specify none
[in] broadcast True to send this packet to all connected systems. If true, then systemAddress specifies who not to send the packet to.
Returns:
False if we are not connected to the specified recipient. True otherwise

Implemented in RakPeer.

virtual void RakPeerInterface::SendLoopback ( const char *  data,
const int  length 
) [pure virtual]

"Send" to yourself rather than a remote system. The message will be processed through the plugins and returned to the game as usual This function works anytime The first byte should be a message identifier starting at ID_USER_PACKET_ENUM

Parameters:
[in] data The block of data to send
[in] length The size in bytes of the data to send

Implemented in RakPeer.

virtual void RakPeerInterface::SendTTL ( const char *  host,
unsigned short  remotePort,
int  ttl,
unsigned  connectionSocketIndex = 0 
) [pure virtual]

Send a message to host, with the IP socket option TTL set to 3 This message will not reach the host, but will open the router. Used for NAT-Punchthrough

Implemented in RakPeer.

virtual void RakPeerInterface::SetCompileFrequencyTable ( bool  doCompile  )  [pure virtual]

Enables or disables frequency table tracking. This is required to get a frequency table, which is used in GenerateCompressionLayer() This value persists between connect calls and defaults to false (no frequency tracking)

Precondition:
You can call this at any time - however you SHOULD only call it when disconnected. Otherwise you will only trackpart of the values sent over the network.
Parameters:
[in] doCompile True to enable tracking

Implemented in RakPeer.

virtual void RakPeerInterface::SetIncomingPassword ( const char *  passwordData,
int  passwordDataLength 
) [pure virtual]

Sets the password incoming connections must match in the call to Connect (defaults to none). Pass 0 to passwordData to specify no password This is a way to set a low level password for all incoming connections. To selectively reject connections, implement your own scheme using CloseConnection() to remove unwanted connections

Parameters:
[in] passwordData A data block that incoming connections must match. This can be just a password, or can be a stream of data. Specify 0 for no password data
[in] passwordDataLength The length in bytes of passwordData

Implemented in RakPeer.

virtual void RakPeerInterface::SetMaximumIncomingConnections ( unsigned short  numberAllowed  )  [pure virtual]

Sets how many incoming connections are allowed. If this is less than the number of players currently connected, no more players will be allowed to connect. If this is greater than the maximum number of peers allowed, it will be reduced to the maximum number of peers allowed. Defaults to 0, meaning by default, nobody can connect to you

Parameters:
[in] numberAllowed Maximum number of incoming connections allowed.

Implemented in RakPeer.

virtual bool RakPeerInterface::SetMTUSize ( int  size,
const SystemAddress  target = UNASSIGNED_SYSTEM_ADDRESS 
) [pure virtual]

Set the MTU per datagram. It's important to set this correctly - otherwise packets will be needlessly split, decreasing performance and throughput. Maximum allowed size is MAXIMUM_MTU_SIZE. Too high of a value will cause packets not to arrive at worst and be fragmented at best. Too low of a value will split packets unnecessarily. Recommended size is 1500 sa MTUSize.h

Parameters:
[in] size The MTU size
[in] target Which system to set this for. UNASSIGNED_SYSTEM_ADDRESS to set the default, for new systems
Precondition:
Can only be called when not connected.
Returns:
false on failure (we are connected), else true

Implemented in RakPeer.

virtual void RakPeerInterface::SetOccasionalPing ( bool  doPing  )  [pure virtual]

Ping the remote systems every so often, or not. This is off by default. Can be called anytime.

Parameters:
[in] doPing True to start occasional pings. False to stop them.

Implemented in RakPeer.

virtual void RakPeerInterface::SetOfflinePingResponse ( const char *  data,
const unsigned int  length 
) [pure virtual]

Sets the data to send along with a LAN server discovery or offline ping reply. length should be under 400 bytes, as a security measure against flood attacks

Parameters:
[in] data a block of data to store, or 0 for none
[in] length The length of data in bytes, or 0 for none
See also:
Ping.cpp

Implemented in RakPeer.

virtual void RakPeerInterface::SetPerConnectionOutgoingBandwidthLimit ( unsigned  maxBitsPerSecond  )  [pure virtual]

Limits how much outgoing bandwidth can be sent per-connection. This limit does not apply to the sum of all connections! Exceeding the limit queues up outgoing traffic

Parameters:
[in] maxBitsPerSecond Maximum bits per second to send. Use 0 for unlimited (default). Once set, it takes effect immedately and persists until called again.

Implemented in RakPeer.

virtual void RakPeerInterface::SetSplitMessageProgressInterval ( int  interval  )  [pure virtual]

Controls how often to return ID_DOWNLOAD_PROGRESS for large message downloads. ID_DOWNLOAD_PROGRESS is returned to indicate a new partial message chunk, roughly the MTU size, has arrived As it can be slow or cumbersome to get this notification for every chunk, you can set the interval at which it is returned. Defaults to 0 (never return this notification)

Parameters:
[in] interval How many messages to use as an interval

Implemented in RakPeer.

virtual void RakPeerInterface::SetTimeoutTime ( RakNetTime  timeMS,
const SystemAddress  target 
) [pure virtual]

Set the time, in MS, to use before considering ourselves disconnected after not being able to deliver a reliable message. Default time is 10,000 or 10 seconds in release and 30,000 or 30 seconds in debug.

Parameters:
[in] timeMS Time, in MS
[in] target Which system to do this for. Pass UNASSIGNED_SYSTEM_ADDRESS for all systems.

Implemented in RakPeer.

virtual void RakPeerInterface::SetUnreliableTimeout ( RakNetTime  timeoutMS  )  [pure virtual]

Set how long to wait before giving up on sending an unreliable message Useful if the network is clogged up. Set to 0 or less to never timeout. Defaults to 0.

Parameters:
[in] timeoutMS How many ms to wait before simply not sending an unreliable message.

Implemented in RakPeer.

virtual void RakPeerInterface::Shutdown ( unsigned int  blockDuration,
unsigned char  orderingChannel = 0 
) [pure virtual]

Connect to the specified network ID (Platform specific console function) Does built-in NAt traversal.

Parameters:
[in] passwordData A data block that must match the data block on the server passed to SetIncomingPassword. This can be a string or can be a stream of data. Use 0 for no password.
[in] passwordDataLength The length in bytes of passwordData Stops the network threads and closes all connections.
[in] blockDuration How long, in milliseconds, you should wait for all remaining messages to go out, including ID_DISCONNECTION_NOTIFICATION. If 0, it doesn't wait at all.
[in] orderingChannel If blockDuration > 0, ID_DISCONNECTION_NOTIFICATION will be sent on this channel If you set it to 0 then the disconnection notification won't be sent

Implemented in RakPeer.

virtual bool RakPeerInterface::Startup ( unsigned short  maxConnections,
int  _threadSleepTimer,
SocketDescriptor socketDescriptors,
unsigned  socketDescriptorCount 
) [pure virtual]

Starts the network threads, opens the listen port. You must call this before calling Connect(). Multiple calls while already active are ignored. To call this function again with different settings, you must first call Shutdown().

Note:
Call SetMaximumIncomingConnections if you want to accept incoming connections

Set _RAKNET_THREADSAFE in RakNetDefines.h if you want to call RakNet functions from multiple threads (not recommended, as it is much slower and RakNet is already asynchronous).

Parameters:
[in] maxConnections The maximum number of connections between this instance of RakPeer and another instance of RakPeer. Required so the network can preallocate and for thread safety. A pure client would set this to 1. A pure server would set it to the number of allowed clients.- A hybrid would set it to the sum of both types of connections
[in] localPort The port to listen for connections on.
[in] _threadSleepTimer How many ms to Sleep each internal update cycle (30 to give the game priority, 0 for regular (recommended)
[in] socketDescriptors An array of SocketDescriptor structures to force RakNet to listen on a particular IP address or port (or both). Each SocketDescriptor will represent one unique socket. Do not pass redundant structures. To listen on a specific port, you can pass SocketDescriptor(myPort,0); such as for a server. For a client, it is usually OK to just pass SocketDescriptor();
[in] socketDescriptorCount The size of the socketDescriptors array. Pass 1 if you are not sure what to pass.
Returns:
False on failure (can't create socket or thread), true on success.

Implemented in RakPeer.

virtual void RakPeerInterface::UseUserSocket ( int  socket,
bool  haveRakNetCloseSocket,
unsigned  connectionSocketIndex 
) [pure virtual]

Have RakNet use a socket you created yourself The socket should not be in use - it is up to you to either shutdown or close the connections using it. Otherwise existing connections on that socket will eventually disconnect This socket will be forgotten after calling Shutdown(), so rebind again if you need to.

Parameters:
[in] s The socket to rebind.
[in] haveRakNetCloseSocket If true, RakNet will call closeSocket on shutdown for this socket.
[in] connectionSocketIndex Index into the array of socket descriptors passed to socketDescriptors in RakPeer::Startup() to send on.

Implemented in RakPeer.


The documentation for this class was generated from the following file:

Generated on Tue Feb 10 08:44:08 2009 for RakNet by  doxygen 1.5.7.1