[#HTTPRequest]
= HTTPRequest
:mrdocs:

A single HTTP request being parsed from and replied to over a client connection.

== Synopsis

Declared in `<httpserver.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class HTTPRequest;
----

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:HTTPRequest/State.adoc[`State`] 
| Stage of request parsing, tracking how much of the request has been read.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:HTTPRequest/2constructor-05.adoc[`HTTPRequest`]         [.small]#[constructor]#
| Constructors
| xref:HTTPRequest/GetChunkProgress.adoc[`GetChunkProgress`] 
| Returns how many bytes of the current chunk have been read.
| xref:HTTPRequest/GetChunkSize.adoc[`GetChunkSize`] 
| Returns the size of the current chunk when using chunked transfer encoding.
| xref:HTTPRequest/GetClient.adoc[`GetClient`] 
| Returns the client connection this request arrived on.
| xref:HTTPRequest/GetHeader.adoc[`GetHeader`] 
| Look up a request header value.
| xref:HTTPRequest/GetPeer.adoc[`GetPeer`] 
| Returns the address of the peer that sent the request.
| xref:HTTPRequest/GetQueryParameter.adoc[`GetQueryParameter`] 
| Look up a query‐string parameter from the request target.
| xref:HTTPRequest/GetRequestMethod.adoc[`GetRequestMethod`] 
| Returns the HTTP method of the request.
| xref:HTTPRequest/GetState.adoc[`GetState`] 
| Returns the current parsing state of the request.
| xref:HTTPRequest/GetURI.adoc[`GetURI`] 
| Returns the request target (URI) of the request.
| xref:HTTPRequest/GetVersion.adoc[`GetVersion`] 
| Returns the HTTP protocol version of the request.
| xref:HTTPRequest/LoadBody.adoc[`LoadBody`] 
| Parse the request body from the receive buffer.
| xref:HTTPRequest/LoadControlData.adoc[`LoadControlData`] 
| Methods that attempt to parse HTTP request fields line‐by‐line from a receive buffer.
| xref:HTTPRequest/LoadHeaders.adoc[`LoadHeaders`] 
| Parse the request line's headers section from the receive buffer.
| xref:HTTPRequest/ReadBody.adoc[`ReadBody`] 
| Returns the request body read so far.
| xref:HTTPRequest/SetState.adoc[`SetState`] 
| Set the current parsing state of the request.
| xref:HTTPRequest/WriteHeader.adoc[`WriteHeader`] 
| Set a header to be included in the response.
| xref:HTTPRequest/WriteReply-06.adoc[`WriteReply`] 
| `WriteReply` overloads
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#