Introduction

Last Updated for RakNet 2.4 09/24/2005. See readme.txt for the current version number. Thank you for using RakNet, a game-oriented networking solution for Windows and Linux. This manual is intended to cover the main features of RakNet. You will find additional information within the header files RakPeer, RakServer.h, and RakClient.h, the samples, in the online forum or by emailing the author.

Quick Start

Introduction System Overview Detailed Implementation Tutorial Compiler Setup

Major systems

Distributed Objects
- How to automatically synchronize your game classes and member variables.
Bitstreams
- An overview of RakNet's bitstream class, used throughout the API.
Remote Procedure Calls
- How to call functions on remote computers, avoiding the necessity of manually creating packets.
Timestamping your packets
- Covers the purpose of timestamps.
Creating Packets
- How to create custom packets using structures and bitstreams, and how to encode timestamps.
Sending Packets
- How to send packets already prepared, and what parameters to use.
Receiving Packets
- How to converting raw data back to a packet you can read via a structure or bitstream.
Reliability types
- Covers parameters you can use to control how data gets sent.
The Network Object
- Used by DistributedNetworkObjects. Covers how to refer to objects in packets.
PlayerIDs
- Describes the purpose and use of the PlayerID structure used in packets and in some function parameters.
Network Messages
- Gives an overview of the messages the API will send to the user. This is also listed in Multiplayer.h.
Statistics
- The statistics that RakNet provides.
Secure connections
- How to activate and use secure connections.
Data compression
- Provides an overview of RakNet's ability to compress network data.
Enabling IO completion ports
- Covers the purpose of and how to enable IO completion ports.
Preprocessor Directives
- Enables you to rebuild the library with different code settings.
Peer Function List
- Lists the functions in RakPeer.h. See the actual file for documentation.
Server Function List
- Lists the functions in RakServer.h. See the actual file for documentation.
Client Function List
- Lists the functions in RakClient.h. See the actual file for documentation.
Autopatcher Implementation
- Overview of the autopatcher included with RakNet.
Master Server Implementation
- Overview of the master server included with RakNet.
NAT punch-through
- How to use the master server and master client for NAT Punch-through.
RakVoice
- Overview of RakVoice. Refer to RakVoice.h for full implementation and function details.
Samples
- An overview of the samples included with RakNet.

Support

FAQ Programming Tips Revision Log Forum Email Author