# RakClientInterface Class Reference

Define user point of vue of a RakClient communication end point. More...

`#include <RakClientInterface.h>`

Inheritance diagram for RakClientInterface:

List of all members.

## Public Member Functions

virtual | ~RakClientInterface ()
virtual bool | Connect (char *host, unsigned short serverPort, unsigned short clientPort, unsigned long connectionValidationInteger, int threadSleepTimer)=0
virtual void | Disconnect (unsigned long blockDuration)=0
virtual void | InitializeSecurity (char *pubKeyP, char *pubKeyQ)=0
virtual void | SetPassword (char *_password)=0
virtual bool | HasPassword (void) const =0
virtual bool | Send (char *data, const long length, PacketPriority priority, PacketReliability reliability, char orderingChannel)=0
virtual bool | Send (RakNet::BitStream *bitStream, PacketPriority priority, PacketReliability reliability, char orderingChannel)=0
virtual Packet * | Receive (void)=0
virtual void | DeallocatePacket (Packet *packet)=0
virtual void | PingServer (void)=0
virtual void | PingServer (char *host, unsigned short serverPort, unsigned short clientPort, bool onlyReplyOnAcceptingConnections)=0
virtual int | GetAveragePing (void)=0
virtual int | GetLastPing (void) const =0
virtual int | GetLowestPing (void) const =0
virtual int | GetPlayerPing (PlayerID playerId)=0
virtual void | StartOccasionalPing (void)=0
virtual void | StopOccasionalPing (void)=0
virtual bool | IsConnected (void) const =0
virtual unsigned long | GetSynchronizedRandomInteger (void) const =0
virtual bool | GenerateCompressionLayer (unsigned long inputFrequencyTable[256], bool inputLayer)=0
virtual bool | DeleteCompressionLayer (bool inputLayer)=0
virtual void | RegisterAsRemoteProcedureCall (char *uniqueID, void(*functionName)(char *input, int numberOfBitsOfData, PlayerID sender))=0
virtual void | UnregisterAsRemoteProcedureCall (char *uniqueID)=0
virtual bool | RPC (char *uniqueID, char *data, unsigned long bitLength, PacketPriority priority, PacketReliability reliability, char orderingChannel, bool shiftTimestamp)=0
virtual bool | RPC (char *uniqueID, RakNet::BitStream *parameters, PacketPriority priority, PacketReliability reliability, char orderingChannel, bool shiftTimestamp)=0
virtual void | SetTrackFrequencyTable (bool b)=0
virtual bool | GetSendFrequencyTable (unsigned long outputFrequencyTable[256])=0
virtual float | GetCompressionRatio (void) const =0
virtual float | GetDecompressionRatio (void) const =0
virtual RakNet::BitStream * | GetStaticServerData (void)=0
virtual void | SetStaticServerData (char *data, const long length)=0
virtual RakNet::BitStream * | GetStaticClientData (PlayerID playerId)=0
virtual void | SetStaticClientData (PlayerID playerId, char *data, const long length)=0
virtual void | SendStaticClientDataToServer (void)=0
virtual PlayerID | GetServerID (void) const =0
virtual PlayerID | GetPlayerID (void) const =0
virtual const char * | PlayerIDToDottedIP (PlayerID playerId) const =0
virtual void | PushBackPacket (Packet *packet)=0
virtual bool | SetMTUSize (int size)=0
virtual int | GetMTUSize (void) const =0
virtual void | AllowConnectionResponseIPMigration (bool allow)=0
virtual void | AdvertiseSystem (char *host, unsigned short remotePort)=0
virtual RakNetStatisticsStruct *const | GetStatistics (void)=0
virtual PlayerIndex | GetPlayerIndex (void)=0

## Detailed Description

Define user point of vue of a RakClient communication end point.

This class define the user view of a RakClient communication end-point. All accessible operation are available in this class. You should only deal with RakClient object throught instance of RakClientInterface.

## Constructor & Destructor Documentation

