diff options
author | Justin Clark-Casey (justincc) | 2014-05-12 22:05:02 +0100 |
---|---|---|
committer | Justin Clark-Casey (justincc) | 2014-05-12 22:05:02 +0100 |
commit | 7db4336f1cf612ac8694cd6bd20624d97cf4a7ff (patch) | |
tree | f6ae1690b3c4c40a6153217004657d67ae703967 /OpenSim/Framework/WebUtil.cs | |
parent | In SynchronousRestObjectRequester.MakeRequest<TRequest, TResponse>(string ver... (diff) | |
download | opensim-SC_OLD-7db4336f1cf612ac8694cd6bd20624d97cf4a7ff.zip opensim-SC_OLD-7db4336f1cf612ac8694cd6bd20624d97cf4a7ff.tar.gz opensim-SC_OLD-7db4336f1cf612ac8694cd6bd20624d97cf4a7ff.tar.bz2 opensim-SC_OLD-7db4336f1cf612ac8694cd6bd20624d97cf4a7ff.tar.xz |
minor: Add method doc to SynchronousRestObjectRequester.MakeRequest() methods
Diffstat (limited to '')
-rw-r--r-- | OpenSim/Framework/WebUtil.cs | 32 |
1 files changed, 27 insertions, 5 deletions
diff --git a/OpenSim/Framework/WebUtil.cs b/OpenSim/Framework/WebUtil.cs index 2a309a7..37ecd46 100644 --- a/OpenSim/Framework/WebUtil.cs +++ b/OpenSim/Framework/WebUtil.cs | |||
@@ -1085,21 +1085,43 @@ namespace OpenSim.Framework | |||
1085 | /// </summary> | 1085 | /// </summary> |
1086 | /// <param name="verb"></param> | 1086 | /// <param name="verb"></param> |
1087 | /// <param name="requestUrl"></param> | 1087 | /// <param name="requestUrl"></param> |
1088 | /// <param name="obj"> </param> | 1088 | /// <param name="obj"></param> |
1089 | /// <returns></returns> | 1089 | /// <returns> |
1090 | /// | 1090 | /// The response. If there was an internal exception, then the default(TResponse) is returned. |
1091 | /// <exception cref="System.Net.WebException">Thrown if we encounter a network issue while posting | 1091 | /// </returns> |
1092 | /// the request. You'll want to make sure you deal with this as they're not uncommon</exception> | ||
1093 | public static TResponse MakeRequest<TRequest, TResponse>(string verb, string requestUrl, TRequest obj) | 1092 | public static TResponse MakeRequest<TRequest, TResponse>(string verb, string requestUrl, TRequest obj) |
1094 | { | 1093 | { |
1095 | return MakeRequest<TRequest, TResponse>(verb, requestUrl, obj, 0); | 1094 | return MakeRequest<TRequest, TResponse>(verb, requestUrl, obj, 0); |
1096 | } | 1095 | } |
1097 | 1096 | ||
1097 | /// <summary> | ||
1098 | /// Perform a synchronous REST request. | ||
1099 | /// </summary> | ||
1100 | /// <param name="verb"></param> | ||
1101 | /// <param name="requestUrl"></param> | ||
1102 | /// <param name="obj"></param> | ||
1103 | /// <param name="pTimeout">Request timeout in milliseconds.</param> | ||
1104 | /// <returns> | ||
1105 | /// The response. If there was an internal exception or the request timed out, | ||
1106 | /// then the default(TResponse) is returned. | ||
1107 | /// </returns> | ||
1098 | public static TResponse MakeRequest<TRequest, TResponse>(string verb, string requestUrl, TRequest obj, int pTimeout) | 1108 | public static TResponse MakeRequest<TRequest, TResponse>(string verb, string requestUrl, TRequest obj, int pTimeout) |
1099 | { | 1109 | { |
1100 | return MakeRequest<TRequest, TResponse>(verb, requestUrl, obj, pTimeout, 0); | 1110 | return MakeRequest<TRequest, TResponse>(verb, requestUrl, obj, pTimeout, 0); |
1101 | } | 1111 | } |
1102 | 1112 | ||
1113 | /// <summary> | ||
1114 | /// Perform a synchronous REST request. | ||
1115 | /// </summary> | ||
1116 | /// <param name="verb"></param> | ||
1117 | /// <param name="requestUrl"></param> | ||
1118 | /// <param name="obj"></param> | ||
1119 | /// <param name="pTimeout">Request timeout in milliseconds.</param> | ||
1120 | /// <param name="maxConnections"></param> | ||
1121 | /// <returns> | ||
1122 | /// The response. If there was an internal exception or the request timed out, | ||
1123 | /// then the default(TResponse) is returned. | ||
1124 | /// </returns> | ||
1103 | public static TResponse MakeRequest<TRequest, TResponse>(string verb, string requestUrl, TRequest obj, int pTimeout, int maxConnections) | 1125 | public static TResponse MakeRequest<TRequest, TResponse>(string verb, string requestUrl, TRequest obj, int pTimeout, int maxConnections) |
1104 | { | 1126 | { |
1105 | int reqnum = WebUtil.RequestNumber++; | 1127 | int reqnum = WebUtil.RequestNumber++; |