summaryrefslogtreecommitdiffstats
path: root/src/DotNetOpenAuth.Core/Messaging/Channel.cs
diff options
context:
space:
mode:
authorAndrew Arnott <andrewarnott@gmail.com>2013-02-16 20:15:06 -0800
committerAndrew Arnott <andrewarnott@gmail.com>2013-02-16 20:15:06 -0800
commitfcee7171b683db63aafac3c7351b22a849d06db4 (patch)
tree69e98c2be1e4fb8d8496010ee6e45e5d19ac0a36 /src/DotNetOpenAuth.Core/Messaging/Channel.cs
parent04426dfbba325fd4ed308a6c9c6c103fed14ff13 (diff)
downloadDotNetOpenAuth-fcee7171b683db63aafac3c7351b22a849d06db4.zip
DotNetOpenAuth-fcee7171b683db63aafac3c7351b22a849d06db4.tar.gz
DotNetOpenAuth-fcee7171b683db63aafac3c7351b22a849d06db4.tar.bz2
Lots of stylecop fixes.
Diffstat (limited to 'src/DotNetOpenAuth.Core/Messaging/Channel.cs')
-rw-r--r--src/DotNetOpenAuth.Core/Messaging/Channel.cs19
1 files changed, 15 insertions, 4 deletions
diff --git a/src/DotNetOpenAuth.Core/Messaging/Channel.cs b/src/DotNetOpenAuth.Core/Messaging/Channel.cs
index 6aaf8ea..a134180 100644
--- a/src/DotNetOpenAuth.Core/Messaging/Channel.cs
+++ b/src/DotNetOpenAuth.Core/Messaging/Channel.cs
@@ -330,11 +330,14 @@ namespace DotNetOpenAuth.Messaging {
/// <summary>
/// Gets the protocol message embedded in the given HTTP request, if present.
/// </summary>
- /// <returns>The deserialized message, if one is found. Null otherwise.</returns>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ /// <returns>
+ /// The deserialized message, if one is found. Null otherwise.
+ /// </returns>
+ /// <exception cref="InvalidOperationException">Thrown when <see cref="HttpContext.Current" /> is null.</exception>
/// <remarks>
/// Requires an HttpContext.Current context.
/// </remarks>
- /// <exception cref="InvalidOperationException">Thrown when <see cref="HttpContext.Current"/> is null.</exception>
public Task<IDirectedProtocolMessage> ReadFromRequestAsync(CancellationToken cancellationToken) {
return this.ReadFromRequestAsync(this.GetRequestFromContext(), cancellationToken);
}
@@ -716,7 +719,15 @@ namespace DotNetOpenAuth.Messaging {
}
}
+ /// <summary>
+ /// Provides derived-types the opportunity to wrap an <see cref="HttpMessageHandler"/> with another one.
+ /// </summary>
+ /// <param name="innerHandler">The inner handler received from <see cref="IHostFactories"/></param>
+ /// <returns>The handler to use in <see cref="HttpClient"/> instances.</returns>
protected virtual HttpMessageHandler WrapMessageHandler(HttpMessageHandler innerHandler) {
+ //TODO: make sure that everyone calls this to wrap their handlers rather than using the one directly returned
+ //from IHostFactories.
+
// No wrapping by default.
return innerHandler;
}
@@ -971,7 +982,7 @@ namespace DotNetOpenAuth.Messaging {
/// <returns>
/// A task that completes with the asynchronous operation.
/// </returns>
- /// <exception cref="UnprotectedMessageException"></exception>
+ /// <exception cref="UnprotectedMessageException">Thrown if the message does not have the minimal required protections applied.</exception>
/// <remarks>
/// This method should NOT be called by derived types
/// except when sending ONE WAY request messages.
@@ -1145,7 +1156,7 @@ namespace DotNetOpenAuth.Messaging {
/// <returns>
/// A task that completes with the asynchronous operation.
/// </returns>
- /// <exception cref="UnprotectedMessageException"></exception>
+ /// <exception cref="UnprotectedMessageException">Thrown if the message does not have the minimal required protections applied.</exception>
/// <exception cref="ProtocolException">Thrown when the message is somehow invalid.
/// This can be due to tampering, replay attack or expiration, among other things.</exception>
protected virtual async Task ProcessIncomingMessageAsync(IProtocolMessage message, CancellationToken cancellationToken) {