RakNet File List

Here is a list of all documented files with brief descriptions:
C:/RakNet 2.518/Include/AsynchronousFileIO.h[Internal] Depreciated, used for windows back when I supported IO completion ports
C:/RakNet 2.518/Include/AutopatcherRepositoryInterface.hAn interface used by AutopatcherServer to get the data necessary to run an autopatcher
C:/RakNet 2.518/Include/BigTypes.h[Internal] Used for RSA generation
C:/RakNet 2.518/Include/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 2.518/Include/CheckSum.h[Internal] Generates and validates checksums
C:/RakNet 2.518/Include/ClientContextStruct.h[Internal] Depreciated, back from when I supported IO Completion ports
C:/RakNet 2.518/Include/CommandParserInterface.hContains CommandParserInterface , from which you derive custom command parsers
C:/RakNet 2.518/Include/ConnectionGraph.hConnection graph plugin. This maintains a graph of connections for the entire network, so every peer knows about every other peer
C:/RakNet 2.518/Include/ConsoleServer.hContains ConsoleServer , used to plugin to your game to accept remote console-based connections
C:/RakNet 2.518/Include/DataBlockEncryptor.h[Internal] Encrypts and decrypts data blocks. Used as part of secure connections
C:/RakNet 2.518/Include/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 2.518/Include/DirectoryDeltaTransfer.hSimple class to send changes between directories. In essense, a simple autopatcher that can be used for transmitting levels, skins, etc
C:/RakNet 2.518/Include/DS_BinarySearchTree.h[Internal] A binary search tree, and an AVL balanced BST derivation
C:/RakNet 2.518/Include/DS_ByteQueue.h[Internal] Byte queue
C:/RakNet 2.518/Include/DS_Heap.h[Internal] Heap (Also serves as a priority queue)
C:/RakNet 2.518/Include/DS_HuffmanEncodingTree.h[Internal] Generates a huffman encoding tree, used for string and global compression
C:/RakNet 2.518/Include/DS_HuffmanEncodingTreeFactory.h[Internal] Creates instances of the class HuffmanEncodingTree
C:/RakNet 2.518/Include/DS_HuffmanEncodingTreeNode.h[Internal] A single node in the Huffman Encoding Tree
C:/RakNet 2.518/Include/DS_LinkedList.h[Internal] Straightforward linked list data structure
C:/RakNet 2.518/Include/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 2.518/Include/DS_Map.h[Internal] Map
C:/RakNet 2.518/Include/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 2.518/Include/DS_OrderedList.h[Internal] Quicksort ordered list
C:/RakNet 2.518/Include/DS_Queue.h[Internal] A queue used by RakNet
C:/RakNet 2.518/Include/DS_QueueLinkedList.h[Internal] A queue implemented as a linked list
C:/RakNet 2.518/Include/DS_Tree.h[Internal] Just a regular tree
C:/RakNet 2.518/Include/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 2.518/Include/EmailSender.hRudimentary class to send email from code. Don't expect anything fancy
C:/RakNet 2.518/Include/ExtendedOverlappedPool.h[Depreciated] This was used for IO completion ports
C:/RakNet 2.518/Include/FileListTransfer.hA plugin to provide a simple way to compress and incrementally send the files in the FileList structure
C:/RakNet 2.518/Include/FullyConnectedMesh.hFully connected mesh plugin. This will connect RakPeer to all connecting peers, and all peers the connecting peer knows about
C:/RakNet 2.518/Include/GetTime.hReturns the value from QueryPerformanceCounter. This is the function RakNet uses to represent time
C:/RakNet 2.518/Include/InternalPacket.h[Internal] A class which stores a user message, and all information associated with sending and receiving that message
C:/RakNet 2.518/Include/InternalPacketPool.h[Internal] Memory pool for InternalPacket*
C:/RakNet 2.518/Include/LightweightDatabaseClient.hContains the client interface to the simple database included with RakNet, useful for a server browser or a lobby server
C:/RakNet 2.518/Include/LightweightDatabaseServer.hA simple flat database included with RakNet, useful for a server browser or a lobby server
C:/RakNet 2.518/Include/LogCommandParser.hContains LogCommandParser , Used to send logs to connected consoles
C:/RakNet 2.518/Include/MTUSize.h[Internal] Defines the default maximum transfer unit
C:/RakNet 2.518/Include/Multiplayer.h[Depreciated] Maps packet IDs to functions. I use this in the samples, but you shouldn't use it yourself
C:/RakNet 2.518/Include/NatPunchthrough.hContains the NAT-punchthrough plugin
C:/RakNet 2.518/Include/NetworkIDGenerator.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 2.518/Include/NetworkTypes.hTypes used by RakNet, most of which involve user code
C:/RakNet 2.518/Include/PacketConsoleLogger.hThis will write all incoming and outgoing network messages to the log command parser, which can be accessed through Telnet
C:/RakNet 2.518/Include/PacketEnumerations.hAll the packet identifiers used by RakNet. Packet identifiers comprise the first byte of any message
C:/RakNet 2.518/Include/PacketFileLogger.hThis will write all incoming and outgoing network messages to a file
C:/RakNet 2.518/Include/PacketLogger.hThis will write all incoming and outgoing network messages to the local console screen. See derived functions for other outputs
C:/RakNet 2.518/Include/PacketPool.h[Internal] A pool for the Packet class. I don't believe this is used any longer
C:/RakNet 2.518/Include/PacketPriority.hThis file contains enumerations for packet priority and reliability enumerations
C:/RakNet 2.518/Include/PluginInterface.hRakNet's plugin functionality system. You can derive from this to create your own plugins
C:/RakNet 2.518/Include/RakClient.hSpecializes RakPeer to act as a client
C:/RakNet 2.518/Include/RakClientInterface.hAn interface for RakClient. Simply contains all user functions as pure virtuals
C:/RakNet 2.518/Include/RakNetCommandParser.hContains RakNetCommandParser , used to send commands to an instance of RakPeer
C:/RakNet 2.518/Include/RakNetStatistics.hA structure that holds all statistical data returned by RakNet
C:/RakNet 2.518/Include/RakNetTransport.hContains RakNetTransportCommandParser and RakNetTransport used to provide a secure console connection
C:/RakNet 2.518/Include/RakNetworkFactory.hFactory class for RakServerInterface, RakClientInterface, and RakPeerInterface
C:/RakNet 2.518/Include/RakPeer.hThe main class used for data transmission and most of RakNet's functionality
C:/RakNet 2.518/Include/RakPeerInterface.hAn interface for RakPeer. Simply contains all user functions as pure virtuals
C:/RakNet 2.518/Include/RakServer.hSpecializes RakPeer to act as a server
C:/RakNet 2.518/Include/RakServerInterface.hAn interface for RakServer. Simply contains all user functions as pure virtuals
C:/RakNet 2.518/Include/Rand.h[Internal] Random number generator
C:/RakNet 2.518/Include/ReliabilityLayer.h[Internal] Datagram reliable, ordered, unordered and sequenced sends. Flow control. Message splitting, reassembly, and coalescence
C:/RakNet 2.518/Include/Replica.hContains interface Replica used by the ReplicaManager
C:/RakNet 2.518/Include/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 2.518/Include/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 2.518/Include/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 2.518/Include/Router.hRouter plugin. Allows you to send to systems you are not directly connected to, and to route those messages
C:/RakNet 2.518/Include/RPCMap.h[Internal] A container class for a list of RPCNodes
C:/RakNet 2.518/Include/RPCNode.h[Internal] Holds information related to a RPC
C:/RakNet 2.518/Include/SimpleMutex.h[Internal] Encapsulates a mutex
C:/RakNet 2.518/Include/SimpleTCPServer.hA simple TCP based server allowing sends and receives. Can be connected by any TCP client, including telnet
C:/RakNet 2.518/Include/SingleProducerConsumer.h[Internal] Passes queued data between threads using a circular buffer with read and write pointers
C:/RakNet 2.518/Include/SocketLayer.h[Internal] Encapsulates Berkely sockets
C:/RakNet 2.518/Include/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 2.518/Include/StringTable.hA simple class to encode and decode known strings based on a lookup table. Similar to the StringCompressor class
C:/RakNet 2.518/Include/SystemAddressList.hJust a class to hold a list of systems
C:/RakNet 2.518/Include/TCPInterface.hA simple TCP based server allowing sends and receives. Can be connected by any TCP client, including telnet
C:/RakNet 2.518/Include/TelnetTransport.hContains TelnetTransport , used to supports the telnet transport protocol. Insecure
C:/RakNet 2.518/Include/TransportInterface.hContains TransportInterface from which you can derive custom transport providers for ConsoleServer
C:/RakNet 2.518/Include/Types.hUsed for types used by RSA
C:/RakNet 2.518/Samples/AutopatcherClient/AutopatcherClient.hClient plugin for the autopatcher
C:/RakNet 2.518/Samples/AutopatcherServer/AutopatcherServer.cppThe server plugin for the autopatcher. Must be running for the client to get patches
C:/RakNet 2.518/Samples/AutopatcherServer/AutopatcherServer.hThe server plugin for the autopatcher. Must be running for the client to get patches
C:/RakNet 2.518/Samples/CommandConsoleServer/main.cppTest the command console implementations
C:/RakNet 2.518/Samples/ConnectionGraph/ConnectionGraphSample.cppTests the connection graph
C:/RakNet 2.518/Samples/CrossConnectionTest/CrossConnectionTest.cppTests connecting two peers at the same time with the internet simulator running
C:/RakNet 2.518/Samples/NATPunchthrough/main.cppTests the NAT-punchthrough plugin
C:/RakNet 2.518/Samples/PerformanceAnalysis/PerformanceAnalysis.cppTests connecting two peers at the same time with the internet simulator running
C:/RakNet 2.518/Samples/ThreadTest/ThreadTest.cppTests multiple readers and writers on the same instance of RakPeer. Define _RAKNET_THREADSAFE in RakNetDefines.h before running this
C:/RakNet 2.518/Source/AsynchronousFileIO.cpp
C:/RakNet 2.518/Source/BitStream.cpp
C:/RakNet 2.518/Source/CheckSum.cppCheckSum implementation from http://www.flounder.com/checksum.htm
C:/RakNet 2.518/Source/ConnectionGraph.cpp
C:/RakNet 2.518/Source/DataBlockEncryptor.cpp
C:/RakNet 2.518/Source/DS_HuffmanEncodingTree.cpp
C:/RakNet 2.518/Source/ExtendedOverlappedPool.cpp
C:/RakNet 2.518/Source/FullyConnectedMesh.cpp
C:/RakNet 2.518/Source/GetTime.cpp
C:/RakNet 2.518/Source/InternalPacketPool.cpp
C:/RakNet 2.518/Source/NetworkIDGenerator.cpp
C:/RakNet 2.518/Source/NetworkTypes.cpp
C:/RakNet 2.518/Source/PacketLogger.cpp
C:/RakNet 2.518/Source/PluginInterface.cpp
C:/RakNet 2.518/Source/RakClient.cpp
C:/RakNet 2.518/Source/RakNetStatistics.cpp
C:/RakNet 2.518/Source/RakNetworkFactory.cpp
C:/RakNet 2.518/Source/RakPeer.cpp
C:/RakNet 2.518/Source/RakServer.cpp
C:/RakNet 2.518/Source/ReliabilityLayer.cpp
C:/RakNet 2.518/Source/RPCMap.cpp
C:/RakNet 2.518/Source/SimpleMutex.cpp
C:/RakNet 2.518/Source/SocketLayer.cppSocketLayer class implementation
C:/RakNet 2.518/Source/StringCompressor.cpp
C:/RakNet 2.518/Source/TCPInterface.cppA simple TCP based server allowing sends and receives. Can be connected to by a telnet client

Generated on Sat Oct 14 08:37:37 2006 for RakNet by  doxygen 1.4.6-NO