Class MiddlewareBase

Namespace

HotChocolate.AspNetCore

Assembly

HotChocolate.AspNetCore.dll

The Hot Chocolate ASP.NET core middleware base class.

public class MiddlewareBase : IDisposable

Inheritance

object

MiddlewareBase

Implements

IDisposable

Derived

HttpGetMiddleware

HttpGetSchemaMiddleware

HttpPostMiddlewareBase

WebSocketSubscriptionMiddleware

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MiddlewareBase(RequestDelegate, IRequestExecutorResolver, IHttpResponseFormatter, string)

protected MiddlewareBase(RequestDelegate next, IRequestExecutorResolver executorResolver, IHttpResponseFormatter responseFormatter, string schemaName)

Parameters

next RequestDelegate

executorResolver IRequestExecutorResolver

responseFormatter IHttpResponseFormatter

schemaName string

Properties

ExecutorProxy

Gets the request executor proxy.

protected RequestExecutorProxy ExecutorProxy { get; }

Property Value

RequestExecutorProxy

IsDefaultSchema

Specifies if this middleware handles the default schema.

protected bool IsDefaultSchema { get; }

Property Value

bool

SchemaName

Gets the name of the schema that this middleware serves up.

protected string SchemaName { get; }

Property Value

string

Methods

CreateRequestFlags(AcceptMediaType[])

protected GraphQLRequestFlags CreateRequestFlags(AcceptMediaType[] acceptMediaTypes)

Parameters

acceptMediaTypes AcceptMediaType[]

Returns

GraphQLRequestFlags

Dispose()

public void Dispose()

Dispose(bool)

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

ExecuteBatchAsync(HttpContext, IRequestExecutor, IHttpRequestInterceptor, IServerDiagnosticEvents, IReadOnlyList<GraphQLRequest>, GraphQLRequestFlags)

protected static Task<IResponseStream> ExecuteBatchAsync(HttpContext context, IRequestExecutor requestExecutor, IHttpRequestInterceptor requestInterceptor, IServerDiagnosticEvents diagnosticEvents, IReadOnlyList<GraphQLRequest> requests, GraphQLRequestFlags flags)

Parameters

context HttpContext

requestExecutor IRequestExecutor

requestInterceptor IHttpRequestInterceptor

diagnosticEvents IServerDiagnosticEvents

requests IReadOnlyList<GraphQLRequest>

flags GraphQLRequestFlags

Returns

Task<IResponseStream>

ExecuteOperationBatchAsync(HttpContext, IRequestExecutor, IHttpRequestInterceptor, IServerDiagnosticEvents, GraphQLRequest, GraphQLRequestFlags, IReadOnlyList<string>)

protected static Task<IResponseStream> ExecuteOperationBatchAsync(HttpContext context, IRequestExecutor requestExecutor, IHttpRequestInterceptor requestInterceptor, IServerDiagnosticEvents diagnosticEvents, GraphQLRequest request, GraphQLRequestFlags flags, IReadOnlyList<string> operationNames)

Parameters

context HttpContext

requestExecutor IRequestExecutor

requestInterceptor IHttpRequestInterceptor

diagnosticEvents IServerDiagnosticEvents

request GraphQLRequest

flags GraphQLRequestFlags

operationNames IReadOnlyList<string>

Returns

Task<IResponseStream>

ExecuteSingleAsync(HttpContext, IRequestExecutor, IHttpRequestInterceptor, IServerDiagnosticEvents, GraphQLRequest, GraphQLRequestFlags)

protected static Task<IExecutionResult> ExecuteSingleAsync(HttpContext context, IRequestExecutor requestExecutor, IHttpRequestInterceptor requestInterceptor, IServerDiagnosticEvents diagnosticEvents, GraphQLRequest request, GraphQLRequestFlags flags)

Parameters

context HttpContext

requestExecutor IRequestExecutor

requestInterceptor IHttpRequestInterceptor

diagnosticEvents IServerDiagnosticEvents

request GraphQLRequest

flags GraphQLRequestFlags

Returns

Task<IExecutionResult>

GetExecutorAsync(CancellationToken)

Gets the request executor for this middleware.

protected ValueTask<IRequestExecutor> GetExecutorAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

ValueTask<IRequestExecutor>

Returns the request executor for this middleware.

GetOptions(HttpContext)

protected GraphQLServerOptions GetOptions(HttpContext context)

Parameters

context HttpContext

Returns

GraphQLServerOptions

GetSchemaAsync(CancellationToken)

Gets the schema for this middleware.

protected ValueTask<ISchema> GetSchemaAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

ValueTask<ISchema>

Returns the schema for this middleware.

NextAsync(HttpContext)

Invokes the next middleware in line.

protected Task NextAsync(HttpContext context)

Parameters

context HttpContext

The HttpContext.

Returns

Task

ParseContentType(HttpContext)

protected static RequestContentType ParseContentType(HttpContext context)

Parameters

context HttpContext

Returns

RequestContentType

WriteResultAsync(HttpContext, IExecutionResult, AcceptMediaType[], HttpStatusCode?)

protected ValueTask WriteResultAsync(HttpContext context, IExecutionResult result, AcceptMediaType[] acceptMediaTypes, HttpStatusCode? statusCode = null)

Parameters

context HttpContext

result IExecutionResult

acceptMediaTypes AcceptMediaType[]

statusCode HttpStatusCode?

Returns

ValueTask