Menu
▾
▴
[Epp-rtk-cpp-commits] CVS: epp-rtk/c++/src/data epp_Command.h,1.5,1.6 epp_ContactPhone.h,1.2,1.3 epp_ContactVoice.h,1.7,1.8 epp_Exception.h,1.4,1.5 epp_Options.h,1.5,1.6 epp_Response.h,1.6,1.7 epp_Result.h,1.5,1.6 epp_Service.h,1.6,1.7 epp_TransID.h,1.5,1.6 epp_XMLException.h,1.6,1.7
|
From: Asbjorn M. <ste...@us...> - 2002-02-22 09:35:46
|
Update of /cvsroot/epp-rtk/epp-rtk/c++/src/data
In directory usw-pr-cvs1:/tmp/cvs-serv4756
Modified Files:
epp_Command.h epp_ContactPhone.h epp_ContactVoice.h
epp_Exception.h epp_Options.h epp_Response.h epp_Result.h
epp_Service.h epp_TransID.h epp_XMLException.h
Log Message:
Documented classes using Javadocs comments...
Index: epp_Command.h
===================================================================
RCS file: /cvsroot/epp-rtk/epp-rtk/c++/src/data/epp_Command.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** epp_Command.h 20 Feb 2002 17:26:02 -0000 1.5
--- epp_Command.h 22 Feb 2002 09:35:42 -0000 1.6
***************
*** 29,32 ****
--- 29,38 ----
#define __EPP_COMMAND_H
+ /** @file epp_Command.h
+ * @brief Definition of epp_Command and epp_Command_ref
+ * @author Asbjorn Steira Mikkelsen
+ */
+
+
#include "epp_eppdata.h"
#include "epp_Credentials.h"
***************
*** 35,50 ****
namespace eppobject { namespace epp {
class epp_Command {
- public:
! epp_Credentials_ref m_creds;
! epp_Unspec_ref m_unspec;
! epp_trid_ref m_client_trid;
epp_Command() {};
virtual ~epp_Command() {};
! // Note: Cannot set simple types to NULL
epp_Command(epp_Credentials_ref _m_creds,
epp_Unspec_ref _m_unspec,
--- 41,60 ----
namespace eppobject { namespace epp {
+ /// Class containing generic elements used in a request to the server
class epp_Command {
! public:
! epp_Credentials_ref m_creds; /**< Client identity credentials element that provides client identity information*/
! epp_Unspec_ref m_unspec; /**< Unspecified element used for server-defined command extensions*/
! epp_trid_ref m_client_trid; /**< Client transaction ID element that uniquely identifies the command to the client*/
+ /// Null constructor
epp_Command() {};
+ /// Destructor
virtual ~epp_Command() {};
! /// Constructor, using simple types when it can
! /// @note Cannot set simple types to NULL
epp_Command(epp_Credentials_ref _m_creds,
epp_Unspec_ref _m_unspec,
***************
*** 56,60 ****
};
!
epp_Command(epp_Credentials_ref _m_creds,
epp_Unspec_ref _m_unspec,
--- 66,70 ----
};
! /// Constructor, using only references
epp_Command(epp_Credentials_ref _m_creds,
epp_Unspec_ref _m_unspec,
***************
*** 67,70 ****
--- 77,81 ----
};
+ /// Typedef for the ref to the epp_Result class
typedef refcnt_ptr<epp_Command> epp_Command_ref;
Index: epp_ContactPhone.h
===================================================================
RCS file: /cvsroot/epp-rtk/epp-rtk/c++/src/data/epp_ContactPhone.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** epp_ContactPhone.h 20 Feb 2002 17:26:02 -0000 1.2
--- epp_ContactPhone.h 22 Feb 2002 09:35:42 -0000 1.3
***************
*** 29,47 ****
#define __EPP_CONTACTPHONE_H
#include "epp_contactdata.h"
namespace eppobject { namespace contact {
class epp_ContactPhone {
- public:
-
- eppobject::epp::epp_string_ref m_extension;
- eppobject::epp::epp_string_ref m_value;
epp_ContactPhone() {};
virtual ~epp_ContactPhone() {};
! // Note: Cannot set simple types to NULL
epp_ContactPhone(eppobject::epp::epp_string _m_extension,
eppobject::epp::epp_string _m_value)
--- 29,56 ----
#define __EPP_CONTACTPHONE_H
+ /** @file epp_ContactPhone.h
+ * @brief Definition of epp_ContactPhone and epp_ContactPhone_ref
+ * @author Asbjorn Steira Mikkelsen
+ */
+
#include "epp_contactdata.h"
namespace eppobject { namespace contact {
+ /// Class containing elements used to describe a Contact Telephone/Fax Number
class epp_ContactPhone {
+ public:
+ eppobject::epp::epp_string_ref m_extension; /**< Telephone number extension*/
+ eppobject::epp::epp_string_ref m_value; /**< Telephone number*/
+
+ /// Null constructor
epp_ContactPhone() {};
+ /// Destructor
virtual ~epp_ContactPhone() {};
! /// Constructor, using simple types when it can
! /// @note Cannot set simple types to NULL
epp_ContactPhone(eppobject::epp::epp_string _m_extension,
eppobject::epp::epp_string _m_value)
***************
*** 51,55 ****
};
!
epp_ContactPhone(eppobject::epp::epp_string_ref _m_extension,
eppobject::epp::epp_string_ref _m_value)
--- 60,64 ----
};
! /// Constructor, using only references
epp_ContactPhone(eppobject::epp::epp_string_ref _m_extension,
eppobject::epp::epp_string_ref _m_value)
***************
*** 60,63 ****
--- 69,73 ----
};
+ /// Typedef for the ref to the epp_ContactPhone class
typedef refcnt_ptr<epp_ContactPhone> epp_ContactPhone_ref;
Index: epp_ContactVoice.h
===================================================================
RCS file: /cvsroot/epp-rtk/epp-rtk/c++/src/data/epp_ContactVoice.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** epp_ContactVoice.h 20 Feb 2002 17:26:02 -0000 1.7
--- epp_ContactVoice.h 22 Feb 2002 09:35:42 -0000 1.8
***************
*** 39,54 ****
namespace eppobject { namespace contact {
! /** @deprecated Replaced by epp_ContactPhone */
class epp_ContactVoice {
public:
! eppobject::epp::epp_string_ref m_extension;
! eppobject::epp::epp_string_ref m_value;
epp_ContactVoice() {};
virtual ~epp_ContactVoice() {};
! // Note: Cannot set simple types to NULL
epp_ContactVoice(eppobject::epp::epp_string _m_extension,
eppobject::epp::epp_string _m_value)
--- 39,58 ----
namespace eppobject { namespace contact {
! /// Deprecated! Replaced by epp_ContactPhone
class epp_ContactVoice {
+
public:
! eppobject::epp::epp_string_ref m_extension; /**< Telephone number extension*/
! eppobject::epp::epp_string_ref m_value; /**< Telephone number*/
+ /// Null constructor
epp_ContactVoice() {};
+ /// Destructor
virtual ~epp_ContactVoice() {};
! /// Constructor, using simple types when it can
! /// @note Cannot set simple types to NULL
epp_ContactVoice(eppobject::epp::epp_string _m_extension,
eppobject::epp::epp_string _m_value)
***************
*** 58,62 ****
};
!
epp_ContactVoice(eppobject::epp::epp_string_ref _m_extension,
eppobject::epp::epp_string_ref _m_value)
--- 62,66 ----
};
! /// Constructor, using only references
epp_ContactVoice(eppobject::epp::epp_string_ref _m_extension,
eppobject::epp::epp_string_ref _m_value)
***************
*** 67,70 ****
--- 71,75 ----
};
+ /// Typedef for the ref to the epp_ContactVoice class
typedef refcnt_ptr<epp_ContactVoice> epp_ContactVoice_ref;
Index: epp_Exception.h
===================================================================
RCS file: /cvsroot/epp-rtk/epp-rtk/c++/src/data/epp_Exception.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** epp_Exception.h 20 Feb 2002 17:26:02 -0000 1.4
--- epp_Exception.h 22 Feb 2002 09:35:42 -0000 1.5
***************
*** 29,32 ****
--- 29,37 ----
#define __EPP_EXCEPTION_H
+ /** @file epp_Exception.h
+ * @brief Definition of epp_Exception
+ * @author Asbjorn Steira Mikkelsen
+ */
+
#include "epp_eppdata.h"
#include "epp_Result.h"
***************
*** 37,49 ****
namespace eppobject { namespace epp {
class epp_Exception : public exception {
- public:
! epp_result_seq_ref m_details;
epp_Exception() {};
virtual ~epp_Exception() {};
epp_Exception(const epp_result_seq & data) throw()
{
--- 42,60 ----
namespace eppobject { namespace epp {
+ /// Exception class containing information about errors returned from the EPP server
+ /// or, if in the range 2600-2699, communication errors
+ /// @see epp_Session for more information about error codes
class epp_Exception : public exception {
! public:
! epp_result_seq_ref m_details; /**< Object describing the encountered error(s)*/
+ /// Null constructor
epp_Exception() {};
+ /// Destructor
virtual ~epp_Exception() {};
+ /// Constructor with error data
epp_Exception(const epp_result_seq & data) throw()
{
***************
*** 51,55 ****
};
! // Kept for backwords compatibility:
virtual epp_result_seq_ref getDetails()
{
--- 62,67 ----
};
! /// Returns the error details
! /// @note Kept for backwards compatibility
virtual epp_result_seq_ref getDetails()
{
Index: epp_Options.h
===================================================================
RCS file: /cvsroot/epp-rtk/epp-rtk/c++/src/data/epp_Options.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** epp_Options.h 20 Feb 2002 17:26:02 -0000 1.5
--- epp_Options.h 22 Feb 2002 09:35:42 -0000 1.6
***************
*** 29,46 ****
#define __EPP_OPTIONS_H
#include "epp_eppdata.h"
namespace eppobject { namespace epp {
class epp_Options {
public:
! epp_string_ref m_version;
! epp_string_ref m_lang;
epp_Options() {};
virtual ~epp_Options() {}
! // Note: Cannot set simple types to NULL
epp_Options(epp_string _m_version,
epp_string _m_lang)
--- 29,56 ----
#define __EPP_OPTIONS_H
+ /** @file epp_Options.h
+ * @brief Definition of epp_Options and epp_Options_ref
+ * @author Asbjorn Steira Mikkelsen
+ */
+
#include "epp_eppdata.h"
namespace eppobject { namespace epp {
+ /// Class containing elements used to describe client options for a command/session
class epp_Options {
+
public:
! epp_string_ref m_version; /**< Protocol version to be used for the command or ongoing server session*/
! epp_string_ref m_lang; /**< Text response language to be used for the command or ongoing server session commands*/
+ /// Null constructor
epp_Options() {};
+ /// Destructor
virtual ~epp_Options() {}
! /// Constructor, using simple types when it can
! /// @note Cannot set simple types to NULL
epp_Options(epp_string _m_version,
epp_string _m_lang)
***************
*** 50,54 ****
};
!
epp_Options(epp_string_ref _m_version,
epp_string_ref _m_lang)
--- 60,64 ----
};
! /// Constructor, using only references
epp_Options(epp_string_ref _m_version,
epp_string_ref _m_lang)
***************
*** 59,62 ****
--- 69,73 ----
};
+ /// Typedef for the ref to the epp_Options class
typedef refcnt_ptr<epp_Options> epp_Options_ref;
Index: epp_Response.h
===================================================================
RCS file: /cvsroot/epp-rtk/epp-rtk/c++/src/data/epp_Response.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** epp_Response.h 20 Feb 2002 17:26:02 -0000 1.6
--- epp_Response.h 22 Feb 2002 09:35:42 -0000 1.7
***************
*** 29,32 ****
--- 29,37 ----
#define __EPP_RESPONSE_H
+ /** @file epp_Response.h
+ * @brief Definition of epp_Response and epp_Response_ref
+ * @author Asbjorn Steira Mikkelsen
+ */
+
#include "epp_eppdata.h"
#include "epp_Result.h"
***************
*** 36,51 ****
namespace eppobject { namespace epp {
class epp_Response {
public:
! epp_result_seq_ref m_results;
! epp_MessageQueue_ref m_message_queue;
! epp_xml_string_ref m_unspec_string;
! epp_TransID_ref m_trans_id;
epp_Response() {};
virtual ~epp_Response() {};
epp_Response(epp_result_seq_ref _m_results,
epp_MessageQueue_ref _m_message_queue,
--- 41,61 ----
namespace eppobject { namespace epp {
+ /// Class containing elements used in the response from the server
class epp_Response {
+
public:
! epp_result_seq_ref m_results; /**< Structure to document the success or failure of command execution*/
! epp_MessageQueue_ref m_message_queue; /**< Information about service messages queued for client retrieval*/
! epp_xml_string_ref m_unspec_string; /**< Unspecified element used for server-defined response extensions*/
! epp_TransID_ref m_trans_id; /**< Transaction identifier assigned by the server to the command*/
+ /// Null constructor
epp_Response() {};
+ /// Destructor
virtual ~epp_Response() {};
+ /// Constructor, using only references
epp_Response(epp_result_seq_ref _m_results,
epp_MessageQueue_ref _m_message_queue,
***************
*** 59,63 ****
};
};
!
typedef refcnt_ptr<epp_Response> epp_Response_ref;
--- 69,74 ----
};
};
!
! /// Typedef for the ref to the epp_Response class
typedef refcnt_ptr<epp_Response> epp_Response_ref;
Index: epp_Result.h
===================================================================
RCS file: /cvsroot/epp-rtk/epp-rtk/c++/src/data/epp_Result.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** epp_Result.h 20 Feb 2002 17:26:02 -0000 1.5
--- epp_Result.h 22 Feb 2002 09:35:42 -0000 1.6
***************
*** 29,50 ****
#define __EPP_RESULT_H
#include "epp_eppdata.h"
namespace eppobject { namespace epp {
class epp_Result {
public:
! epp_short_ref m_code;
! epp_string_ref m_msg;
! epp_string_ref m_lang;
! epp_string_ref m_id;
! epp_string_seq_ref m_values;
epp_Result() {};
virtual ~epp_Result() {};
! // Note: Cannot set simple types to NULL
epp_Result(epp_short _m_code,
epp_string _m_msg,
--- 29,61 ----
#define __EPP_RESULT_H
+ /** @file epp_Result.h
+ * @brief Definition of epp_Result and epp_Result_ref
+ * @author Asbjorn Steira Mikkelsen
+ */
+
#include "epp_eppdata.h"
namespace eppobject { namespace epp {
+ /// Class containing elements used to describe success/failure of
+ /// a command in server responses
class epp_Result {
+
public:
! epp_short_ref m_code; /**< Decimal number that describes the success or failure of the command*/
! epp_string_ref m_msg; /**< Human-readable description of the response code*/
! epp_string_ref m_lang; /**< Language of the human-readable response*/
! epp_string_ref m_id; /**< ID to uniquely identify the message returned (used for the Poll command)*/
! epp_string_seq_ref m_values; /**< Client-provided values that caused server error conditions*/
+ /// Null constructor
epp_Result() {};
+ /// Destructor
virtual ~epp_Result() {};
! /// Constructor, using simple types when it can
! /// @note Cannot set simple types to NULL
epp_Result(epp_short _m_code,
epp_string _m_msg,
***************
*** 60,64 ****
};
!
epp_Result(epp_short_ref _m_code,
epp_string_ref _m_msg,
--- 71,75 ----
};
! /// Constructor, using only references
epp_Result(epp_short_ref _m_code,
epp_string_ref _m_msg,
***************
*** 75,78 ****
--- 86,90 ----
};
+ /// Typedef for the ref to the epp_Result class
typedef refcnt_ptr<epp_Result> epp_Result_ref;
Index: epp_Service.h
===================================================================
RCS file: /cvsroot/epp-rtk/epp-rtk/c++/src/data/epp_Service.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** epp_Service.h 20 Feb 2002 17:26:02 -0000 1.6
--- epp_Service.h 22 Feb 2002 09:35:42 -0000 1.7
***************
*** 38,47 ****
namespace eppobject { namespace epp {
! /// Information about a particular service offered through EPP
class epp_Service {
public:
! epp_string_ref m_name; /**< Name of the service */
! epp_string_ref m_xmlns; /**< Namespace for the service */
! epp_string_ref m_schema_location; /**< Location of the schema for the service */
/// Null constructor
--- 38,48 ----
namespace eppobject { namespace epp {
! /// Class containing elements used to describe an EPP service
class epp_Service {
+
public:
! epp_string_ref m_name; /**< Name of the service*/
! epp_string_ref m_xmlns; /**< Namespace for the service*/
! epp_string_ref m_schema_location; /**< Location of the schema for the service*/
/// Null constructor
***************
*** 62,66 ****
};
! /// Constructor, using only ref's
epp_Service(epp_string_ref _m_name,
epp_string_ref _m_xmlns,
--- 63,67 ----
};
! /// Constructor, using only references
epp_Service(epp_string_ref _m_name,
epp_string_ref _m_xmlns,
***************
*** 72,76 ****
};
};
!
/// Typedef for the ref to the epp_Service class
typedef refcnt_ptr<epp_Service> epp_Service_ref;
--- 73,77 ----
};
};
!
/// Typedef for the ref to the epp_Service class
typedef refcnt_ptr<epp_Service> epp_Service_ref;
Index: epp_TransID.h
===================================================================
RCS file: /cvsroot/epp-rtk/epp-rtk/c++/src/data/epp_TransID.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** epp_TransID.h 20 Feb 2002 17:26:02 -0000 1.5
--- epp_TransID.h 22 Feb 2002 09:35:42 -0000 1.6
***************
*** 29,47 ****
#define __EPP_TRANSID_H
#include "epp_eppdata.h"
namespace eppobject { namespace epp {
class epp_TransID {
- public:
! epp_trid_ref m_client_trid;
! epp_trid_ref m_server_trid;
epp_TransID() {};
! virtual ~epp_TransID() {};
! // Note: Cannot set simple types to NULL
epp_TransID(epp_trid _m_client_trid,
epp_trid _m_server_trid)
--- 29,57 ----
#define __EPP_TRANSID_H
+ /** @file epp_TransID.h
+ * @brief Definition of epp_TransID and epp_TransID_ref
+ * @author Asbjorn Steira Mikkelsen
+ */
+
#include "epp_eppdata.h"
namespace eppobject { namespace epp {
+ /// Class containing transaction ID elements assigned by the server
+ /// to the command for which the response is being returned
class epp_TransID {
! public:
! epp_trid_ref m_client_trid; /**< Client transaction ID associated with the command*/
! epp_trid_ref m_server_trid; /**< Server transaction ID assigned by and unique to the server*/
+ /// Null constructor
epp_TransID() {};
! /// Destructor
! virtual ~epp_TransID() {};
! /// Constructor, using simple types when it can
! /// @note Cannot set simple types to NULL
epp_TransID(epp_trid _m_client_trid,
epp_trid _m_server_trid)
***************
*** 51,55 ****
};
!
epp_TransID(epp_trid_ref _m_client_trid,
epp_trid_ref _m_server_trid)
--- 61,65 ----
};
! /// Constructor, using only references
epp_TransID(epp_trid_ref _m_client_trid,
epp_trid_ref _m_server_trid)
***************
*** 60,63 ****
--- 70,74 ----
};
+ /// Typedef for the ref to the epp_Result class
typedef refcnt_ptr<epp_TransID> epp_TransID_ref;
Index: epp_XMLException.h
===================================================================
RCS file: /cvsroot/epp-rtk/epp-rtk/c++/src/data/epp_XMLException.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** epp_XMLException.h 20 Feb 2002 17:26:02 -0000 1.6
--- epp_XMLException.h 22 Feb 2002 09:35:42 -0000 1.7
***************
*** 29,48 ****
#define __EPP_XMLEXCEPTION_H
#include "epp_eppdata.h"
#include <exception>
#include <string>
-
namespace eppobject { namespace epp {
!
class epp_XMLException : public exception {
public:
! epp_string_ref m_error_message;
!
epp_XMLException() {};
virtual ~epp_XMLException() {};
epp_XMLException(const epp_string & data) throw()
{
--- 29,56 ----
#define __EPP_XMLEXCEPTION_H
+ /** @file epp_XMLException.h
+ * @brief Definition of epp_XMLException
+ * @author Asbjorn Steira Mikkelsen
+ */
+
#include "epp_eppdata.h"
#include <exception>
#include <string>
namespace eppobject { namespace epp {
!
! /// Exception class containing information about an error occuring while parsing XML
class epp_XMLException : public exception {
+
public:
+ epp_string_ref m_error_message; /**< Text describing the encountered error*/
! /// Null constructor
epp_XMLException() {};
+ /// Destructor
virtual ~epp_XMLException() {};
+ /// Constructor with error data
epp_XMLException(const epp_string & data) throw()
{
***************
*** 50,54 ****
};
! // Kept for backwords compatibility:
virtual epp_string getString()
{
--- 58,63 ----
};
! /// Returns the error string
! /// @note Kept for backwards compatibility
virtual epp_string getString()
{
***************
*** 59,62 ****
--- 68,72 ----
};
+ /// Constructor with error data, file name, and line number
epp_XMLException(const string file, const int lineno, const epp_string & data) throw()
{
|