[#HTTPRemoteClient]
= HTTPRemoteClient
:mrdocs:

A connected HTTP client, holding its socket plus the receive and send buffers.

== Synopsis

Declared in `<httpserver.h>`

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

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:HTTPRemoteClient/2constructor-01.adoc[`HTTPRemoteClient`]         [.small]#[constructor]#
| Constructors
| xref:HTTPRemoteClient/operator_assign.adoc[`operator=`]  [.small]#[deleted]#
| Deleted copy assignment; clients are only used through shared pointers.
| xref:HTTPRemoteClient/GetOrigin.adoc[`GetOrigin`] 
| Returns the cached origin string of the connected peer.
| xref:HTTPRemoteClient/GetPeer.adoc[`GetPeer`] 
| Returns the address of the connected peer.
| xref:HTTPRemoteClient/GetRecvBuffer.adoc[`GetRecvBuffer`] 
| Used for tests. @{ Read the client's receive buffer.
| xref:HTTPRemoteClient/GetRequest.adoc[`GetRequest`] 
| Access the request currently being parsed.
| xref:HTTPRemoteClient/GetSock.adoc[`GetSock`] 
| Returns the client's underlying socket.
| xref:HTTPRemoteClient/MaybeDisconnect.adoc[`MaybeDisconnect`] 
| Flag the client for disconnection if it is idle past the timeout or a global disconnect is requested.
| xref:HTTPRemoteClient/MaybeSendBytesFromBuffer.adoc[`MaybeSendBytesFromBuffer`] 
| Push data (if there is any) from client's m_send_buffer to the connected socket.
| xref:HTTPRemoteClient/ReadyToSend.adoc[`ReadyToSend`] 
| Returns whether the client has response data ready to send.
| xref:HTTPRemoteClient/Receive.adoc[`Receive`] 
| Read available bytes from the socket into the receive buffer.
| xref:HTTPRemoteClient/Send.adoc[`Send`] 
| Queue a response to be written to the client's socket.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:HTTPRemoteClient/TryReadRequest.adoc[`TryReadRequest`] 
| Try to read an HTTPRequest from a client's receive buffer. Only complete requests are returned, incomplete requests are left in the buffer to wait for more data. Some read errors will mark this client for disconnection.
|===


== Protected Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:HTTPRemoteClient/MutateRecvBuffer.adoc[`MutateRecvBuffer`] 
| Used for tests.
|===



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