GM6000 Digital Heater Controller Branch: main
SDX-1330
List of all members | Public Types | Public Member Functions
Cpl::Io::Socket::Connector Class Referenceabstract

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". A single instance can be used to create many connections.

#include <Connector.h>

Inheritance diagram for Cpl::Io::Socket::Connector:
[legend]

Public Types

enum  Result_T { eSUCCESS =0 , eERROR , eREFUSED }
 Possible return codes when attempting to establish a connection. More...
 

Public Member Functions

virtual Result_T establish (const char *remoteHostName, int portNumToConnectTo, Cpl::Io::Descriptor &fdOut)=0
 Requests a client connection to the specified remote Host.
 
virtual ~Connector ()
 Virtual destructor.
 

Member Enumeration Documentation

◆ Result_T

Possible return codes when attempting to establish a connection.

Enumerator
eERROR 

Connection was successful.

eREFUSED 

Error occurred.

Constructor & Destructor Documentation

◆ ~Connector()

virtual Cpl::Io::Socket::Connector::~Connector ( )
inlinevirtual

Virtual destructor.

Reimplemented in Cpl::Io::Socket::Posix::Connector, and Cpl::Io::Socket::Win32::Connector.

Member Function Documentation

◆ establish()

virtual Result_T Cpl::Io::Socket::Connector::establish ( const char *  remoteHostName,
int  portNumToConnectTo,
Cpl::Io::Descriptor fdOut 
)
pure virtual

Requests a client connection to the specified remote Host.

Upon success an opened Cpl::Io::Descriptor is returned (via 'fdOut') for the connection.

Implemented in Cpl::Io::Socket::Posix::Connector, and Cpl::Io::Socket::Win32::Connector.


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