Mid-Level API

Collaboration diagram for Mid-Level API:

This is the original API, which is completed. More...

Namespaces
namespace	GNE::PacketParser
	A namespace containing functions handling the parsing of packets.
Classes
class	GNE::Address
	A wrapper class for the HawkNL NLaddress. More...
class	GNE::ClientConnection
	A class that can connect to a remote target. More...
class	GNE::Connection
	A class resembling any type of connection to a remote computer. More...
class	GNE::ConnectionListener
	This is an abstract base class representing an interface to the Connection, ClientConnection, and ServerConnection classes. More...
class	GNE::ConnectionParams
	A class to encapsulate parameters about a connection. More...
struct	GNE::ConnectionStats
	A struct holding values returned by getStats. More...
class	GNE::CustomPacket
	Many times, especially during connection, you want to send some more "free-form" data that may or may not all be related and will only be sent once. More...
class	GNE::Error
	This class resembles some sort of error in GNE, with the ability to obtain a textual description of the error. More...
class	GNE::UserError
	A simple error class with a default ErrorCode of User for quick error messages. More...
class	GNE::LowLevelError
	Adds low level HawkNL and possibly system error information to any other error. More...
class	GNE::WrongGame
	An error that represents a mismatch in the games during the connection process. More...
class	GNE::UnknownPacket
	An Error when a Packet is received from the network that has an ID that is not registered with the PacketParser. More...
class	GNE::PacketTypeMismatch
	An error thrown by SyncConnection when you get a packet other than the one you are trying to receive. More...
class	GNE::UserVersionMismatch
	An error that occurs during the connecting process if the user versions are different. More...
class	GNE::ProtocolViolation
	An error that occurs during the connection process if the remote machine sends incorrect or corrupted packets to us. More...
class	GNE::BufferError
	An error that occurs during an operation on Buffer. More...
class	GNE::ExitPacket
	The ExitPacket is sent automatically by GNE when you disconnect in a proper manner. More...
class	GNE::Packet
	The base packet class, used for dealing with all types of packets at a fundamental level. More...
class	GNE::PacketFeeder
	The PacketFeeder class is a callback for the PacketStream thread when it is running low on packets. More...
class	GNE::PacketStream
	This class resembles a packet stream through a connection. More...
struct	GNE::PingInformation
	Information returned by GNE::PingPacket::getPingInformation. More...
class	GNE::PingPacket
	Using the PingPacket is one way to measure ping and clock offsets from a remote machine. More...
class	GNE::ServerConnectionListener
	A connection that listens for other connections. More...
class	GNE::SmartPtr< T >
	The SmartPtr class is a reference-counted smart pointer implementation for general use. More...
class	GNE::SyncConnection
	A class for performing synchronous connections. More...
class	GNE::Time
	A class representing a time relative to a point in the past. More...
class	GNE::WeakPtr< T >
	The WeakPtr class is a weak pointer to an object managed by SmartPtr. More...
class	GNE::WrapperPacket
	WrapperPacket is a Packet that encapsulates another packet for the purposes of adding information to that packet. More...

---

Detailed Description

This is the original API, which is completed.

The mid-level API works with connections and packets. It provides the basics of communications between two computers. The high-level API expands from these classes to provide high-level functionality.

See also:

High-Level API

---