# Functions
AnnotateContext adds context information such as metadata from the request.
AnnotateIncomingContext adds context information such as metadata from the request.
DefaultHeaderMatcher is used to pass http request headers to/from gRPC context.
DefaultHTTPErrorHandler is the default error handler.
DefaultRoutingErrorHandler is our default handler for routing errors.
No description provided by the author
No description provided by the author
No description provided by the author
HTTPPathPattern returns the HTTP path pattern string relating to the HTTP handler, if one exists.
HTTPStatusFromCode converts a gRPC error code into the corresponding HTTP response status.
NewServeMux returns a new ServeMux whose internal mapping is empty.
NewServerMetadataContext creates a new context with ServerMetadata.
RPCMethod returns the method string for the server context.
ServerMetadataFromContext returns the ServerMetadata in ctx.
WithDisablePathLengthFallback returns a ServeMuxOption for disable path length fallback.
WithErrorHandler returns a ServeMuxOption for configuring a custom error handler.
WithForwardResponseOption returns a ServeMuxOption representing the forwardResponseOption.
WithGlobalOptionsHandler sets an optional handler that is called on automatic OPTIONS requests.
WithHealthEndpointAt returns a ServeMuxOption that will add an endpoint to the created ServeMux at the path specified by endpointPath.
WithHealthzEndpoint returns a ServeMuxOption that will add a /healthz endpoint to the created ServeMux.
No description provided by the author
WithIncomingHeaderMatcher returns a ServeMuxOption representing a headerMatcher for incoming request to gateway.
WithMetadata returns a ServeMuxOption for passing metadata to a gRPC context.
WithMethodNotAllowedHandler sets a configurable http.Handler which is called when a request cannot be routed and HandleMethodNotAllowed is true.
WithNotFoundHandler sets a configurable http.Handler which is called when no matching route is found.
WithOutgoingHeaderMatcher returns a ServeMuxOption representing a headerMatcher for outgoing response from gateway.
WithoutHandlingOptions disabled automatically handling OPTIONS for available endpoints, which is by default enabled.
WithPanicHandler sets the function to handle panics recovered from http handlers.
WithQueryParameterParser sets the query parameter parser, used to populate message from query parameters.
WithRoutingErrorHandler returns a ServeMuxOption for configuring a custom error handler to handle http routing errors.
WithSSEConfig sets Server-Sent Events (SSE) configuration.
WithSSEErrorHandler returns a ServeMuxOption for configuring an SSE error handler.
WithStreamErrorHandler returns a ServeMuxOption that will use the given custom stream error handler, which allows for customizing the error trailer for server-streaming calls.
WithWebsocketErrorHandler returns a ServeMuxOption for configuring a websocket error handler.
WithWebsocketUpgrader enables websocket upgrades for the serve mux.
# Constants
ErrRoutingMethodNotAllowed is for routes that exist but with a different HTTP method.
ErrRoutingNotFound is for routes that are not handled by the serve mux.
MetadataHeaderPrefix is the http prefix that represents custom metadata parameters to or from a gRPC call.
MetadataPrefix is prepended to permanent HTTP header keys (as specified by the IANA) when added to the gRPC context.
MetadataTrailerPrefix is prepended to gRPC metadata as it is converted to HTTP headers in a response handled by grpc-gateway.
# Variables
DefaultContextTimeout is used for gRPC call context.WithTimeout whenever a Grpc-Timeout inbound header isn't present.
# Structs
DefaultQueryParser is a QueryParameterParser which implements the default query parameters parsing behavior.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
HTTPStatusError is the error to use when needing to provide a different HTTP status code for an error passed to the DefaultRoutingErrorHandler.
QueryParameterParseOptions hold all inputs for parsing query parameters.
ServeMux is a request multiplexer for grpc-gateway.
ServerMetadata consists of metadata sent from gRPC server.
ServerTransportStream implements grpc.ServerTransportStream.
SSEConfig configures the behavior of the Server-Sent Events (SSE).
SSEMessage describes a single Server-Sent Events (SSE) message.
# Interfaces
No description provided by the author
QueryParameterParser defines interface for all query parameter parsers.
ServeMuxOption is an option that can be given to a ServeMux on construction.
# Type aliases
No description provided by the author
Decoder decodes a byte sequence.
DecoderFunc adapts an decoder function into Decoder.
Delimited defines the streaming delimiter.
Encoder encodes gRPC payloads / fields into byte sequence.
EncoderFunc adapts an encoder function into Encoder.
No description provided by the author
No description provided by the author
ForwardResponseFunc updates the outgoing gRPC request and the HTTP response.
HeaderMatcherFunc checks whether a header key should be forwarded to/from gRPC context.
Marshaler defines a conversion between byte sequence and gRPC payloads / fields.
MetadataAnnotatorFunc updates the outgoing gRPC request context based on the incoming HTTP request.
PanicHandlerFunc is a function that gets called when a panic is encountered.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WebsocketUpgradeFunc handles a protocol upgrade and creates a websocket connection.