#include <Response.H>
Inheritance diagram for Response:
Public Types | |
UNSET = -1 | |
OK = 1000 | |
OK_ACTION_PENDING = 1001 | |
OK_NO_MESSAGES = 1300 | |
OK_ACK_DEQUEUE = 1301 | |
OK_ENDING_SESSION = 1500 | |
UNKNOWN_COMMAND = 2000 | |
COMMAND_SYNTAX_ERROR = 2001 | |
COMMAND_USE_ERROR = 2002 | |
PARAMETER_MISSING = 2003 | |
PARAMETER_RANGE_ERROR = 2004 | |
PARAMETER_SYNTAX_ERROR = 2005 | |
UNIMPLEMENTED_VERSION = 2100 | |
UNIMPLEMENTED_COMMAND = 2101 | |
UNIMPLEMENTED_OPTION = 2102 | |
UNIMPLEMENTED_EXTENSION = 2103 | |
BILLING_FAILURE = 2104 | |
NOT_RENEWABLE = 2105 | |
NOT_TRANSFERABLE = 2106 | |
AUTHENTICATION_ERROR = 2200 | |
AUTHORIZATION_ERROR = 2201 | |
INVALID_AUTHORIZATION_INFO = 2202 | |
PENDING_TRANSFER = 2300 | |
NOT_PENDING_TRANSFER = 2301 | |
OBJECT_EXISTS = 2302 | |
OBJECT_DOESNT_EXIST = 2303 | |
STATUS_PROHIBITS_OPERATION = 2304 | |
ASSOCIATION_PROHIBITS_OPERATION = 2305 | |
PARAMETER_POLICY_ERROR = 2306 | |
UNIMPLEMENTED_SERVICE = 2307 | |
DATA_MGMT_POLICY_VIOLATION = 2308 | |
COMMAND_FAILED = 2400 | |
COMMAND_FAILED_CLOSING_CONN = 2500 | |
AUTHENTICATION_ERROR_CLOSING_CONN = 2501 | |
SESSION_LIMIT_EXCEEDED = 2502 | |
enum | ResultCode { UNSET = -1, OK = 1000, OK_ACTION_PENDING = 1001, OK_NO_MESSAGES = 1300, OK_ACK_DEQUEUE = 1301, OK_ENDING_SESSION = 1500, UNKNOWN_COMMAND = 2000, COMMAND_SYNTAX_ERROR = 2001, COMMAND_USE_ERROR = 2002, PARAMETER_MISSING = 2003, PARAMETER_RANGE_ERROR = 2004, PARAMETER_SYNTAX_ERROR = 2005, UNIMPLEMENTED_VERSION = 2100, UNIMPLEMENTED_COMMAND = 2101, UNIMPLEMENTED_OPTION = 2102, UNIMPLEMENTED_EXTENSION = 2103, BILLING_FAILURE = 2104, NOT_RENEWABLE = 2105, NOT_TRANSFERABLE = 2106, AUTHENTICATION_ERROR = 2200, AUTHORIZATION_ERROR = 2201, INVALID_AUTHORIZATION_INFO = 2202, PENDING_TRANSFER = 2300, NOT_PENDING_TRANSFER = 2301, OBJECT_EXISTS = 2302, OBJECT_DOESNT_EXIST = 2303, STATUS_PROHIBITS_OPERATION = 2304, ASSOCIATION_PROHIBITS_OPERATION = 2305, PARAMETER_POLICY_ERROR = 2306, UNIMPLEMENTED_SERVICE = 2307, DATA_MGMT_POLICY_VIOLATION = 2308, COMMAND_FAILED = 2400, COMMAND_FAILED_CLOSING_CONN = 2500, AUTHENTICATION_ERROR_CLOSING_CONN = 2501, SESSION_LIMIT_EXCEEDED = 2502 } |
Result Codes - See RFC 3730 - Session 3. | |
Public Member Functions | |
Response (bool reset=true) | |
Default constructor. | |
void | set_clTRID (const string &clTRID) |
Sets the client transaction ID. | |
void | set_svTRID (const string &svTRID) |
Sets the server transaction ID. | |
void | set_result_lang (const string &result_lang) |
Sets the result message language. | |
void | insert_result (const ResultCode &code, const string &msg, const string &value="", const string &xmlns="", const string &reason="") |
Sets a result element. | |
string | get_clTRID () |
Returns the client transaction ID. | |
string | get_svTRID () |
Returns the servers transaction ID. | |
string | get_result_lang () |
Returns the result message language. | |
map< ResultCode, ResultInfo > | get_result_list () |
Returns the list of result elements. | |
void | reset () |
reset attributes | |
Protected Attributes | |
string | _clTRID |
Client transaction ID. | |
string | _svTRID |
Server transaction ID. | |
string | _result_lang |
Result language. | |
map< ResultCode, ResultInfo > | _result_list |
Result elements list. | |
Classes | |
struct | ResultExtValue |
struct | ResultInfo |
string Response::get_clTRID | ( | ) | [inline] |
Returns the client transaction ID.
string Response::get_result_lang | ( | ) | [inline] |
Returns the result message language.
map<ResultCode, ResultInfo> Response::get_result_list | ( | ) | [inline] |
Returns the list of result elements.
string Response::get_svTRID | ( | ) | [inline] |
Returns the servers transaction ID.
void Response::insert_result | ( | const ResultCode & | code, | |
const string & | msg, | |||
const string & | value = "" , |
|||
const string & | xmlns = "" , |
|||
const string & | reason = "" | |||
) | [inline] |
Sets a result element.
code | Result code | |
msg | Response text | |
value | value sub-element of extValue | |
xmlns | value sub-element's attribute | |
reason | reason sub-element of extValue |
void Response::set_clTRID | ( | const string & | clTRID | ) | [inline] |
Sets the client transaction ID.
clTRID | Client transacion ID |
void Response::set_result_lang | ( | const string & | result_lang | ) | [inline] |
Sets the result message language.
result_lang | Result message language |
void Response::set_svTRID | ( | const string & | svTRID | ) | [inline] |
Sets the server transaction ID.
svTRID | Server transacion ID |