This abstract class defines the interface for establishing/requesting a SIMPLE socket connection, i.e. More...

Detailed Description

This abstract class defines the interface for establishing/requesting a SIMPLE socket connection, i.e.

make a "client connection". When the connection is accepted by the remote host, the connector notifies the client.

In keeping with the non-blocking semantics a poll() function has been defined that must be periodically called.

The Connector allows only one connection at a time. After a connection has been established, any calls to establish() will be ignore. Once the existing/ previous connection is closed, the application can establish() again.

The interface is NOT thread safe. This includes the client callback functions, i.e. no guarantees on what thread the callback functions executes in.

#include <AsyncConnector.h>

Inheritance diagram for Cpl::Io::Tcp::AsyncConnector:

[legend]

Classes
class	Client
	This class defines the callback mechanism used for accepting incoming TCP connections. More...

Public Member Functions
virtual bool	establish (Client &client, const char *remoteHostName, int portNumToConnectTo)=0
	Requests a client connection to the specified remote Host.

virtual void	poll () noexcept=0
	This method must be called periodically to service the connection status.

virtual void	terminate () noexcept=0
	Aborts any connection in progress and/or will CLOSE the active connection.

virtual	~AsyncConnector ()
	Virtual destructor.

Constructor & Destructor Documentation

◆ ~AsyncConnector()

virtual Cpl::Io::Tcp::AsyncConnector::~AsyncConnector ( )

inlinevirtual

Virtual destructor.

Reimplemented in Cpl::Io::Tcp::Win32::AsyncConnector.

Member Function Documentation

◆ establish()

virtual bool Cpl::Io::Tcp::AsyncConnector::establish	(	Client &	client,
		const char *	remoteHostName,
		int	portNumToConnectTo
	)

pure virtual

Requests a client connection to the specified remote Host.

The method returns true if the connection process is started. The method returns false if an error occurred or there is a connection request in progress or there is active connection.

Implemented in Cpl::Io::Tcp::Win32::AsyncConnector.