llxmlrpctransaction.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:4k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llxmlrpctransaction.h
  3.  * @brief LLXMLRPCTransaction and related class header file
  4.  *
  5.  * $LicenseInfo:firstyear=2006&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2006-2010, Linden Research, Inc.
  8.  * 
  9.  * Second Life Viewer Source Code
  10.  * The source code in this file ("Source Code") is provided by Linden Lab
  11.  * to you under the terms of the GNU General Public License, version 2.0
  12.  * ("GPL"), unless you have obtained a separate licensing agreement
  13.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  14.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  15.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  16.  * 
  17.  * There are special exceptions to the terms and conditions of the GPL as
  18.  * it is applied to this Source Code. View the full text of the exception
  19.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  20.  * online at
  21.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  22.  * 
  23.  * By copying, modifying or distributing this software, you acknowledge
  24.  * that you have read and understood your obligations described above,
  25.  * and agree to abide by those obligations.
  26.  * 
  27.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  28.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  29.  * COMPLETENESS OR PERFORMANCE.
  30.  * $/LicenseInfo$
  31.  */
  32. #ifndef LLXMLRPCTRANSACTION_H
  33. #define LLXMLRPCTRANSACTION_H
  34. #include <string>
  35. typedef struct _xmlrpc_request* XMLRPC_REQUEST;
  36. typedef struct _xmlrpc_value* XMLRPC_VALUE;
  37. // foward decl of types from xmlrpc.h (this usage is type safe)
  38. class LLXMLRPCValue
  39. // a c++ wrapper around XMLRPC_VALUE
  40. {
  41. public:
  42. LLXMLRPCValue() : mV(NULL) { }
  43. LLXMLRPCValue(XMLRPC_VALUE value) : mV(value) { }
  44. bool isValid() const;
  45. std::string asString() const;
  46. int asInt() const;
  47. bool asBool() const;
  48. double asDouble() const;
  49. LLXMLRPCValue operator[](const char*) const;
  50. LLXMLRPCValue rewind();
  51. LLXMLRPCValue next();
  52. static LLXMLRPCValue createArray();
  53. static LLXMLRPCValue createStruct();
  54. void append(LLXMLRPCValue&);
  55. void appendString(const std::string&);
  56. void appendInt(int);
  57. void appendBool(bool);
  58. void appendDouble(double);
  59. void appendValue(LLXMLRPCValue&);
  60. void append(const char*, LLXMLRPCValue&);
  61. void appendString(const char*, const std::string&);
  62. void appendInt(const char*, int);
  63. void appendBool(const char*, bool);
  64. void appendDouble(const char*, double);
  65. void appendValue(const char*, LLXMLRPCValue&);
  66. void cleanup();
  67. // only call this on the top level created value
  68. XMLRPC_VALUE getValue() const;
  69. private:
  70. XMLRPC_VALUE mV;
  71. };
  72. class LLXMLRPCTransaction
  73. // an asynchronous request and respones via XML-RPC
  74. {
  75. public:
  76. LLXMLRPCTransaction(const std::string& uri,
  77. XMLRPC_REQUEST request, bool useGzip = true);
  78. // does not take ownership of the request object
  79. // request can be freed as soon as the transaction is constructed
  80. LLXMLRPCTransaction(const std::string& uri,
  81. const std::string& method, LLXMLRPCValue params, bool useGzip = true);
  82. // *does* take control of the request value, you must not free it
  83. ~LLXMLRPCTransaction();
  84. typedef enum e_status {
  85. StatusNotStarted,
  86. StatusStarted,
  87. StatusDownloading,
  88. StatusComplete,
  89. StatusCURLError,
  90. StatusXMLRPCError,
  91. StatusOtherError
  92. } EStatus;
  93. bool process();
  94. // run the request a little, returns true when done
  95. EStatus status(int* curlCode);
  96. // return status, and extended CURL code, if code isn't null
  97. std::string statusMessage();
  98. // return a message string, suitable for showing the user
  99. std::string statusURI();
  100. // return a URI for the user with more information
  101. // can be empty
  102. XMLRPC_REQUEST response();
  103. LLXMLRPCValue responseValue();
  104. // only valid if StatusComplete, otherwise NULL
  105. // retains ownership of the result object, don't free it
  106. F64 transferRate();
  107. // only valid if StsatusComplete, otherwise 0.0
  108. private:
  109. class Impl;
  110. Impl& impl;
  111. };
  112. #endif // LLXMLRPCTRANSACTION_H