CrystalSpace

Public API Reference

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

iNetworkEndPoint Struct Reference

This is a network end-point interface. More...

#include <driver.h>

Inheritance diagram for iNetworkEndPoint:

iBase iNetworkConnection iNetworkListener List of all members.

Public Methods

virtual void Terminate ()=0
 Terminate the connection. Destroying the object also auto-terminates.

virtual bool SetOption (const char *name, int value)=0
 Set an driver-specific option for the end-point.

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


Detailed Description

This is a network end-point interface.

It represents one end of a network connection or potential connection (such as a listener). All network end-points must implement this interface.

Definition at line 74 of file driver.h.


Member Function Documentation

virtual csNetworkDriverError iNetworkEndPoint::GetLastError   [pure virtual]
 

Retrieve the code for the last error encountered.

virtual bool iNetworkEndPoint::SetOption const char *    name,
int    value
[pure virtual]
 

Set an driver-specific option for the end-point.

Each driver may support options beyond those provided by these abstract interfaces. For example, the cssocket driver supports 'ttl' and 'loop' options. Consult driver-specific documentation as necessary.

virtual void iNetworkEndPoint::Terminate   [pure virtual]
 

Terminate the connection. Destroying the object also auto-terminates.


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