class EppChannel

This EppChannel class is designed to handle a channel connected to the EPP server.

Inheritance:

Public Methods

EppChannel()

Creates an EppChannel object

virtual ~EppChannel()

Destructor

EppSession* getSession()

Gets the EppSession object associated with the EPP Channel

void setSession( EppSession* session )

Sets the EppSession object associated with the EPP Channel

const char* getMessage()

Gets the last message received for the EPP Channel

void setMessage( const char* message )

Sets the current message received for the EPP Channel

const char* getException()

Gets the last exception received for the EPP Channel

void setException( const char* e )

Sets the current exception received for the EPP Channel

virtual EppResponse* start( EppCommandLogin& login ) = 0

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

virtual EppGreeting* hello() = 0

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

virtual EppResponse* terminate() = 0

Terminates an EPP Channel

virtual EppResponse* send( EppCommand& command ) = 0

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

Protected Fields

static const int STATUS_INIT

The status value when the EppChannel object is created, but not started

static const int STATUS_START

The status value when the EppChannel object is started after sucessfully calling the start method

static const int STATUS_CLOSED

The status value when the EppChannel object is closed atfer successfully calling the close method

int status

The status of the EppChannel object.

Documentation

This EppChannel class is designed to handle a channel connected to the EPP server.

static const int STATUS_INIT

The status value when the EppChannel object is created, but not started

static const int STATUS_START

The status value when the EppChannel object is started after sucessfully calling the start method

static const int STATUS_CLOSED

The status value when the EppChannel object is closed atfer successfully calling the close method

int status

The status of the EppChannel object. It is used for recording the status transition from STATUS_INIT to STATUS_START, and finally to STATUS_CLOSED

EppChannel()

Creates an EppChannel object

virtual ~EppChannel()

Destructor

EppSession* getSession()

Gets the EppSession object associated with the EPP Channel

void setSession( EppSession* session )

Sets the EppSession object associated with the EPP Channel

Parameters:

session - the EppSession used for creating the channel

const char* getMessage()

Gets the last message received for the EPP Channel

void setMessage( const char* message )

Sets the current message received for the EPP Channel

const char* getException()

Gets the last exception received for the EPP Channel

void setException( const char* e )

Sets the current exception received for the EPP Channel

virtual EppResponse* start( EppCommandLogin& login ) = 0

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

virtual EppGreeting* hello() = 0

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

virtual EppResponse* terminate() = 0

Terminates an EPP Channel

Returns:

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

virtual EppResponse* send( EppCommand& command ) = 0

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 EPP Response would include an EppUnspec object with the XML data returned from the server as its value.
If there is any error with the connection to to server, the getException should be called for obtaining the details of the error.

Direct child classes:

EppChannelTcp

Author:

Ning Zhang ning.zhang@neustar.com

Version:

$Revision$ $Date$

Alphabetic index HTML hierarchy of classes or Java