class EppChannelTcp

This EppChannelTcp is designed to handle a session connection to the EPP server via TCP/TLS.

Inheritance:

Public Methods

EppChannelTcp()

Creates an EppChannelTcp object

EppChannelTcp( EppSessionTcp* session )

Creates an EppChannelTcp object

~EppChannelTcp()

Destructor

int getSocket()

Gets the socket associated with the EPP Channel

SSL* getSSL()

Gets the SSL object of OpenSSL associated with the EPP Channel

bool useTLS()

Check if OpenSSL is used for establishing the EPP session

EppResponse* send( EppCommand& command )

Sends an EppCommand object to the EPP Server and gets an EppResponse object back from the EPP Server

EppResponse* start( EppCommandLogin& login )

Starts up the EppChannel by sending an EppCommandLogin object to the EPP Server

EppGreeting* hello()

Sends an EPP Hello message to the EPP Server and returns back with an EppGreeting object

EppResponse* terminate()

Terminates an EPP Channel

Inherited from EppChannel:

Public Methods

EppSession* getSession()

void setSession( EppSession* session )

const char* getMessage()

void setMessage( const char* message )

const char* getException()

void setException( const char* e )

Protected Fields

static const int STATUS_INIT

static const int STATUS_START

static const int STATUS_CLOSED

int status

Documentation

This EppChannelTcp is designed to handle a session connection to the EPP server via TCP/TLS.

EppChannelTcp()

Creates an EppChannelTcp object

EppChannelTcp( EppSessionTcp* session )

Creates an EppChannelTcp object

Parameters:

session - the EppSessionTcp object in which an EPP Channel is created

~EppChannelTcp()

Destructor

int getSocket()

Gets the socket associated with the EPP Channel

SSL* getSSL()

Gets the SSL object of OpenSSL associated with the EPP Channel

bool useTLS()

Check if OpenSSL is used for establishing the EPP session

EppResponse* send( EppCommand& command )

Sends an EppCommand object to the EPP Server and gets an EppResponse object back from the EPP Server

Parameters:

command - the command to be send to the EPP server

Returns:

an EppResponse object, or null if there is error with the connection to the server
Note: If there is any syntax error or missing required parameters in the command, the command will not be sent out, and a EPP Response object will be returned indicating the errors. As there is no EPP server action involved, the transaction id for both the client and the server are the same value copied from the command itself.
If there is any syntax error or missing required parameters from the response data from the EPP Server, the message can be retrieved by calling the getMessage method.
If there is any error with the connection to to server, the getException should be called for obtaining the details of the error.

EppResponse* start( EppCommandLogin& login )

Starts up the EppChannel by sending an EppCommandLogin object to the EPP Server

Parameters:

login - the EppCommandLogin object for establisging the EPP Channel

Returns:

an EppResponse object indicating if the channel is started successfully or not

EppGreeting* hello()

Sends an EPP Hello message to the EPP Server and returns back with an EppGreeting object

Returns:

an EppGreeting returned by the EPP Server, or null if there is any error

EppResponse* terminate()

Terminates an EPP Channel

Returns:

an EppResponse object indicating if the channel is terminated successfully or not

This class has no child classes.

Author:

Ning Zhang ning.zhang@neustar.com

Version:

$Revision: 1.1.1.1 $ $Date: 2005/12/06 20:11:35 $

Alphabetic index HTML hierarchy of classes or Java