sp::network Namespace Reference

This namespace contains all network functions such as connecting, sending and receiving messages. More...

Classes
class	NetworkAddress
class	NetworkBase
	Pure base class for network systems. More...
class	NetworkBaseUDP
	Base class for all UDP network systems. More...
class	NetworkClient
class	NetworkMember
class	NetworkPacket
class	NetworkServer
class	NetworkSessionLogin
class	NetworkSessionReception
class	NetworkSocket
	This class is used internally for the network socket API but can also be accessed by the engine's user. More...
struct	SNetworkAdapter
	Network adapter information structure. More...
class	NetworkSystem
class	NetworkSystemTCP
	TCP/IP network system class. More...
class	NetworkSystemUDP
	UDP/IP network system class. More...
Typedefs
typedef boost::function< void(const NetworkAddress &ReceptionAddress, const io::stringc &SessionDescription)>	SessionAnswerCallback
Enumerations
enum	ENetworkMembers { NETWORK_CLIENT, NETWORK_SERVER }
	Network member types. More...
enum	EReservedDescriptors {   DESCRIPTOR_CLIENT_JOIN = 1000, DESCRIPTOR_CLIENT_LEFT, DESCRIPTOR_INTRODUCE_CLIENT, DESCRIPTOR_CONNECTION_ACCEPTED,   DESCRIPTOR_SERVER_DISCONNECTED, DESCRIPTOR_SESSION_REQUEST, DESCRIPTOR_SESSION_ANSWER }
	Reserved network packet descriptors for internal network communication. Don't use these values! More...
enum	ENetworkSystems { NETWORK_UDP, NETWORK_TCP }
	Supported network systems. More...
enum	ENetworkAddressClasses { NETADDRESS_CLASS_UNKNOWN, NETADDRESS_CLASS_A, NETADDRESS_CLASS_B, NETADDRESS_CLASS_C }
	Network address classes. More...
enum	ENetworkPorts { NETPORT_HTTP = 80, NETPORT_SMTP = 25, NETPORT_FTP = 20 }
	Enumeration of some predefined port numbers. More...
enum	ENetworkAdapterTypes {   NETADAPTER_OTHER, NETADAPTER_ETHERNET, NETADAPTER_TOKENRING, NETADAPTER_FDDI,   NETADAPTER_PPP, NETADAPTER_LOOPBACK, NETADAPTER_SLIP }
	Types of network adapters. More...
enum	ENetworkProtocols { PROTOCOL_TCP, PROTOCOL_UDP }
	Network transport protocols. More...

---

Detailed Description

This namespace contains all network functions such as connecting, sending and receiving messages.

---

Typedef Documentation

typedef boost::function<void (const NetworkAddress &ReceptionAddress, const io::stringc &SessionDescription)> sp::network::SessionAnswerCallback

Session answer callback.

Parameters:

	ReceptionAddress,:	Specifies the the address of the reception (normally the server):
	SessionDescription,:	Specifies the session description string. In this string the server can store information about the running game session.

---

Enumeration Type Documentation

enum sp::network::ENetworkAdapterTypes

Types of network adapters.

Enumerator:

NETADAPTER_OTHER
NETADAPTER_ETHERNET	Ethernet (e.g. for LAN connections).
NETADAPTER_TOKENRING	Token Ring (IEEE 802.5).
NETADAPTER_FDDI	Fiber Distributed Data Interface.
NETADAPTER_PPP	Point to Point Protocol.
NETADAPTER_LOOPBACK
NETADAPTER_SLIP

enum sp::network::ENetworkAddressClasses

Network address classes.

Enumerator:

NETADDRESS_CLASS_UNKNOWN	Unknown network address class.
NETADDRESS_CLASS_A	Network address class A has the net-mask 255.0.0.0.
NETADDRESS_CLASS_B	Network address class B has the net-mask 255.255.0.0.
NETADDRESS_CLASS_C	Network address class C has the net-mask 255.255.255.0.

enum sp::network::ENetworkMembers

Network member types.

Enumerator:

NETWORK_CLIENT	Network client.
NETWORK_SERVER	Network server. Only one instance can exist.

enum sp::network::ENetworkPorts

Enumeration of some predefined port numbers.

Enumerator:

NETPORT_HTTP	Port number for the "Hyper Text Transfer Protocol".
NETPORT_SMTP	Port number for the "Simple Mail Transer Protocol".
NETPORT_FTP	Port number for the "File Transer Protocol".

enum sp::network::ENetworkProtocols

Network transport protocols.

Enumerator:

PROTOCOL_TCP	Transmision Control Protocol (TCP). TCP guarantees safe transmisions but is slower than UDP.
PROTOCOL_UDP	User Datagram Protocol (UDP). UDP is unsafe and should only be used when performance is more important than safety (e.g. for video-transmision).

enum sp::network::ENetworkSystems

Supported network systems.

Enumerator:

NETWORK_UDP	Connection less UDP network. This is unsafe and should only be used if performance is more important than safety.
NETWORK_TCP	TCP client/server model. This is the most used network system for video games.

enum sp::network::EReservedDescriptors

Reserved network packet descriptors for internal network communication. Don't use these values!

Enumerator:

DESCRIPTOR_CLIENT_JOIN	A client has joined the server. This packet will only be sent to the server.
DESCRIPTOR_CLIENT_LEFT	A client has left the server. This packet will sent to each network member.
DESCRIPTOR_INTRODUCE_CLIENT	Server introduces a new client who has joined.
DESCRIPTOR_CONNECTION_ACCEPTED	Server accepted the connection of the new client who is about to join.
DESCRIPTOR_SERVER_DISCONNECTED	Server has been disconnected. This results in a disconnection for each client.
DESCRIPTOR_SESSION_REQUEST	Will be sent to 'scan' the network for open game sessions.
DESCRIPTOR_SESSION_ANSWER	Answer from a sessions request.