virtual RakClientInterface::~RakClientInterface | ( |  | ) | `[inline, virtual]`

| Destructor

## Member Function Documentation

virtual void RakClientInterface::AdvertiseSystem | ( | char * | host,
|  | unsigned short | remotePort
| ) | `[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, and can be used for NAT punch through

Parameters:

  | host | Either a dotted IP address or a domain name
  | remotePort | Which port to connect to on the remote machine.

Implemented in RakClient.

virtual void RakClientInterface::AllowConnectionResponseIPMigration | ( | bool | allow | ) | `[pure virtual]`

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

Parameters:

  | allow | True to allow this behavior, false to not allow. Defaults to false. Value persists between connections

Implemented in RakClient.

virtual bool RakClientInterface::Connect | ( | char * | host,
|  | unsigned short | serverPort,
|  | unsigned short | clientPort,
|  | unsigned long | connectionValidationInteger,
|  | int | threadSleepTimer
| ) | `[pure virtual]`

Call this to connect the client to the specified host (ip or domain name) and server port. This is a non-blocking connection. You know the connection is successful when IsConnected() returns true or receive gets a packet with the type identifier ID_CONNECTION_REQUEST_ACCEPTED. serverPort is which port to connect to on the remote machine. clientPort is the port you want the client to use. Both ports must be open for UDP

Parameters:

  | host | a hostname
  | serverPort | The port on which to contact host
  | clientPort | The port to use localy
  | connectionValidationInteger | is legacy and unused
  | threadSleepTimer | >=0 for how many ms to Sleep each internal update cycle (recommended 30 for low performance, 0 for regular)

Returns:
  true on successful initiation, false otherwise

Implemented in RakClient.

virtual void RakClientInterface::DeallocatePacket | ( | Packet * | packet | ) | `[pure virtual]`

Call this to deallocate a packet returned by Receive when you are done handling it. Free the memory associated to a packet. It is not the same as using delete operator because RakNet might decide not to delete right now the packet in order to use it later.

Parameters:

  | packet | the packet to deallocate.

Implemented in RakClient.

virtual bool RakClientInterface::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 You should only call this when disconnected

Parameters:

  | inputLayer | Delete the compression layer for sending or for receiving ?

Returns:
  false (failure) if connected. Otherwise true (success)

Implemented in RakClient.

virtual void RakClientInterface::Disconnect | ( | unsigned long | blockDuration | ) | `[pure virtual]`

Stops the client, stops synchronized data, and resets all internal data. Does nothing if the client is not connected to begin with blockDuration is how long you should wait for all remaining packets to go out If you set it to 0 then the disconnection notification probably won't arrive

Parameters:

  | blockDuration | The time to wait before truly close the communication and point

Implemented in RakClient.

virtual bool RakClientInterface::GenerateCompressionLayer | ( | unsigned long | inputFrequencyTable[256],
|  | bool | inputLayer
| ) | `[pure virtual]`

This is an optional function to generate the compression layer from the input frequency table. 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 You should only call this when disconnected

Parameters:

  | inputFrenquencyTable | the table to used for compression
  | inputLayer | says if the inputFrequencyTable should be used for sending or receiveing.

Returns:
  false (failure) if connected. Otherwise true (success)

Note:
  The server Sends should share the same inputFrequencyTable as the client for receiving. It's also true for the client sending and the server receiving.

Implemented in RakClient.

virtual int RakClientInterface::GetAveragePing | ( | void |  | ) | `[pure virtual]`

Returns the average of all ping times read

Returns:
  the average ping value to the server

Implemented in RakClient.

virtual float RakClientInterface::GetCompressionRatio | ( | void |  | ) | const`[pure virtual]`

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

Returns:
  the current compression ratio

Implemented in RakClient.

virtual float RakClientInterface::GetDecompressionRatio | ( | void |  | ) | const`[pure virtual]`

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

Returns:
  the current decompression ratio

Implemented in RakClient.

virtual int RakClientInterface::GetLastPing | ( | void |  | ) | const`[pure virtual]`

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

Returns:
  last ping value

Implemented in RakClient.

virtual int RakClientInterface::GetLowestPing | ( | void |  | ) | const`[pure virtual]`

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

Returns:
  lowest ping value

Implemented in RakClient.

virtual int RakClientInterface::GetMTUSize | ( | void |  | ) | const`[pure virtual]`

| Returns the current MTU size Implemented in RakClient.

virtual PlayerID RakClientInterface::GetPlayerID | ( | void |  | ) | const`[pure virtual]`

Return the player number the server has assigned to you.

Returns:
  our player ID

Note:
  that unlike in previous versions, this is a struct and is not sequential

Implemented in RakClient.

virtual PlayerIndex RakClientInterface::GetPlayerIndex | ( | void |  | ) | `[pure virtual]`

| Implemented in RakClient.

virtual int RakClientInterface::GetPlayerPing | ( | PlayerID | playerId | ) | `[pure virtual]`

Returns the last ping for the specified player. This information is broadcast by the server automatically In order to save bandwidth this information is updated only infrequently and only for the first 32 players

Parameters:

  | playerId | The id of the player you want to have the ping (it might be your id)

Returns:
  the last ping for this player

Note:
  You can read your own ping with this method by passing your own playerId, however for more up-to-date readings you should use one of the three functions above

Implemented in RakClient.

virtual bool RakClientInterface::GetSendFrequencyTable | ( | unsigned long | outputFrequencyTable[256] | ) | `[pure virtual]`

Returns the frequency of outgoing bytes into outputFrequencyTable The purpose is to save to file as either a master frequency table from a sample game session for passing to GenerateCompressionLayer. You should only call this when disconnected. Requires that you first enable data frequency tracking by calling SetTrackFrequencyTable(true)

Parameters:

  | outputFrequencyTable | The frequency table produce during the tracking time.

Returns:
  false (failure) if connected or if frequency table tracking is not enabled. Otherwise true (success)

Implemented in RakClient.

virtual PlayerID RakClientInterface::GetServerID | ( | void |  | ) | const`[pure virtual]`

Return the player number of the server.

Returns:
  the server playerID

Implemented in RakClient.

virtual RakNet::BitStream* RakClientInterface::GetStaticClientData | ( | PlayerID | playerId | ) | `[pure virtual]`

The client internally maintains a data struct that is automatically sent to the server on connection This is useful to contain data such as the player name. Access that struct with this function. Pass UNASSIGNED_PLAYER_ID for playerId to reference your internal data. A playerId value to access the data of another player. *** NOTE *** If you change any data in the struct the server won't reflect this change unless you manually update it Do so by calling SendStaticClientDataToServer The data is entered as an array and stored and returned as a BitStream. Everytime you call GetStaticServerData it resets the read pointer to the start of the bitstream. To do multiple reads without reseting the pointer Maintain a pointer copy to the bitstream as in RakNet::BitStream *copy = ...->GetStaticServerData(...); To store a bitstream, use the GetData() and GetNumberOfBytesUsed() methods of the bitstream for the 2nd and 3rd parameters

Implemented in RakClient.

virtual RakNet::BitStream* RakClientInterface::GetStaticServerData | ( | void |  | ) | `[pure virtual]`

The server internally maintains a data struct that is automatically sent to clients when the connect. This is useful to contain data such as the server name or message of the day. Access that struct with this function. The data is entered as an array and stored and returned as a BitStream. Everytime you call GetStaticServerData it resets the read pointer to the start of the bitstream. To do multiple reads without reseting the pointer Maintain a pointer copy to the bitstream as in RakNet::BitStream *copy = ...->GetStaticServerData(...); To store a bitstream, use the GetData() and GetNumberOfBytesUsed() methods of the bitstream for the 2nd and 3rd parameters Note that the server may change at any time the data contents and/or its length!

Returns:
  a bitstream containing statistics.

Implemented in RakClient.

virtual RakNetStatisticsStruct* const RakClientInterface::GetStatistics | ( | void |  | ) | `[pure virtual]`

Returns a structure containing a large set of network statistics for the server/client connection You can map this data to a string using the C style StatisticsToString function

Returns:
  0 on can't find the specified system. A pointer to a set of data otherwise.

Implemented in RakClient.

virtual unsigned long RakClientInterface::GetSynchronizedRandomInteger | ( | void |  | ) | const`[pure virtual]`

Returns a number automatically synchronized between the server and client which randomly changes every 9 seconds. The time it changes is accurate to within a few ms and is best used to seed random number generators that you want to usually return the same output on all systems. Keep in mind this isn't perfectly accurate as there is always a very small chance the numbers will by out of synch during changes so you should confine its use to visual effects or functionality that has a backup method to maintain synchronization. If you don't need this functionality and want to save the bandwidth call StopSynchronizedRandomInteger after starting the server

Returns:
  A random int common to all client and to the server.

Implemented in RakClient.

virtual bool RakClientInterface::HasPassword | ( | void |  | ) | const`[pure virtual]`

Returns true if a password was set, false otherwise

Returns:
  true if a password has previously been set using SetPassword

Implemented in RakClient.

virtual void RakClientInterface::InitializeSecurity | ( | char * | pubKeyP,
|  | char * | pubKeyQ
| ) | `[pure virtual]`

Can be called to use specific public RSA keys. (e and n) In order to prevent altered keys. Will return ID_RSA_PUBLIC_KEY_MISMATCH in a packet If a key has been altered.

Parameters:

  | pubKeyP | Public keys generated from the RSACrypt class. Can be 0
  | pubKeyQ | Public keys generated from the RSACrypt class. Can be 0

See also:
  Encryption sample.

Implemented in RakClient.

virtual bool RakClientInterface::IsConnected | ( | void |  | ) | const`[pure virtual]`

Returns true if the client is connected to a responsive server

Returns:
  true if connected to a server

Implemented in RakClient.

virtual void RakClientInterface::PingServer | ( | char * | host,
|  | unsigned short | serverPort,
|  | unsigned short | clientPort,
|  | bool | onlyReplyOnAcceptingConnections
| ) | `[pure virtual]`

Sends a ping request to a server we are not connected to. This will also initialize the networking system if it is not already initialized. You can stop the networking system by calling Disconnect() The final ping time will be encoded in the following 4 bytes (2-5) as an unsigned long You can specify if the server should only reply if it has an open connection or not This must be true for LAN broadcast server discovery on "255.255.255.255" or you will get replies from clients as well.

Parameters:

  | host | The host to contact
  | ServerPort | the port used by the server
  | clientPort | the port used to receive the answer
  | onlyReplyOnAcceptingConnections | if true the server must be ready to accept incomming connection.

Implemented in RakClient.

virtual void RakClientInterface::PingServer | ( | void |  | ) | `[pure virtual]`

| Send a ping request to the server.Occasional pings are on by default (see StartOccasionalPing and StopOccasionalPing) so unless you turn them off it is not necessary to call this function. It is here for completeness if you want it Does nothing if the client is not connected to begin with Implemented in RakClient.

virtual const char* RakClientInterface::PlayerIDToDottedIP | ( | PlayerID | playerId | ) | const`[pure virtual]`

Returns the dotted IP address for the specified playerId

Parameters:

  | playerId | Any player ID other than UNASSIGNED_PLAYER_ID, even if that player is not currently connected

Returns:
  a dotted notation string representation of the address of playerId.

Implemented in RakClient.

virtual void RakClientInterface::PushBackPacket | ( | Packet * | packet | ) | `[pure virtual]`

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

Parameters:

  | packet | the packet to delayed

Implemented in RakClient.

virtual Packet* RakClientInterface::Receive | ( | void |  | ) | `[pure virtual]`

Call this to get a packet from the incoming packet queue. Use DeallocatePacket to deallocate the packet after you are done with it. Check the Packet struct at the top of CoreNetworkStructures.h for the format of the struct Returns 0 if no packets are waiting to be handled If the client is not active this will also return 0, as all waiting packets are flushed when the client is Disconnected This also updates all memory blocks associated with synchronized memory

Returns:
  the last receive packet

Implemented in RakClient.

virtual void RakClientInterface::RegisterAsRemoteProcedureCall | ( | char * | uniqueID,
|  | void(*)(char *input, int numberOfBitsOfData, PlayerID sender) | functionName
| ) | `[pure virtual]`

Register a C function as available for calling as a remote procedure call uniqueID should be a null terminated non-case senstive string of only letters to identify this procedure Parameter 2 should be the name of the C function or C++ singleton to be used as a function pointer This can be called whether the client is active or not, and registered functions stay registered unless unregistered with UnregisterAsRemoteProcedureCall

Parameters:

  | uniqueID | the id of the RPC
  | functionName | a pointer to the C function.

Implemented in RakClient.

virtual bool RakClientInterface::RPC | ( | char * | uniqueID,
|  | RakNet::BitStream * | parameters,
|  | PacketPriority | priority,
|  | PacketReliability | reliability,
|  | char | orderingChannel,
|  | bool | shiftTimestamp
| ) | `[pure virtual]`

Calls a C function on the server that the server already registered using RegisterAsRemoteProcedureCall Pass the data you want to pass to that function in parameters, or 0 for no data to pass You can also pass a regular data stream which will be converted to a bitstream internally by passing data and bit length If you want that function to return data you should call RPC from that system in the same way Returns true on a successful packet send (this does not indicate the recipient performed the call), false on failure The uniqueID must be composed of a string with only characters from a-z and is not case sensitive

Implemented in RakClient.

virtual bool RakClientInterface::RPC | ( | char * | uniqueID,
|  | char * | data,
|  | unsigned long | bitLength,
|  | PacketPriority | priority,
|  | PacketReliability | reliability,
|  | char | orderingChannel,
|  | bool | shiftTimestamp
| ) | `[pure virtual]`

Calls a C function on the server that the server already registered using RegisterAsRemoteProcedureCall Pass the data you want to pass to that function in parameters, or 0 for no data to pass You can also pass a regular data stream which will be converted to a bitstream internally by passing data and bit length If you want that function to return data you should call RPC from that system in the same way Returns true on a successful packet send (this does not indicate the recipient performed the call), false on failure The uniqueID must be composed of a string with only characters from a-z and is not case sensitive

Implemented in RakClient.

virtual bool RakClientInterface::Send | ( | RakNet::BitStream * | bitStream,
|  | PacketPriority | priority,
|  | PacketReliability | reliability,
|  | char | orderingChannel
| ) | `[pure virtual]`

This function only works while the client is connected (Use the Connect function). Returns false on failure, true on success Sends the BitStream If you aren't sure what to specify for priority and reliability, use HIGH_PRIORITY and RELIABLE, 0 for ordering channel

Parameters:

  | bitstream | the data to send.
  | priority | the priority of the message
  | reliability | the reliability policy required
  | orderingChannel | the channel to send the message to.

Implemented in RakClient.

virtual bool RakClientInterface::Send | ( | char * | data,
|  | const long | length,
|  | PacketPriority | priority,
|  | PacketReliability | reliability,
|  | char | orderingChannel
| ) | `[pure virtual]`

This function only works while the client is connected (Use the Connect function). Returns false on failure, true on success Sends the data stream of length length If you aren't sure what to specify for priority and reliability, use HIGH_PRIORITY and RELIABLE, 0 for ordering channel

Parameters:

  | data | a byte buffer
  | length | the size of the byte buffer
  | priority | the priority of the message
  | reliability | the reliability policy required
  | orderingChannel | the channel to send the message to.

Implemented in RakClient.

virtual void RakClientInterface::SendStaticClientDataToServer | ( | void |  | ) | `[pure virtual]`

Send the static server data to the server The only time you need to call this function is to update clients that are already connected when you change the static server data by calling GetStaticServerData and directly modifying the object pointed to. Obviously if the connected clients don't need to know the new data you don't need to update them, so it's up to you The server must be active for this to have meaning

Implemented in RakClient.

virtual bool RakClientInterface::SetMTUSize | ( | int | size | ) | `[pure virtual]`

Change the MTU size in order to improve performance when sending large packets This can only be called when not connected. Returns false on failure (we are connected). True on success. Maximum allowed size is MAXIMUM_MTU_SIZE A too high of value will cause packets not to arrive at worst and be fragmented at best. A too low of value will split packets unnecessarily. Set according to the following table: 1500. The largest Ethernet packet size; it is also the default value. This is the typical setting for non-PPPoE, non-VPN connections. The default value for NETGEAR routers, adapters and switches. 1492. The size PPPoE prefers. 1472. Maximum size to use for pinging. (Bigger packets are fragmented.) 1468. The size DHCP prefers. 1460. Usable by AOL if you don't have large email attachments, etc. 1430. The size VPN and PPTP prefer. 1400. Maximum size for AOL DSL. 576. Typical value to connect to dial-up ISPs. (Default)

Implemented in RakClient.

virtual void RakClientInterface::SetPassword | ( | char * | _password | ) | `[pure virtual]`

Set the password to use when connecting to a server. The password persists between connections. Pass 0 for no password.

Parameters:

  | _password | The password to use to connect to a server

Implemented in RakClient.

virtual void RakClientInterface::SetStaticClientData | ( | PlayerID | playerId,
|  | char * | data,
|  | const long | length
| ) | `[pure virtual]`

Set Local statistical information for playId. Call this function when you receive statistical information from a client.

Parameters:

  | playerId | the player ID
  | data | the packet data
  | length | the size of the data

Implemented in RakClient.

virtual void RakClientInterface::SetStaticServerData | ( | char * | data,
|  | const long | length
| ) | `[pure virtual]`

The server internally maintains a data struct that is automatically sent to clients when the connect. This is useful to contain data such as the server name or message of the day. Access that struct with this function. The data is entered as an array and stored and returned as a BitStream. Everytime you call GetStaticServerData it resets the read pointer to the start of the bitstream. To do multiple reads without reseting the pointer Maintain a pointer copy to the bitstream as in RakNet::BitStream *copy = ...->GetStaticServerData(...); To store a bitstream, use the GetData() and GetNumberOfBytesUsed() methods of the bitstream for the 2nd and 3rd parameters Note that the server may change at any time the data contents and/or its length!

Parameters:

  | data | a byte buffer containing statistical information.
  | length | the size of data

Implemented in RakClient.

virtual void RakClientInterface::SetTrackFrequencyTable | ( | bool | b | ) | `[pure virtual]`

Enables or disables frequency table tracking. This is required to get a frequency table, which is used to generate A new compression layer. You can call this at any time - however you SHOULD only call it when disconnected. Otherwise you will only track part of the values sent over the network. This value persists between connect calls and defaults to false (no frequency tracking)

Parameters:

  | b | true to unable tracking.

Implemented in RakClient.

virtual void RakClientInterface::StartOccasionalPing | ( | void |  | ) | `[pure virtual]`

| Ping the server every so often. This is on by default. In games where you don't care about ping you can call StopOccasionalPing to save the bandwidth This will work anytime Implemented in RakClient.

virtual void RakClientInterface::StopOccasionalPing | ( | void |  | ) | `[pure virtual]`

| Stop pinging the server every so often. The server is pinged by default. In games where you don't care about ping you can call this to save the bandwidth This will work anytime Implemented in RakClient.

virtual void RakClientInterface::UnregisterAsRemoteProcedureCall | ( | char * | uniqueID | ) | `[pure virtual]`

Unregisters a C function as available for calling as a remote procedure call that was formerly registered with RegisterAsRemoteProcedureCall

Parameters:

  | uniqueID | the id of the RPC.

Implemented in RakClient.

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

- Projects/raknet/include/raknet/RakClientInterface.h