A class for creating a TCP client connection. More...

#include <AsyncTcpClient.h>

Inheritance diagram for Async::TcpClient:

Public Member Functions
	TcpClient (const std::string &remote_host, uint16_t remote_port, size_t recv_buf_len=DEFAULT_RECV_BUF_LEN)
	Constructor. More...

	~TcpClient (void)
	Destructor. More...

void	connect (void)
	Connect to the remote host. More...

void	disconnect (void)
	Disconnect from the remote host. More...

Public Member Functions inherited from Async::TcpConnection
	TcpConnection (size_t recv_buf_len=DEFAULT_RECV_BUF_LEN)
	Constructor. More...

	TcpConnection (int sock, const IpAddress &remote_addr, uint16_t remote_port, size_t recv_buf_len=DEFAULT_RECV_BUF_LEN)
	Constructor. More...

	~TcpConnection (void)
	Destructor. More...

void	disconnect (void)
	Disconnect from the remote host. More...

int	write (const void *buf, int count)
	Write data to the TCP connection. More...

const IpAddress &	remoteHost (void) const
	Return the IP-address of the remote host. More...

uint16_t	remotePort (void) const
	Return the remote port used. More...

bool	isConnected (void) const
	Check if the connection is established or not. More...

Public Attributes
SigC::Signal0< void >	connected
	A signal that is emitted when a connection has been established. More...

Public Attributes inherited from Async::TcpConnection
SigC::Signal2< void, TcpConnection *, DisconnectReason >	disconnected
	A signal that is emitted when a connection has been terminated. More...

SigC::Signal3< int, TcpConnection , void , int >	dataReceived
	A signal that is emitted when data has been received on the connection. More...

SigC::Signal1< void, bool >	sendBufferFull
	A signal that is emitted when the send buffer status changes. More...

Additional Inherited Members
Public Types inherited from Async::TcpConnection
enum	DisconnectReason { DR_HOST_NOT_FOUND, DR_REMOTE_DISCONNECTED, DR_SYSTEM_ERROR, DR_RECV_BUFFER_OVERFLOW, DR_ORDERED_DISCONNECT }
	Reason code for disconnects. More...

Static Public Member Functions inherited from Async::TcpConnection
static const char *	disconnectReasonStr (DisconnectReason reason)
	Translate disconnect reason to a string. More...

Static Public Attributes inherited from Async::TcpConnection
static const int	DEFAULT_RECV_BUF_LEN = 1024
	The default length of the reception buffer. More...

Protected Member Functions inherited from Async::TcpConnection
void	setSocket (int sock)
	Setup information about the connection. More...

void	setRemoteAddr (const IpAddress &remote_addr)
	Setup information about the connection. More...

void	setRemotePort (uint16_t remote_port)
	Setup information about the connection. More...

int	socket (void) const
	Return the socket file descriptor. More...

Detailed Description

A class for creating a TCP client connection.

Author: Tobias Blomberg

Date: 2003-04-12

This class is used to create a TCP client connection. All details of how to create the connection is hidden inside the class. This make it very easy to create and use the connections. An example usage is shown below.

#include <iostream>
#include <AsyncCppApplication.h>
#include <AsyncTcpClient.h>
using namespace std;
using namespace Async;
class MyClass : public SigC::Object
{
  public:
    MyClass(void)
    {
      con = new TcpClient("www.linux.org", 80);
      con->connected.connect(slot(*this, &MyClass::onConnected));
      con->disconnected.connect(slot(*this, &MyClass::onDisconnected));
      con->dataReceived.connect(slot(*this, &MyClass::onDataReceived));
      con->connect();
    }
    
    ~MyClass(void)
    {
      delete con;
    }
  private:
    TcpClient *con;
    
    void onConnected(void)
    {
      cout << "Connection established to " << con->remoteHost() << "...\n";
      con->write("GET /\n", 6);
    }
    
    void onDisconnected(TcpConnection *con, TcpClient::DisconnectReason reason)
    {
      cout << "Disconnected from " << con->remoteHost() << "...\n";
      Application::app().quit();
    }
    
    int onDataReceived(TcpConnection *con, void *buf, int count)
    {
      char *str = static_cast<char *>(buf);
      string html(str, str+count);
      cout << html;
      return count;
    }
};
int main(int argc, char **argv)
{
  CppApplication app;
  MyClass my_class;
  app.exec();
}

Examples:: AsyncTcpClient_demo.cpp.

Definition at line 130 of file AsyncTcpClient.h.

Constructor & Destructor Documentation

Async::TcpClient::TcpClient	(	const std::string &	remote_host,
		uint16_t	remote_port,
		size_t	recv_buf_len = `DEFAULT_RECV_BUF_LEN`
	)

Constructor.

Parameters

remote_host	The hostname of the remote host
remote_port	The port on the remote host to connect to
recv_buf_len	The length of the receiver buffer to use

The object will be constructed and variables will be initialized but no connection will be created until the connect function (see TcpClient::connect) is called.

Async::TcpClient::~TcpClient ( void )

Destructor.

Member Function Documentation

void Async::TcpClient::connect ( void )

Connect to the remote host.

This function will initiate a connection to the remote host. The connection must not be written to before the connected signal (see TcpClient::connected) has been emitted. If the connection is already established or pending, nothing will be done.

void Async::TcpClient::disconnect ( void )

Disconnect from the remote host.

Call this function to disconnect from the remote host. If already disconnected, nothing will be done. The disconnected signal is not emitted when this function is called

Member Data Documentation

SigC::Signal0<void> Async::TcpClient::connected

A signal that is emitted when a connection has been established.

Definition at line 173 of file AsyncTcpClient.h.

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

AsyncTcpClient.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation