elm::net::ClientSocket Class Reference

#include <elm/net/ClientSocket.h>

Public Member Functions
virtual	~ClientSocket (void)
virtual int	port (void) const =0
virtual const string &	host (void) const =0
virtual const string &	service (void) const =0
virtual void	connect (void)=0 throw (Exception)
virtual void	disconnect (void)=0 throw (Exception)
virtual io::InStream &	in (void)=0 throw (Exception)
virtual io::OutStream &	out (void)=0 throw (Exception)

Static Public Member Functions
static ClientSocket *	make (const string &host, int port)
static ClientSocket *	make (const string &host, const string &service)
static ClientSocket *	make (int port)

Detailed Description

Class implementing a client through a socket connection.

Constructor & Destructor Documentation

virtual elm::net::ClientSocket::~ClientSocket ( void  )

virtual

Member Function Documentation

void elm::net::ClientSocket::connect ( void  ) throw ( Exception )

pure virtual

Connect the client to the server.

Exceptions

Exception

If there is an error.

void elm::net::ClientSocket::disconnect ( void  ) throw ( Exception )

pure virtual

Disconnect from the server.

Exceptions

Exception

If there is an error.

const string & elm::net::ClientSocket::host ( void  ) const

pure virtual

Get the host name of the server the client has to connect to.

Returns

Server host name.

io::InStream & elm::net::ClientSocket::in ( void  ) throw ( Exception )

pure virtual

Obtain the input channel for the connection.

Returns

Input channel.

Exceptions

Exception

If there is an error.

ClientSocket * elm::net::ClientSocket::make ( const string &  host, int  port  )

static

Build a client socket connecting to the given host on the given port.

Parameters

host	Host to connect to (numeric or symbolic form).
port	Port to connect to.

ClientSocket * elm::net::ClientSocket::make ( const string &  host, const string &  service  )

static

Build a client socket connecting to the given host with the given service.

Parameters

host	Host to connect to (numeric or symbolic form).
service	Service to connect to.

ClientSocket * elm::net::ClientSocket::make ( int  port )

static

Build a client socket connecting to the local host on the given port.

Parameters

port	Port to connect to.

io::OutStream & elm::net::ClientSocket::out ( void  ) throw ( Exception )

pure virtual

Obtain the output channel for the connection.

Returns

Output channel.

Exceptions

Exception

If there is an error.

int elm::net::ClientSocket::port ( void  ) const

pure virtual

Get the port of the client.

Returns

Connection port.

const string & elm::net::ClientSocket::service ( void  ) const

pure virtual

If any, get the name of the service of connection.

Returns

Connected service name.

---

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

• include/elm/net/ClientSocket.h
• src/net_ClientSocket.cpp