File List

Here is a list of all documented files with brief descriptions:
C:/RakNet/DependentExtensions/AutopatcherClient.hClient plugin for the autopatcher
C:/RakNet/DependentExtensions/AutopatcherServer.cppThe server plugin for the autopatcher. Must be running for the client to get patches
C:/RakNet/DependentExtensions/AutopatcherServer.hThe server plugin for the autopatcher. Must be running for the client to get patches
C:/RakNet/DependentExtensions/RakVoice.hVoice compression and transmission interface
C:/RakNet/DependentExtensions/AutopatcherMySQLRepository/AutopatcherMySQLRepository.hAn implementation of the AutopatcherRepositoryInterface to use MySQL to store the relevant data
C:/RakNet/DependentExtensions/AutopatcherPostgreRepository/AutopatcherPostgreRepository.cppAn implementation of the AutopatcherRepositoryInterface to use PostgreSQL to store the relevant data
C:/RakNet/DependentExtensions/AutopatcherPostgreRepository/AutopatcherPostgreRepository.hAn implementation of the AutopatcherRepositoryInterface to use PostgreSQL to store the relevant data
C:/RakNet/DependentExtensions/Lobby/LobbyClientInterface.hInterface to the lobby client. Not platform specific
C:/RakNet/DependentExtensions/Lobby/LobbyClientPC.hInterface to the lobby client for the PC
C:/RakNet/DependentExtensions/Lobby/LobbyDBSpec.hNot code so much as a specification for the structures and classes that an implementation of the lobby server can use
C:/RakNet/DependentExtensions/Lobby/LobbyPCCommon.hCommon source between the lobby client and the lobby server for the PC
C:/RakNet/DependentExtensions/Lobby/LobbyServer.hBase class that implements the networking for the lobby server. Database specific functionality is implemented in a derived class
C:/RakNet/DependentExtensions/Lobby/RankingServerDBSpec.hNot code so much as a specification for the structures and classes that an implementation of the ranking server can use
C:/RakNet/DependentExtensions/Lobby/TitleValidationDBSpec.hNot code so much as a specification for the structures and classes that an implementation of a title validation system (CD Keys and game server logins)
C:/RakNet/DependentExtensions/Lobby/LobbyDB_PostgreRepository/LobbyDB_PostgreSQL.cppAn implementation of the LobbyServer database to use PostgreSQL to store the relevant data
C:/RakNet/DependentExtensions/Lobby/LobbyDB_PostgreRepository/LobbyDB_PostgreSQL.hAn implementation of the LobbyServer database to use PostgreSQL to store the relevant data
C:/RakNet/DependentExtensions/Lobby/LobbyServer_PostgreSQL/LobbyServer_PostgreSQL.hBase class that implements the networking for the lobby server. Database specific functionality is implemented in a derived class
C:/RakNet/DependentExtensions/Lobby/RankingServerDB_PostgreRepository/RankingServer_PostgreSQL.cppAn implementation of the RankingRepositoryInterface to use PostgreSQL to store the relevant data
C:/RakNet/DependentExtensions/Lobby/RankingServerDB_PostgreRepository/RankingServer_PostgreSQL.hAn implementation of the RankingServerPostgreRepository to use PostgreSQL to store ranking info for users
C:/RakNet/DependentExtensions/Lobby/TitleValidationDB_PostgreRepository/TitleValidationDB_PostgreSQL.cppAn implementation of TitleValidationDBSpec.h to use PostgreSQL. Title validation is useful for checking server logins and cd keys
C:/RakNet/DependentExtensions/Lobby/TitleValidationDB_PostgreRepository/TitleValidationDB_PostgreSQL.hAn implementation of TitleValidationDBSpec.h to use PostgreSQL. Title validation is useful for checking server logins and cd keys
C:/RakNet/DependentExtensions/Lobby2/Rooms/RoomsPlugin.hAdds networking to AllGamesRoomsContainer. Lets you create, join, search, and destroy matchmaking rooms for players
C:/RakNet/DependentExtensions/RPC3/RPC3.hAutomatically serializing and deserializing RPC system. Third generation of RPC
C:/RakNet/DependentExtensions/speex-1.1.12/include/speex/pcm_wrapper.hPCM encoding wrapped as a Speex mode
C:/RakNet/DependentExtensions/speex-1.1.12/include/speex/speex.hDescribes the different modes of the codec
C:/RakNet/DependentExtensions/speex-1.1.12/include/speex/speex_bits.hHandles bit packing/unpacking
C:/RakNet/DependentExtensions/speex-1.1.12/include/speex/speex_callbacks.hDescribes callback handling and in-band signalling
C:/RakNet/DependentExtensions/speex-1.1.12/include/speex/speex_echo.hEcho cancellation
C:/RakNet/DependentExtensions/speex-1.1.12/include/speex/speex_header.hDescribes the Speex header
C:/RakNet/DependentExtensions/speex-1.1.12/include/speex/speex_jitter.hAdaptive jitter buffer for Speex
C:/RakNet/DependentExtensions/speex-1.1.12/include/speex/speex_preprocess.hSpeex preprocessor
C:/RakNet/DependentExtensions/speex-1.1.12/include/speex/speex_stereo.hDescribes the handling for intensity stereo
C:/RakNet/DependentExtensions/speex-1.1.12/include/speex/speex_types.hSpeex types
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/arch.hVarious architecture definitions Speex
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/cb_search.hOverlapped codebook search
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/cb_search_arm4.hFixed codebook functions (ARM4 version)
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/cb_search_bfin.hFixed codebook functions (Blackfin version)
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/cb_search_sse.hFixed codebook functions (SSE version)
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/filters.hVarious analysis/synthesis filters
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/filters_arm4.hVarious analysis/synthesis filters (ARM4 version)
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/filters_bfin.hVarious analysis/synthesis filters (Blackfin version)
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/filters_sse.hVarious analysis/synthesis filters (SSE version)
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/fixed_arm4.hARM4 fixed-point operations
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/fixed_arm5e.hARM-tuned fixed-point operations
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/fixed_bfin.hBlackfin fixed-point operations
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/fixed_debug.hFixed-point operations with debugging
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/fixed_generic.hGeneric fixed-point operations
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/lpc.hFunctions for LPC (Linear Prediction Coefficients) analysis
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/lpc_bfin.hFunctions for LPC (Linear Prediction Coefficients) analysis (Blackfin version)
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/lsp.hLine Spectral Pair (LSP) functions
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/ltp.hLong-Term Prediction functions
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/ltp_arm4.hLong-Term Prediction functions (ARM4 version)
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/ltp_bfin.hLong-Term Prediction functions (Blackfin version)
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/ltp_sse.hLong-Term Prediction functions (SSE version)
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/math_approx.hVarious math approximation functions for Speex
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/misc.hVarious compatibility routines for Speex
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/misc_bfin.hVarious compatibility routines for Speex (Blackfin version)
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/modes.hDescribes the different modes of the codec
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/nb_celp.hNarrowband CELP encoder/decoder
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/pcm_wrapper.cPCM encoding wrapped as a Speex mode
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/pseudofloat.hPseudo-floating point
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/quant_lsp.hLSP vector quantization
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/sb_celp.hSub-band CELP mode used for wideband encoding
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/smallft.hDiscrete Rotational Fourier Transform (DRFT)
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/stack_alloc.hTemporary memory allocation on stack
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/vbr.hVariable Bit-Rate (VBR) related routines
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/vq.hVector quantization
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/vq_arm4.hARM4-optimized vq routine
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/vq_bfin.hBlackfin-optimized vq routine
C:/RakNet/DependentExtensions/speex-1.1.12/libspeex/vq_sse.hSSE-optimized vq routine
C:/RakNet/Source/AsynchronousFileIO.cpp
C:/RakNet/Source/AsynchronousFileIO.h[Internal] Depreciated, used for windows back when I supported IO completion ports
C:/RakNet/Source/AutopatcherRepositoryInterface.hAn interface used by AutopatcherServer to get the data necessary to run an autopatcher
C:/RakNet/Source/AutoRPC.hAutomatically serializing and deserializing RPC system. More advanced RPC, but possibly not cross-platform
C:/RakNet/Source/BitStream.cpp
C:/RakNet/Source/BitStream.hThis class allows you to write and read native types as a string of bits. BitStream is used extensively throughout RakNet and is designed to be used by users as well
C:/RakNet/Source/BitStream_NoTemplate.cpp
C:/RakNet/Source/BitStream_NoTemplate.hThis class allows you to write and read native types as a string of bits. BitStream is used extensively throughout RakNet and is designed to be used by users as well
C:/RakNet/Source/CheckSum.cppCheckSum implementation from http://www.flounder.com/checksum.htm
C:/RakNet/Source/CheckSum.h[Internal] Generates and validates checksums
C:/RakNet/Source/ClientContextStruct.h[Internal] Depreciated, back from when I supported IO Completion ports
C:/RakNet/Source/CommandParserInterface.hContains CommandParserInterface , from which you derive custom command parsers
C:/RakNet/Source/ConnectionGraph.cpp
C:/RakNet/Source/ConnectionGraph.hConnection graph plugin. This maintains a graph of connections for the entire network, so every peer knows about every other peer
C:/RakNet/Source/ConsoleServer.hContains ConsoleServer , used to plugin to your game to accept remote console-based connections
C:/RakNet/Source/DataBlockEncryptor.cpp
C:/RakNet/Source/DataBlockEncryptor.h[Internal] Encrypts and decrypts data blocks. Used as part of secure connections
C:/RakNet/Source/DataCompressor.hDataCompressor does compression on a block of data. Not very good compression, but it's small and fast so is something you can use per-message at runtime
C:/RakNet/Source/DirectoryDeltaTransfer.hSimple class to send changes between directories. In essence, a simple autopatcher that can be used for transmitting levels, skins, etc
C:/RakNet/Source/DS_BinarySearchTree.h[Internal] A binary search tree, and an AVL balanced BST derivation
C:/RakNet/Source/DS_ByteQueue.h[Internal] Byte queue
C:/RakNet/Source/DS_Heap.h[Internal] Heap (Also serves as a priority queue)
C:/RakNet/Source/DS_HuffmanEncodingTree.cpp
C:/RakNet/Source/DS_HuffmanEncodingTree.h[Internal] Generates a huffman encoding tree, used for string and global compression
C:/RakNet/Source/DS_HuffmanEncodingTreeFactory.h[Internal] Creates instances of the class HuffmanEncodingTree
C:/RakNet/Source/DS_HuffmanEncodingTreeNode.h[Internal] A single node in the Huffman Encoding Tree
C:/RakNet/Source/DS_LinkedList.h[Internal] Straightforward linked list data structure
C:/RakNet/Source/DS_List.h[Internal] Array based list. Usually the Queue class is used instead, since it has all the same functionality and is only worse at random access
C:/RakNet/Source/DS_Map.h[Internal] Map
C:/RakNet/Source/DS_OrderedChannelHeap.h[Internal] Ordered Channel Heap . This is a heap where you add to it on multiple ordered channels, with each channel having a different weight
C:/RakNet/Source/DS_OrderedList.h[Internal] Quicksort ordered list
C:/RakNet/Source/DS_Queue.h[Internal] A queue used by RakNet
C:/RakNet/Source/DS_QueueLinkedList.h[Internal] A queue implemented as a linked list
C:/RakNet/Source/DS_Tree.h[Internal] Just a regular tree
C:/RakNet/Source/DS_WeightedGraph.h[Internal] Weighted graph. I'm assuming the indices are complex map types, rather than sequential numbers (which could be implemented much more efficiently)
C:/RakNet/Source/EmailSender.hRudimentary class to send email from code. Don't expect anything fancy
C:/RakNet/Source/ExtendedOverlappedPool.cpp
C:/RakNet/Source/ExtendedOverlappedPool.h[Depreciated] This was used for IO completion ports
C:/RakNet/Source/FCMHost.hIn a fully connected mesh, determines which system can act as a host. This generally is the system that has been connected to the mesh the longest
C:/RakNet/Source/FileListTransfer.hA plugin to provide a simple way to compress and incrementally send the files in the FileList structure
C:/RakNet/Source/FullyConnectedMesh.cpp
C:/RakNet/Source/FullyConnectedMesh.hFully connected mesh plugin. This will connect RakPeer to all connecting peers, and all peers the connecting peer knows about
C:/RakNet/Source/FunctionThread.hA set of classes to make it easier to perform asynchronous function processing
C:/RakNet/Source/GetTime.cpp
C:/RakNet/Source/GetTime.hReturns the value from QueryPerformanceCounter. This is the function RakNet uses to represent time
C:/RakNet/Source/HTTPConnection.cppContains HTTPConnection, used to communicate with web servers
C:/RakNet/Source/HTTPConnection.hContains HTTPConnection, used to communicate with web servers
C:/RakNet/Source/InternalPacket.h[Internal] A class which stores a user message, and all information associated with sending and receiving that message
C:/RakNet/Source/LightweightDatabaseClient.hContains the client interface to the simple database included with RakNet, useful for a server browser or a lobby server
C:/RakNet/Source/LightweightDatabaseServer.hA simple flat database included with RakNet, useful for a server browser or a lobby server
C:/RakNet/Source/LogCommandParser.hContains LogCommandParser , Used to send logs to connected consoles
C:/RakNet/Source/MessageFilter.hMessage filter plugin. Assigns systems to FilterSets. Each FilterSet limits what messages are allowed. This is a security related plugin
C:/RakNet/Source/MessageIdentifiers.hAll the message identifiers used by RakNet. Message identifiers comprise the first byte of any message
C:/RakNet/Source/MTUSize.h[Internal] Defines the default maximum transfer unit
C:/RakNet/Source/NatPunchthrough.hContains the NAT-punchthrough plugin
C:/RakNet/Source/NetworkIDManager.cpp
C:/RakNet/Source/NetworkIDManager.h
C:/RakNet/Source/NetworkIDObject.cpp
C:/RakNet/Source/NetworkIDObject.hA class you can derive from to make it easier to represent every networked object with an integer. This way you can refer to objects over the network
C:/RakNet/Source/PacketConsoleLogger.hThis will write all incoming and outgoing network messages to the log command parser, which can be accessed through Telnet
C:/RakNet/Source/PacketFileLogger.hThis will write all incoming and outgoing network messages to a file
C:/RakNet/Source/PacketLogger.cpp
C:/RakNet/Source/PacketLogger.hThis will write all incoming and outgoing network messages to the local console screen. See derived functions for other outputs
C:/RakNet/Source/PacketPriority.hThis file contains enumerations for packet priority and reliability enumerations
C:/RakNet/Source/PluginInterface.cpp
C:/RakNet/Source/PluginInterface.hRakNet's plugin functionality system. You can derive from this to create your own plugins
C:/RakNet/Source/RakMemoryOverride.hIf _USE_RAK_MEMORY_OVERRIDE is defined, memory allocations go through rakMalloc, rakRealloc, and rakFree
C:/RakNet/Source/RakNetCommandParser.hContains RakNetCommandParser , used to send commands to an instance of RakPeer
C:/RakNet/Source/RakNetStatistics.cpp
C:/RakNet/Source/RakNetStatistics.hA structure that holds all statistical data returned by RakNet
C:/RakNet/Source/RakNetTransport.hContains RakNetTransportCommandParser and RakNetTransport used to provide a secure console connection
C:/RakNet/Source/RakNetTypes.cpp
C:/RakNet/Source/RakNetTypes.hTypes used by RakNet, most of which involve user code
C:/RakNet/Source/RakNetworkFactory.cpp
C:/RakNet/Source/RakNetworkFactory.hFactory class for RakNet objects
C:/RakNet/Source/RakPeer.cpp
C:/RakNet/Source/RakPeer.hThe main class used for data transmission and most of RakNet's functionality
C:/RakNet/Source/RakPeerInterface.hAn interface for RakPeer. Simply contains all user functions as pure virtuals
C:/RakNet/Source/Rand.h[Internal] Random number generator
C:/RakNet/Source/ReadyEvent.hReady event plugin. This enables a set of systems to create a signal event, set this signal as ready or unready, and to trigger the event when all systems are ready
C:/RakNet/Source/RefCountedObj.hReference counted object. Very simple class for quick and dirty uses
C:/RakNet/Source/ReliabilityLayer.cpp
C:/RakNet/Source/ReliabilityLayer.h[Internal] Datagram reliable, ordered, unordered and sequenced sends. Flow control. Message splitting, reassembly, and coalescence
C:/RakNet/Source/Replica.hContains interface Replica used by the ReplicaManager
C:/RakNet/Source/ReplicaEnums.hContains enumerations used by the ReplicaManager system. This file is a lightweight header, so you can include it without worrying about linking in lots of other crap
C:/RakNet/Source/ReplicaManager.hContains class ReplicaManager. This system provides management for your game objects and players to make serialization, scoping, and object creation and destruction easier
C:/RakNet/Source/ReplicaManager2.hContains the second iteration of the ReplicaManager class. This system automatically creates and destroys objects, downloads the world to new players, manages players, and automatically serializes as needed
C:/RakNet/Source/Rijndael.h[Internal] AES encoding / decoding rijndael-alg-fst.h v2.0 August '99 Optimised ANSI C code taken from the 'aescrypt' project: www.sf.net/projects/aescrypt See LICENSE-EST for the license applicable to this file
C:/RakNet/Source/Router.hRouter plugin. Allows you to send to systems you are not directly connected to, and to route those messages
C:/RakNet/Source/RPCMap.cpp
C:/RakNet/Source/RPCMap.h[Internal] A container class for a list of RPCNodes
C:/RakNet/Source/RPCNode.h[Internal] Holds information related to a RPC
C:/RakNet/Source/SimpleMutex.cpp
C:/RakNet/Source/SimpleMutex.h[Internal] Encapsulates a mutex
C:/RakNet/Source/SingleProducerConsumer.h[Internal] Passes queued data between threads using a circular buffer with read and write pointers
C:/RakNet/Source/SocketLayer.cppSocketLayer class implementation
C:/RakNet/Source/SocketLayer.hSocketLayer class implementation
C:/RakNet/Source/StringCompressor.cpp
C:/RakNet/Source/StringCompressor.hCompresses/Decompresses ASCII strings and writes/reads them to BitStream class instances. You can use this to easily serialize and deserialize your own strings
C:/RakNet/Source/StringTable.hA simple class to encode and decode known strings based on a lookup table. Similar to the StringCompressor class
C:/RakNet/Source/SystemAddressList.hJust a class to hold a list of systems
C:/RakNet/Source/TCPInterface.cppA simple TCP based server allowing sends and receives. Can be connected to by a telnet client
C:/RakNet/Source/TCPInterface.hA simple TCP based server allowing sends and receives. Can be connected by any TCP client, including telnet
C:/RakNet/Source/TelnetTransport.hContains TelnetTransport , used to supports the telnet transport protocol. Insecure
C:/RakNet/Source/ThreadsafePacketLogger.hDerivation of the packet logger to defer the call to WriteLog until the user thread
C:/RakNet/Source/TransportInterface.hContains TransportInterface from which you can derive custom transport providers for ConsoleServer

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