CrystalSpace

Public API Reference

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

iNetworkDriver Struct Reference

This is the network driver interface for CS. More...

#include <driver.h>

Inheritance diagram for iNetworkDriver:

iBase List of all members.

Public Methods

virtual csPtr< iNetworkConnectionNewConnection (const char *target, bool reliable=true, bool blocking=false)=0
 Create a new network connection. More...

virtual csPtr< iNetworkListenerNewListener (const char *source, bool reliable=true, bool blockingListener=false, bool blockingConnection=false)=0
 Create a new network listener. More...

virtual csNetworkDriverCapabilities GetCapabilities () const=0
 Get network driver capabilities. More...

virtual csNetworkDriverError GetLastError () const=0
 Retrieve the code for the last error encountered. More...


Detailed Description

This is the network driver interface for CS.

It represents a plug-in network driver module. All network drivers must implement this interface.

Definition at line 155 of file inetwork/driver.h.


Member Function Documentation

virtual csNetworkDriverCapabilities iNetworkDriver::GetCapabilities   const [pure virtual]
 

Get network driver capabilities.

This function returns information describing the capabilities of the driver. This function is deprecated since the reliable flag is deprecated, and all drivers should support blocking and non-blocking.

virtual csNetworkDriverError iNetworkDriver::GetLastError   const [pure virtual]
 

Retrieve the code for the last error encountered.

virtual csPtr<iNetworkConnection> iNetworkDriver::NewConnection const char *    target,
bool    reliable = true,
bool    blocking = false
[pure virtual]
 

Create a new network connection.

The 'target' parameter is driver dependent.

For example, with a socket driver, the target might be "host:port/protocol"; with a modem driver it might be "Device:PhoneNumber"; etc. The current main socket driver supports the TCP, UDP and Multicast protocols.

The 'reliable' flag is deprecated. The 'blocking' flag determines whether operations on the connection return immediately in all cases or wait until the operation can be completed successfully. Returns the new connection object or 0 if the connection failed.

virtual csPtr<iNetworkListener> iNetworkDriver::NewListener const char *    source,
bool    reliable = true,
bool    blockingListener = false,
bool    blockingConnection = false
[pure virtual]
 

Create a new network listener.

The 'source' parameter is driver dependent.

For example, with a socket driver, the source might be "port/protocol"; with a modem driver it might be "comport"; etc. The current main socket driver supports the TCP, UDP and Multicast protocols.

The 'reliable' flag is deprecated. The 'blockingListener' flag determines whether or not the Accept() method blocks while being called. The 'blockingConnection' flag determines whether or not methods in the resulting connection object block.


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