HTTP_503_RESPONSE_VERBOSITY enumeration

The HTTP_503_RESPONSE_VERBOSITY enumeration defines the verbosity levels for a 503, service unavailable, error responses.

This structure must be used when setting or querying the HttpServer503ResponseProperty on a request queue.

Syntax


typedef enum  { 
  Http503ResponseVerbosityBasic,
  Http503ResponseVerbosityLimited,
  Http503ResponseVerbosityFull
} HTTP_503_RESPONSE_VERBOSITY, *PHTTP_503_RESPONSE_VERBOSITY;

Constants

Http503ResponseVerbosityBasic

A 503 response is not sent; the connection is reset. This is the default HTTP Server API behavior.

Http503ResponseVerbosityLimited

The HTTP Server API sends a 503 response with a "Service Unavailable" reason phrase.

Http503ResponseVerbosityFull

The HTTP Server API sends a 503 response with a detailed reason phrase.

Remarks

This enumeration is used in HttpSetRequestQueueProperty, and HttpQueryrequestQueueProperty to set and query the 503 response verbosity. The pPropertyInformation parameter points to a member of the HTTP_503_RESPONSE_VERBOSITY enumeration when the Property parameter is HttpServer503VerbosityProperty.

This enumeration defines the verbosity level for a request queue when sending 503 (Service Unavailable) error responses. Note that the 503 response level set using the HTTP_503_RESPONSE_VERBOSITY enumeration only affects the error responses generated internally by the HTTP Server API.

Note  Disclosing information about the state of the service to potentially unsafe clients may pose a security risk.
 

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Http.h

See also

HTTP Server API Version 2.0 Enumeration Types
HTTP_SERVER_PROPERTY
HttpSetRequestQueueProperty
HttpQueryRequestQueueProperty

 

 

Show: