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

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llhttpclient.h
  3.  * @brief Declaration of classes for making HTTP client requests.
  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 LL_LLHTTPCLIENT_H
  33. #define LL_LLHTTPCLIENT_H
  34. /**
  35.  * These classes represent the HTTP client framework.
  36.  */
  37. #include <string>
  38. #include <boost/intrusive_ptr.hpp>
  39. #include "llassettype.h"
  40. #include "llcurl.h"
  41. #include "lliopipe.h"
  42. extern const F32 HTTP_REQUEST_EXPIRY_SECS;
  43. class LLUUID;
  44. class LLPumpIO;
  45. class LLSD;
  46. class LLHTTPClient
  47. {
  48. public:
  49. // class Responder moved to LLCurl
  50. // For convenience
  51. typedef LLCurl::Responder Responder;
  52. typedef LLCurl::ResponderPtr ResponderPtr;
  53. /** @name non-blocking API */
  54. //@{
  55. static void head(
  56. const std::string& url,
  57. ResponderPtr,
  58. const LLSD& headers = LLSD(),
  59. const F32 timeout=HTTP_REQUEST_EXPIRY_SECS);
  60. static void getByteRange(const std::string& url, S32 offset, S32 bytes, ResponderPtr, const LLSD& headers=LLSD(), const F32 timeout=HTTP_REQUEST_EXPIRY_SECS);
  61. static void get(const std::string& url, ResponderPtr, const LLSD& headers = LLSD(), const F32 timeout=HTTP_REQUEST_EXPIRY_SECS);
  62. static void get(const std::string& url, const LLSD& query, ResponderPtr, const LLSD& headers = LLSD(), const F32 timeout=HTTP_REQUEST_EXPIRY_SECS);
  63. static void put(
  64. const std::string& url,
  65. const LLSD& body,
  66. ResponderPtr,
  67. const LLSD& headers = LLSD(),
  68. const F32 timeout=HTTP_REQUEST_EXPIRY_SECS);
  69. static void getHeaderOnly(const std::string& url, ResponderPtr, const F32 timeout=HTTP_REQUEST_EXPIRY_SECS);
  70. static void getHeaderOnly(const std::string& url, ResponderPtr, const LLSD& headers, const F32 timeout=HTTP_REQUEST_EXPIRY_SECS);
  71. static void post(
  72. const std::string& url,
  73. const LLSD& body,
  74. ResponderPtr,
  75. const LLSD& headers = LLSD(),
  76. const F32 timeout=HTTP_REQUEST_EXPIRY_SECS);
  77. /** Takes ownership of data and deletes it when sent */
  78. static void postRaw(
  79. const std::string& url,
  80. const U8* data,
  81. S32 size,
  82. ResponderPtr responder,
  83. const LLSD& headers = LLSD(),
  84. const F32 timeout=HTTP_REQUEST_EXPIRY_SECS);
  85. static void postFile(
  86. const std::string& url,
  87. const std::string& filename,
  88. ResponderPtr,
  89. const LLSD& headers = LLSD(),
  90. const F32 timeout=HTTP_REQUEST_EXPIRY_SECS);
  91. static void postFile(
  92. const std::string& url,
  93. const LLUUID& uuid,
  94. LLAssetType::EType asset_type,
  95. ResponderPtr responder,
  96. const LLSD& headers = LLSD(),
  97. const F32 timeout=HTTP_REQUEST_EXPIRY_SECS);
  98. static void del(
  99. const std::string& url,
  100. ResponderPtr responder,
  101. const LLSD& headers = LLSD(),
  102. const F32 timeout=HTTP_REQUEST_EXPIRY_SECS);
  103. ///< sends a DELETE method, but we can't call it delete in c++
  104. /**
  105.  * @brief Send a MOVE webdav method
  106.  *
  107.  * @param url The complete serialized (and escaped) url to get.
  108.  * @param destination The complete serialized destination url.
  109.  * @param responder The responder that will handle the result.
  110.  * @param headers A map of key:value headers to pass to the request
  111.  * @param timeout The number of seconds to give the server to respond.
  112.  */
  113. static void move(
  114. const std::string& url,
  115. const std::string& destination,
  116. ResponderPtr responder,
  117. const LLSD& headers = LLSD(),
  118. const F32 timeout=HTTP_REQUEST_EXPIRY_SECS);
  119. //@}
  120. /**
  121.  * @brief Blocking HTTP get that returns an LLSD map of status and body.
  122.  *
  123.  * @param url the complete serialized (and escaped) url to get
  124.  * @return An LLSD of { 'status':status, 'body':payload }
  125.  */
  126. static LLSD blockingGet(const std::string& url);
  127. /**
  128.  * @brief Blocking HTTP POST that returns an LLSD map of status and body.
  129.  *
  130.  * @param url the complete serialized (and escaped) url to get
  131.  * @param body the LLSD post body
  132.  * @return An LLSD of { 'status':status (an int), 'body':payload (an LLSD) }
  133.  */
  134. static LLSD blockingPost(const std::string& url, const LLSD& body);
  135. static void setPump(LLPumpIO& pump);
  136. ///< must be called before any of the above calls are made
  137. static bool hasPump();
  138. ///< for testing
  139. };
  140. #endif // LL_LLHTTPCLIENT_H