Tes::Server::IServer Interface Reference

Defines the interface for a 3rd Eye Scene server. More...

Inheritance diagram for Tes::Server::IServer:

List of all members.

Public Member Functions
int	Send (PacketBuffer packet)
	Send a pre-composed packet to all clients.
int	Create (Shape shape)
	Sends a create message for the given shape.
int	Destroy (Shape shape)
	Sends an update message for the given shape.
int	Update (Shape shape)
	Sends a destroy message for the given shape.
int	UpdateTransfers (int byteLimit)
	Update any pending amortised data transfers (e.g., mesh transfer).
int	UpdateFrame (float dt, bool flush=true)
	Sends a message marking the end of the current frame (and start of a new frame).
IConnection	Connection (int index)
	Requests the connection at the given index.
void	UpdateConnections (IList< IConnection > connections, NewConnectionCallback callback=null)
	Called from the IConnectionMonitor implementation to update the current server connections.
Properties
ServerSettings	Settings [get]
	Retrieve the settings with which the server was created.
IConnectionMonitor	ConnectionMonitor [get]
	Returns the connection monitor object for this Server.
int	ConnectionCount [get]
	Returns the number of current connections.
IEnumerable< IConnection >	Connections [get]
	Enumerates the current connections.

---

Detailed Description

Defines the interface for a 3rd Eye Scene server.

---

Member Function Documentation

IConnection Tes::Server::IServer::Connection

(

int

index

)

Requests the connection at the given index.

This data may be stale if the ConnectionMonitor has yet to update.

Parameters:

index

The index of the requested connection.

Returns:

The requested connection, or null if index is out of range.

Implemented in Tes::Server::TcpServer.

int Tes::Server::IServer::Create

(

Shape

shape

)

Sends a create message for the given shape.

Parameters:

shape

The shape to create.

Returns:

The number of bytes queued for transfer for this message, or negative on error. The negative value may be less than -1 and still indicate the successful transfer size.

Implemented in Tes::Server::TcpServer.

int Tes::Server::IServer::Destroy

(

Shape

shape

)

Sends an update message for the given shape.

Parameters:

shape

The shape to destroy.

Returns:

The number of bytes queued for transfer for this message, or negative on error. The negative value may be less than -1 and still indicate the successful transfer size.

Implemented in Tes::Server::TcpServer.

int Tes::Server::IServer::Send

(

PacketBuffer

packet

)

Send a pre-composed packet to all clients.

Parameters:

packet

Returns:

Implemented in Tes::Server::TcpServer.

int Tes::Server::IServer::Update

(

Shape

shape

)

Sends a destroy message for the given shape.

Parameters:

shape

The shape to update .

Returns:

The number of bytes queued for transfer for this message, or negative on error. The negative value may be less than -1 and still indicate the successful transfer size.

Implemented in Tes::Server::TcpServer.

void Tes::Server::IServer::UpdateConnections	(	IList< IConnection >	connections,
		NewConnectionCallback	callback = null
	)

Called from the IConnectionMonitor implementation to update the current server connections.

Parameters:

connections	The collection of active connections to server should handle.
callback	Optional callback to invoke for each new connection.

Implemented in Tes::Server::TcpServer.

int Tes::Server::IServer::UpdateFrame	(	float	dt,
		bool	flush = true
	)

Sends a message marking the end of the current frame (and start of a new frame).

Parameters:

dt	Indicates the time passed since over this frame (seconds).
flush	True to allow clients to flush transient options, false to clients preserver such objects.

Returns:

The number of bytes queued for transfer for this message, or negative on error. The negative value may be less than -1 and still indicate the successful transfer size.

Implemented in Tes::Server::TcpServer.

int Tes::Server::IServer::UpdateTransfers

(

int

byteLimit

)

Update any pending amortised data transfers (e.g., mesh transfer).

Parameters:

byteLimit

Limit the packet payload size to approximately this amount of data.

Returns:

The number of bytes queued for transfer for this message, or negative on error. The negative value may be less than -1 and still indicate the successful transfer size.

Implemented in Tes::Server::TcpServer.

---

Property Documentation

int Tes::Server::IServer::ConnectionCount [get]

Returns the number of current connections.

Returns:

The current number of connections.

Implemented in Tes::Server::TcpServer.

IConnectionMonitor Tes::Server::IServer::ConnectionMonitor [get]

Returns the connection monitor object for this Server.

Null if connections are not supported (internal only).

Implemented in Tes::Server::TcpServer.

---

The documentation for this interface was generated from the following file:

• IServer.cs