RakNet Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
_JitterBufferPacket
LobbyDBSpec::AddAccountNote_DataAdds an entry to the accountNotes table for an existing user
LobbyDBSpec::AddFriend_DataAdds a userId / friendId to the friends table
TitleValidationDBSpec::AddTitle_DataAdds a title to the database of titles. This can be used to look up titleIds given a title password
LobbyDBSpec::AddToIgnoreList_DataAdds to the ignoreList table for a particular userId / userHandle
AutopatcherPostgreRepository
AutopatcherRepositoryInterfaceAn interface used by AutopatcherServer to get the data necessary to run an autopatcher. This is up to you to implement for custom repository solutions
RakNet::AutoRPC
DataStructures::AVLBalancedBinarySearchTree< BinarySearchTreeType >An AVLBalancedBinarySearchTree is a binary tree that is always balanced
DataStructures::BinarySearchTree< BinarySearchTreeType >A binary search tree and an AVL balanced binary search tree
RakNet::BitStream
DataStructures::BPlusTree< KeyType, DataType, order >
CheckSumGenerates and validates checksums
DataStructures::CircularLinkedList< CircularLinkedListType >(Circular) Linked List ADT (Doubly Linked Pointer to Node Style) -
CommandParserInterfaceThe interface used by command parsers
RakNet::Connection_RM2This class represents a connection between two instances of ReplicaManager2 Represents a connection. Allocated by user supplied factory interface Connection_RM2Factory Implicitly created as needed Generally you will want to implement at a minimum the Construct() function, used as a factory function to create your game objects
RakNet::Connection_RM2FactoryImplement this factory class to return instances of your Connection_RM2 derived object. This is used as a class factory and exposes functionality related to the connection and the system
ConnectionGraphA connection graph. Each peer will know about all other peers
ConnectionGraph::SystemAddressAndGroupIdA node in the connection graph
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
LobbyDBSpec::CreateUser_DataAdds a user to the users table
DatabaseCellUpdateThe value to write to a cell in a remote database
DataBlockEncryptorEncrypts and decrypts data blocks
DataCompressorDoes compression on a block of data. Not very good compression, but it's small and fast so is something you can compute at runtime
DecState
LobbyDBSpec::DeleteEmail_DataDeletes an email from either the incomingEmails or sentEmails table
DirectoryDeltaTransferSimple class to send changes between directories. In essence, a simple autopatcher that can be used for transmitting levels, skins, etc
drft_lookup
EmailSenderRudimentary class to send email from code
EncState
FileListTransferA plugin to provide a simple way to compress and incrementally send the files in the FileList structure. Similar to the DirectoryDeltaTransfer plugin, except that it doesn't send deltas based on pre-existing files or actually write the files to disk
FileListTransferCBInterfaceUsed by FileListTransfer plugin as a callback for when we get a file. You get the last file when fileIndex==setCount
FullyConnectedMesh
RakNet::FunctionThread
RakNet::Functor
LobbyDBSpec::GetAccountNotes_DataGets all account notes for an existing user
LobbyDBSpec::GetEmails_DataGets all emails in the emails table for a particular user
LobbyDBSpec::GetFriends_DataGets the friends table for a userId or userHandle
RankingServerDBSpec::GetHistoryForParticipant_DataGiven a particular player and game, get a match history
GetHistoryForParticipant_PostgreSQLImplGiven a particular player and game, get a match history
LobbyDBSpec::GetIgnoreList_DataGets the ignoreList table for a particular userId / userHandle
RankingServerDBSpec::GetRatingForParticipant_DataGiven a particular player and game, get that player's rating from the database
GetRatingForParticipant_PostgreSQLImplGiven a particular player and game, get that player's rating from the database
RankingServerDBSpec::GetRatingForParticipants_DataGiven a particular game, get ratings for all players
GetRatingForParticipants_PostgreSQLImplGiven a particular game, get ratings for all players
TitleValidationDBSpec::GetTitles_DataDownload all titles added with AddTitle_Data
RankingServerDBSpec::GetTrustedIPList_Data
LobbyDBSpec::GetUser_DataGet a user from the users table, using userId or userHandle for the lookup
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
HuffmanEncodingTreeFactoryCreates instances of the class HuffmanEncodingTree
InternalPacket
JitterBuffer_
LightweightDatabaseClientThe client interface to the simple database included with RakNet, useful for a server browser or a lobby server
LightweightDatabaseServerA simple flat database included with RakNet, useful for a server browser or a lobby server. A flat database interface. Adds the ability to track IPs of row updaters and passwords for table read and write operations, Best used for data in which queries which do not need to be updated in real-time
DataStructures::List< list_type >Array based implementation of a list
RakNet::LobbyClientInterfaceThe client-side interface to the lobby system The Lobby client implements functionality commonly found in game lobbies. It is the counterpart to the LobbyServer class. This interface is system independent, but for PC functionality see LobbyClientPC For full documentation on the PC version, see LobbyClientPC.h
RakNet::LobbyClientPCPC specific client side code to the lobby system Attach class as a plugin to RakNet as usual. Connect to the lobby server (as usual). Then use provided functions for specific functionality
LobbyDB_PostgreSQL
LobbyDBCBInterfaceIf you want to forward Functor::HandleResult() the output to a callback (which is what it does by default), you can use this
RakNet::LobbyServer
RakNet::LobbyServerPostgreSQL
LogCommandParserAdds the ability to send logging output to a remote console
LogCommandParser::SystemAddressAndChannelOne of these structures is created per player
ltp_params
DataStructures::Map< key_type, data_type, key_comparison_func >
Note:
IMPORTANT! If you use defaultMapKeyComparison then call IMPLEMENT_DEFAULT_COMPARISON or you will get an unresolved external linker error
MemoryCompressorCompress one or more blocks of data
DataStructures::MemoryPool< MemoryBlockType >
MessageFilterAssigns systems to FilterSets. Each FilterSet limits what kinds of messages are allowed. The MessageFilter plugin is used for security where you limit what systems can send what kind of messages. You implicitly define FilterSets, and add allowed message IDs and RPC calls to these FilterSets. You then add systems to these filters, such that those systems are limited to sending what the filters allows. You can automatically assign systems to a filter. You can automatically kick and possibly ban users that stay in a filter too long, or send the wrong message. Each system is a member of either zero or one filters. Add this plugin before any plugin you wish to filter (most likely just add this plugin before any other)
RankingServerDBSpec::ModifyTrustedIPList_Data
ModifyTrustedIPList_PostgreSQLImplModify the list of IPs allowed to submit matches
NatPunchthroughImplements the NAT punch through technique, allowing two systems to connect to each other that are both behind NATs
NetworkIDManager
NetworkIDObjectUnique shared ids for each object instance
DataStructures::OrderedList< key_type, data_type, default_comparison_function >
Note:
IMPORTANT! If you use defaultOrderedListComparison then call IMPLEMENT_DEFAULT_COMPARISON or you will get an unresolved external linker error
PacketThis represents a user message from another system
PacketConsoleLoggerPacketlogger that logs to a remote command console
PacketFileLoggerPacketlogger that outputs to a file
PacketLoggerWrites incoming and outgoing messages to the screen. This will write all incoming and outgoing messages to the console window, or to a file if you override it and give it this functionality
DataStructures::Page< KeyType, DataType, order >
RankingServerDBSpec::PairedKeyDbId
PluginInterfacePluginInterface provides a mechanism to add functionality in a modular way. MessageHandlers should derive from PluginInterface and be attached to RakPeer using the function AttachPlugin On a user call to Receive, OnReceive is called for every PluginInterface, which can then take action based on the message passed to it. This is used to transparently add game-independent functional modules, similar to browser plugins
DataStructures::Queue< queue_type >A queue implemented as an array with a read and write index
DataStructures::QueueLinkedList< QueueType >A queue implemented using a linked list. Rarely used
RakNetCommandParserThis allows a console client to call most of the functions in RakPeer
RakNetStatisticsNetwork 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
RakPeerThe main interface for network communications
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_NETWORK_ID for none) is in an unsorted list of memory blocks
RakPeerInterfaceThe main interface for network communications
RakNet::RakStringString class Has the following improvements over std::string Reference counting: Suitable to store in lists Varidic assignment operator Doesn't cause linker errors
RankingServer_PostgreSQL
RankingServerCBInterfaceIf you want to forward Functor::HandleResult() the output to a callback (which is what it does by default), you can use this
ReadyEvent
ReceiveConstructionInterface
ReceiveDownloadCompleteInterface
RefCountedObjWorld's simplest class :)
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
LobbyDBSpec::RemoveFriend_DataRemoves a userId / friendId from the friends table
LobbyDBSpec::RemoveFromIgnoreList_DataRemoves from the ignoreList table for a particular userId / userHandle
ReplicaThe interface to derive your game's networked classes from
RakNet::Replica2Base class for game objects that use the ReplicaManager2 system All game objects that want to use the ReplicaManager2 functionality must inherit from Replica2. Generally you will want to implement at a minimum Serialize(), Deserialize(), and SerializeConstruction()
ReplicaManagerA management system for your game objects and players to make serialization, scoping, and object creation and destruction easier
RakNet::ReplicaManager2A management system for your game objects and players to make serialization, scoping, and object creation and destruction easier
RouterUsed to route messages between peers
RouterInterfaceOn failed directed sends, RakNet can call an alternative send function to use
RPCParameters
SBDecState
SBEncState
SendDownloadCompleteInterface
LobbyDBSpec::SendEmail_DataAdds an email to the emails table. Added once for the user with inbox=false, n times for n recipients with inbox=true
RakNet::SerializationContextContextual information about serialization, passed to some functions in Replica2
SimpleMutexAn easy to use mutex
DataStructures::SingleProducerConsumer< SingleProducerConsumerType >A single producer consumer implementation without critical sections
SocketDescriptorDescribes the local socket to use for RakPeer::Startup
SpeexBits
SpeexCallback
SpeexEchoState
SpeexEchoState_
SpeexHeader
SpeexMode
SpeexNBMode
SpeexPreprocessState_
SpeexSBMode
SpeexStereoState
SpeexSubmode
split_cb_params
StrAndBoolThe string plus a bool telling us if this string was copied or not
StringCompressorWrites and reads strings to and from bitstreams
RakNet::StringTableWrites a string index, instead of the whole string
RankingServerDBSpec::SubmitMatch_Data
SubmitMatch_PostgreSQLImpl
SystemAddressUnique identifier for a system. Corresponds to a network address
DataStructures::TableHolds a set of columns, a set of rows, and rows times columns cells. The table data structure is useful if you want to store a set of structures and perform queries on those structures This is a relatively simple and fast implementation of the types of tables commonly used in databases See TableSerializer to serialize data members of the table See LightweightDatabaseClient and LightweightDatabaseServer to transmit the table over the network
DataStructures::Table::CellHolds the actual data in the table
DataStructures::Table::ColumnDescriptor
DataStructures::Table::RowStores the list of cells for this row, and a special flag used for internal sorting
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
ThreadPool< InputType, OutputType >
ThreadsafePacketLoggerSame as PacketLogger, but writes output in the user thread
TimingBuffer
TitleValidation_PostgreSQL
TitleValidationDBCBInterfaceIf you want to forward Functor::HandleResult() the output to a callback (which is what it does by default), you can use this
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
LobbyDBSpec::UpdateEmailStatus_DataUpdates the mark flags on an email
LobbyDBSpec::UpdateUser_DataOverwrites an existing user in the users table
TitleValidationDBSpec::UpdateUserKey_Data
VBRState

Generated on Mon Mar 31 21:15:53 2008 for RakNet by  doxygen 1.5.4