Interface IHttpContextImpl
Represents a HTTP context implementation, i.e. a HTTP context as seen internally by EmbedIO.
This API mainly supports the EmbedIO infrastructure; it is not intended to be used directly from your code, unless to address specific needs in the implementation of EmbedIO plug-ins (e.g. modules).
Inherited Members
Namespace: EmbedIO
Syntax
public interface IHttpContextImpl : IHttpContext, IMimeTypeProvider
Properties
CancellationToken
Gets or sets a CancellationToken used to stop processing of this context.
This API supports the EmbedIO infrastructure and is not intended to be used directly from your code.
Declaration
CancellationToken CancellationToken { get; set; }
Property Value
Type | Description |
---|---|
CancellationToken |
MimeTypeProviders
Gets the MIME type providers.
This API supports the EmbedIO infrastructure and is not intended to be used directly from your code.
Declaration
MimeTypeProviderStack MimeTypeProviders { get; }
Property Value
Type | Description |
---|---|
MimeTypeProviderStack |
Route
Gets or sets the route matched by the requested URL path.
Declaration
RouteMatch Route { get; set; }
Property Value
Type | Description |
---|---|
RouteMatch |
Session
Gets or sets the session proxy associated with this context.
This API supports the EmbedIO infrastructure and is not intended to be used directly from your code.
Declaration
ISessionProxy Session { get; set; }
Property Value
Type | Description |
---|---|
ISessionProxy | An |
SupportCompressedRequests
Gets or sets a value indicating whether compressed request bodies are supported.
This API supports the EmbedIO infrastructure and is not intended to be used directly from your code.
Declaration
bool SupportCompressedRequests { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
See Also
User
Gets or sets the user.
This API supports the EmbedIO infrastructure and is not intended to be used directly from your code.
Declaration
IPrincipal User { get; set; }
Property Value
Type | Description |
---|---|
IPrincipal |
Methods
AcceptWebSocketAsync(IEnumerable<String>, String, Int32, TimeSpan, CancellationToken)
Asynchronously handles a WebSockets opening handshake
and returns a newly-created
This API supports the EmbedIO infrastructure and is not intended to be used directly from your code.
Declaration
Task<IWebSocketContext> AcceptWebSocketAsync(IEnumerable<string> requestedProtocols, string acceptedProtocol, int receiveBufferSize, TimeSpan keepAliveInterval, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<String> | requestedProtocols | The requested WebSocket sub-protocols. |
String | acceptedProtocol | The accepted WebSocket sub-protocol, or the empty string is no sub-protocol has been agreed upon. |
Int32 | receiveBufferSize | Size of the receive buffer. |
TimeSpan | keepAliveInterval | The keep-alive interval. |
CancellationToken | cancellationToken | A CancellationToken used to stop the server. |
Returns
Type | Description |
---|---|
Task<IWebSocketContext> | An |
Close()
Flushes and closes the response stream, then calls any registered close callbacks.
This API supports the EmbedIO infrastructure and is not intended to be used directly from your code.
Declaration
void Close()