CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iNetworkManager Struct Reference

The network manager polls for incoming data on connections registered with it and new connections on listeners registered with it. More...

#include <netman.h>

Inheritance diagram for iNetworkManager:

iBase List of all members.

Public Methods

virtual void RegisterConnection (iNetworkConnection *, iNetworkPacket *)=0
 Register a connection for polling with its associated packet.

virtual void RegisterListener (iNetworkListener *, iNetworkPacket *)=0
 Register a listener for polling with its associated packet.

virtual bool UnregisterEndPoint (iNetworkEndPoint *)=0
 Unregister a connection or listener.

virtual bool Send (iNetworkConnection *, iNetworkPacket *)=0
 Send a packet on a connection.

virtual bool SendToAll (iNetworkPacket *)=0
 Send a packet to all registered connections that iNetworkPacket::FilterSocket() returns true for.

virtual void RegisterConnectedSocket (iNetworkSocket2 *, iNetworkPacket2 *)=0
 Register an ENSocket connection for polling with its associated packet.

virtual bool UnregisterConnectedSocket (iNetworkSocket2 *)=0
 Unregister an ENSocket connection.

virtual void RegisterListeningSocket (iNetworkSocket2 *, iNetworkPacket2 *)=0
 Register an ENSocket listener for polling with its associated packet.

virtual bool UnregisterListeningSocket (iNetworkSocket2 *)=0
 Unregister an ENSocket listener.

virtual bool Send (iNetworkSocket2 *, iNetworkPacket2 *)=0
 Send a packet on a connected ENSocket socket.

virtual bool SendToAll (iNetworkPacket2 *)=0
 Send a packet to all registered, connected ENSocket sockets that iNetworkPacket2::FilterSocket() returns true for.


Detailed Description

The network manager polls for incoming data on connections registered with it and new connections on listeners registered with it.

If data is waiting, it is added to the buffer of the packet associated with the connection. Once a packet is full, a network event is posted on the queue for the appliction to pick up. The event type is csevNetwork and event.Command.Info is a pointer to the packet where the data was stored.

Definition at line 125 of file netman.h.


Member Function Documentation

virtual void iNetworkManager::RegisterConnectedSocket iNetworkSocket2  ,
iNetworkPacket2  
[pure virtual]
 

Register an ENSocket connection for polling with its associated packet.

virtual void iNetworkManager::RegisterConnection iNetworkConnection  ,
iNetworkPacket  
[pure virtual]
 

Register a connection for polling with its associated packet.

virtual void iNetworkManager::RegisterListener iNetworkListener  ,
iNetworkPacket  
[pure virtual]
 

Register a listener for polling with its associated packet.

virtual void iNetworkManager::RegisterListeningSocket iNetworkSocket2  ,
iNetworkPacket2  
[pure virtual]
 

Register an ENSocket listener for polling with its associated packet.

virtual bool iNetworkManager::Send iNetworkSocket2  ,
iNetworkPacket2  
[pure virtual]
 

Send a packet on a connected ENSocket socket.

virtual bool iNetworkManager::Send iNetworkConnection  ,
iNetworkPacket  
[pure virtual]
 

Send a packet on a connection.

virtual bool iNetworkManager::SendToAll iNetworkPacket2   [pure virtual]
 

Send a packet to all registered, connected ENSocket sockets that iNetworkPacket2::FilterSocket() returns true for.

virtual bool iNetworkManager::SendToAll iNetworkPacket   [pure virtual]
 

Send a packet to all registered connections that iNetworkPacket::FilterSocket() returns true for.

virtual bool iNetworkManager::UnregisterConnectedSocket iNetworkSocket2   [pure virtual]
 

Unregister an ENSocket connection.

virtual bool iNetworkManager::UnregisterEndPoint iNetworkEndPoint   [pure virtual]
 

Unregister a connection or listener.

virtual bool iNetworkManager::UnregisterListeningSocket iNetworkSocket2   [pure virtual]
 

Unregister an ENSocket listener.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18