RakNet Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
AutoPatcherAutopatcher Subsystem
BasicDataStructures::AVLBalancedBinarySearchTree< BinarySearchTreeType >An AVLBalancedBinarySearchTree is a binary tree that is always balanced
BasicDataStructures::BinarySearchTree< BinarySearchTreeType >A binary search tree and an AVL balanced binary search tree
RakNet::BitStream
CheckSumGenerates and validates checksums
BasicDataStructures::CircularLinkedList< CircularLinkedListType >(Circular) Linked List ADT (Doubly Linked Pointer to Node Style) -
CommandParserInterfaceThe interface used by command parsers
ConsoleServerThe main entry point for the server portion of your remote console application support. ConsoleServer takes one TransportInterface and one or more CommandParserInterface (s) The TransportInterface will be used to send data between the server and the client. The connecting client must support the protocol used by your derivation of TransportInterface . TelnetTransport and RakNetTransport are two such derivations . When a command is sent by a remote console, it will be processed by your implementations of CommandParserInterface
DataBlockEncryptorEncrypts and decrypts data blocks
DataReplicatorThis class, based on the plugin system, is designed to automatically create and destroy your objects, transmit object scope, and synchronize memory
DownloadableFileDescriptorFile information
FCM_RemotePeerStores data for each peer in the mesh
FullyConnectedMeshFully connected mesh plugin. This will connect RakPeer to all connecting peers, and all peers the connecting peer knows about
HuffmanEncodingTreeThis generates special cases of the huffman encoding tree using 8 bit keys with the additional condition that unused combinations of 8 bits are treated as a frequency of 1
HuffmanEncodingTree::CharacterEncodingUsed to hold bit encoding for one character
HuffmanEncodingTreeFactoryCreates instances of the class HuffmanEncodingTree
InternalPacketHolds a user message, and related information
InternalPacketPool
BasicDataStructures::List< list_type >Array based implementation of a list
LogCommandParserAdds the ability to send logging output to a remote console
LogCommandParser::PlayerIDAndChannelOne of these structures is created per player
Multiplayer< InterfaceType >Maps packet IDs to functions
NetworkIDGeneratorUnique shared ids for each object instance
BasicDataStructures::OrderedList< data_type, key_type >The ordered list class is a list which keeps its elements in order
PacketThis represents a user message from another system
PacketLoggerThis will write all incoming and outgoing messages to the console window, or to a file if you override it and give it this functionality
PlayerIDUnique identifier for a system. Corresponds to a network address
PluginInterfacePluginInterface provides a mechanism to add functionality in a modular way
BasicDataStructures::Queue< queue_type >A queue implemented as an array with a read and write index
BasicDataStructures::QueueLinkedList< QueueType >A queue implemented using a linked list. Rarely used
RakClientDefines the functions used by a game client
RakClientInterfaceDefines the functions used by a game client
RakNetCommandParserThis allows a console client to call most of the functions in RakPeer
RakNetStatisticsStructNetwork Statisics Usage
RakNetTransportUse RakNetTransport if you need a secure connection between the client and the console server. RakNetTransport automatically initializes security for the system. Use the project CommandConsoleClient to connect To the ConsoleServer if you use RakNetTransport
RakNetTransportCommandParserRakNetTransport has its own command parser to enable remote users to change the command console's password
RakNetworkFactoryFactory class for RakServerInterface, RakClientInterface, and RakPeerInterface
RakPeerDefines the functions used by a game server
RakPeer::MemoryBlockAutomatic Variable Synchronization Mechanism automatic variable synchronization takes a primary and secondary identifier The unique primary identifier is the index into the automaticVariableSynchronizationList The unique secondary identifier (UNASSIGNED_OBJECT_ID for none) is in an unsorted list of memory blocks
RakPeerInterfaceDefines the functions used by a game server
RakServerDefines the functions used by a game server
RakServerInterfaceDefines the functions used by a game server
RakVoiceRakVoice voice communication library
RakVoiceFactoryCreate an instance of RakVoice
RakVoiceInterfaceDefine the user interface of the RakVoice module
ReliabilityLayerDatagram reliable, ordered, unordered and sequenced sends. Flow control. Message splitting, reassembly, and coalescence
RemoteClientStores information about a remote client. In this case, only the socket used by that client
ReplicatedObjectThis class provides an interface so RakNet can do object initial serializations and notifications of scope changes
RPCParametersAll RPC functions have the same parameter list - this structure
SimpleMutexAn easy to use mutex
BasicDataStructures::SingleProducerConsumer< SingleProducerConsumerType >A single producer consumer implementation without critical sections
StringCompressorWrites and reads strings to and from bitstreams
TelnetTransportUse TelnetTransport to easily allow windows telnet to connect to your ConsoleServer To run Windows telnet, go to your start menu, click run, and in the edit box type "telnet <IP>" where <IP> is the ip address of your ConsoleServer (most likely the same IP as your game). This implementation always echos commands
TransportInterfaceDefines an interface that is used to send and receive null-terminated strings. In practice this is only used by the CommandParser system for for servers

Generated on Mon Mar 20 20:32:54 2006 for RakNet by  doxygen 1.4.6-NO