The Nebula Device 3: Net::TcpClient Class Reference

The Nebula Device 3

Net::TcpClient Class Reference

#include <tcpclient.h>

Inheritance diagram for Net::TcpClient:

Core::RefCounted


Detailed Description

A TcpClient object is used to communicate with a TcpServer. Any number of clients can connect to a TcpServer, each connected client spawns a TcpClientConnection object on the server side which represents this client on the server. Sending and receiving data is handled through streams, streams offer the most flexible model to read and write data in different formats by connecting different stream readers and stream writers. The idea is to write data to the send stream, and to send of the accumulated data in the send stream once by calling the Send() method. To receive data from the server, call the Recv() method which will either block until, or return true in non-blocking mode as soon as data is available. The received data will be written into the receive stream, where the application can read it in any way it desires.

(C) 2006 Radon Labs GmbH

Public Member Functions

 TcpClient ()
 constructor
virtual ~TcpClient ()
 destructor
void SetBlocking (bool b)
 enable/disable blocking behaviour
bool IsBlocking () const
 get blocking behaviour
void SetServerAddress (const IpAddress &addr)
 set the server address to connect to
const IpAddressGetServerAddress () const
 get the server address
Result Connect ()
 establish a connection with the server
void Disconnect ()
 disconnect from the server
bool IsConnected () const
 return true if currently connected
bool Send ()
 send accumulated content of send stream to server
const Ptr< IO::Stream > & GetSendStream ()
 access to send stream
bool Recv ()
 receive data from server into recv stream
const Ptr< IO::Stream > & GetRecvStream ()
 access to recv stream
int GetRefCount () const
 get the current refcount
void AddRef ()
 increment refcount by one
void Release ()
 decrement refcount and destroy object if refcount is zero
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
const Util::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Static Public Member Functions

static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

Member Function Documentation

TcpClient::Result Net::TcpClient::Connect (  ) 

establish a connection with the server

Establish a connection with the server. If the client is set to non-blocking at the time this method is called, it will return immediately with the result Connecting. To check if the connection is standing, just call Connect() again in intervals which will eventually return Success. On a blocking client, connect returns after a connection has been established, or with a time out when no connection could be established.

void Net::TcpClient::Disconnect (  ) 

disconnect from the server

This disconnects the current connection.

bool Net::TcpClient::IsConnected (  )  const

return true if currently connected

Return true if the socket is currently connected. This will actually probe the connection using a select().

int Core::RefCounted::GetRefCount (  )  const [inline, inherited]

get the current refcount

Return the current refcount of the object.

void Core::RefCounted::AddRef (  )  [inline, inherited]

increment refcount by one

Increment the refcount of the object.

void Core::RefCounted::Release (  )  [inline, inherited]

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

const Util::String & Core::RefCounted::GetClassName (  )  const [inline, inherited]

get the class name

Get the class name of the object.

Util::FourCC Core::RefCounted::GetClassFourCC (  )  const [inline, inherited]

get the class FourCC code

Get the class FourCC of the object.

void Core::RefCounted::DumpRefCountingLeaks (  )  [static, inherited]

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.