diff options
Diffstat (limited to 'OpenSim/Region/Framework/Interfaces/IHttpRequests.cs')
-rw-r--r-- | OpenSim/Region/Framework/Interfaces/IHttpRequests.cs | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/IHttpRequests.cs b/OpenSim/Region/Framework/Interfaces/IHttpRequests.cs new file mode 100644 index 0000000..124504c --- /dev/null +++ b/OpenSim/Region/Framework/Interfaces/IHttpRequests.cs | |||
@@ -0,0 +1,93 @@ | |||
1 | /* | ||
2 | * Copyright (c) Contributors, http://opensimulator.org/ | ||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
4 | * | ||
5 | * Redistribution and use in source and binary forms, with or without | ||
6 | * modification, are permitted provided that the following conditions are met: | ||
7 | * * Redistributions of source code must retain the above copyright | ||
8 | * notice, this list of conditions and the following disclaimer. | ||
9 | * * Redistributions in binary form must reproduce the above copyright | ||
10 | * notice, this list of conditions and the following disclaimer in the | ||
11 | * documentation and/or other materials provided with the distribution. | ||
12 | * * Neither the name of the OpenSimulator Project nor the | ||
13 | * names of its contributors may be used to endorse or promote products | ||
14 | * derived from this software without specific prior written permission. | ||
15 | * | ||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
26 | */ | ||
27 | |||
28 | using System; | ||
29 | using System.Collections.Generic; | ||
30 | using OpenMetaverse; | ||
31 | |||
32 | namespace OpenSim.Region.Framework.Interfaces | ||
33 | { | ||
34 | public enum HttpRequestConstants | ||
35 | { | ||
36 | HTTP_METHOD = 0, | ||
37 | HTTP_MIMETYPE = 1, | ||
38 | HTTP_BODY_MAXLENGTH = 2, | ||
39 | HTTP_VERIFY_CERT = 3, | ||
40 | HTTP_VERBOSE_THROTTLE = 4, | ||
41 | HTTP_CUSTOM_HEADER = 5, | ||
42 | HTTP_PRAGMA_NO_CACHE = 6 | ||
43 | } | ||
44 | |||
45 | /// <summary> | ||
46 | /// The initial status of the request before it is placed on the wire. | ||
47 | /// </summary> | ||
48 | /// <remarks> | ||
49 | /// The request may still fail later on, in which case the normal HTTP status is set. | ||
50 | /// </remarks> | ||
51 | [Flags] | ||
52 | public enum HttpInitialRequestStatus | ||
53 | { | ||
54 | OK = 1, | ||
55 | DISALLOWED_BY_FILTER = 2 | ||
56 | } | ||
57 | |||
58 | public interface IHttpRequestModule | ||
59 | { | ||
60 | UUID MakeHttpRequest(string url, string parameters, string body); | ||
61 | |||
62 | /// <summary> | ||
63 | /// Starts the http request. | ||
64 | /// </summary> | ||
65 | /// <remarks> | ||
66 | /// This is carried out asynchronously unless it fails initial checks. Results are fetched by the script engine | ||
67 | /// HTTP requests module to be distributed back to scripts via a script event. | ||
68 | /// </remarks> | ||
69 | /// <returns>The ID of the request. If the requested could not be performed then this is UUID.Zero</returns> | ||
70 | /// <param name="localID">Local ID of the object containing the script making the request.</param> | ||
71 | /// <param name="itemID">Item ID of the script making the request.</param> | ||
72 | /// <param name="url">Url to request.</param> | ||
73 | /// <param name="parameters">LSL parameters for the request.</param> | ||
74 | /// <param name="headers">Extra headers for the request.</param> | ||
75 | /// <param name="body">Body of the request.</param> | ||
76 | /// <param name="status"> | ||
77 | /// Initial status of the request. If OK then the request is actually made to the URL. Subsequent status is | ||
78 | /// then returned via IServiceRequest when the response is asynchronously fetched. | ||
79 | /// </param> | ||
80 | UUID StartHttpRequest( | ||
81 | uint localID, UUID itemID, string url, List<string> parameters, Dictionary<string, string> headers, string body, | ||
82 | out HttpInitialRequestStatus status); | ||
83 | |||
84 | /// <summary> | ||
85 | /// Stop and remove all http requests for the given script. | ||
86 | /// </summary> | ||
87 | /// <param name='id'></param> | ||
88 | void StopHttpRequestsForScript(UUID id); | ||
89 | |||
90 | IServiceRequest GetNextCompletedRequest(); | ||
91 | void RemoveCompletedRequest(UUID id); | ||
92 | } | ||
93 | } | ||