CrystalSpace

Public API Reference

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

iGUIConnection Struct Reference

A class implementing this interface is used to connect a GUI server to one or more clients. More...

#include <gconnect.h>

Inheritance diagram for iGUIConnection:

iBase iBase List of all members.

Public Methods

virtual size_t GetDataFromClient (csGUIClientHandle, void *, size_t)=0
 The server calls this every frame for each client.

virtual bool SendDataToClient (csGUIClientHandle, void *buf, size_t len)=0
 The server calls this whenever it wants to send data to a client.

virtual size_t GetDataFromServer (void *data, size_t len)=0
 The client helper calls this when it wants to see if the server has sent any data.

virtual bool SendDataToServer (void *buf, size_t len)=0
 The client helper calls then when it wants to send data to the server.


Detailed Description

A class implementing this interface is used to connect a GUI server to one or more clients.

For a "loopback" style setup (where the client(s) and server are on the same computer), there can be one single instance of this class. If the client(s) and server are on different computers, there should be one instance of this class on each computer.

Definition at line 24 of file gconnect.h.


Member Function Documentation

virtual size_t iGUIConnection::GetDataFromClient csGUIClientHandle   ,
void *   ,
size_t   
[pure virtual]
 

The server calls this every frame for each client.

virtual size_t iGUIConnection::GetDataFromServer void *    data,
size_t    len
[pure virtual]
 

The client helper calls this when it wants to see if the server has sent any data.

It writes the data to the given buffer and returns the number of bytes actually written.

virtual bool iGUIConnection::SendDataToClient csGUIClientHandle   ,
void *    buf,
size_t    len
[pure virtual]
 

The server calls this whenever it wants to send data to a client.

virtual bool iGUIConnection::SendDataToServer void *    buf,
size_t    len
[pure virtual]
 

The client helper calls then when it wants to send data to the server.

It reads len bytes from the given buffer.


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