OpenSim
/
OpenSimMirror
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

minor: Add method doc to SynchronousRestObjectRequester.MakeRequest() methods

bullet-2.82
Justin Clark-Casey (justincc) 2014-05-12 22:05:02 +01:00
parent faf9ba53fc
commit 7db4336f1c
1 changed files with 27 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
OpenSim/Framework/WebUtil.cs
View File

@ -1086,20 +1086,42 @@ namespace OpenSim.Framework
/// <param name="verb"></param> /// <param name="verb"></param>
/// <param name="requestUrl"></param> /// <param name="requestUrl"></param>
/// <param name="obj"></param> /// <param name="obj"></param>
/// <returns></returns> /// <returns>
/// /// The response. If there was an internal exception, then the default(TResponse) is returned.
/// <exception cref="System.Net.WebException">Thrown if we encounter a network issue while posting /// </returns>
/// the request. You'll want to make sure you deal with this as they're not uncommon</exception>
public static TResponse MakeRequest<TRequest, TResponse>(string verb, string requestUrl, TRequest obj) public static TResponse MakeRequest<TRequest, TResponse>(string verb, string requestUrl, TRequest obj)
{ {
return MakeRequest<TRequest, TResponse>(verb, requestUrl, obj, 0); return MakeRequest<TRequest, TResponse>(verb, requestUrl, obj, 0);
} }
/// <summary>
/// Perform a synchronous REST request.
/// </summary>
/// <param name="verb"></param>
/// <param name="requestUrl"></param>
/// <param name="obj"></param>
/// <param name="pTimeout">Request timeout in milliseconds.</param>
/// <returns>
/// The response. If there was an internal exception or the request timed out,
/// then the default(TResponse) is returned.
/// </returns>
public static TResponse MakeRequest<TRequest, TResponse>(string verb, string requestUrl, TRequest obj, int pTimeout) public static TResponse MakeRequest<TRequest, TResponse>(string verb, string requestUrl, TRequest obj, int pTimeout)
{ {
return MakeRequest<TRequest, TResponse>(verb, requestUrl, obj, pTimeout, 0); return MakeRequest<TRequest, TResponse>(verb, requestUrl, obj, pTimeout, 0);
} }
/// <summary>
/// Perform a synchronous REST request.
/// </summary>
/// <param name="verb"></param>
/// <param name="requestUrl"></param>
/// <param name="obj"></param>
/// <param name="pTimeout">Request timeout in milliseconds.</param>
/// <param name="maxConnections"></param>
/// <returns>
/// The response. If there was an internal exception or the request timed out,
/// then the default(TResponse) is returned.
/// </returns>
public static TResponse MakeRequest<TRequest, TResponse>(string verb, string requestUrl, TRequest obj, int pTimeout, int maxConnections) public static TResponse MakeRequest<TRequest, TResponse>(string verb, string requestUrl, TRequest obj, int pTimeout, int maxConnections)
{ {
int reqnum = WebUtil.RequestNumber++; int reqnum = WebUtil.RequestNumber++;