SC::HttpConnection Struct Reference

Http connection abstraction holding both the incoming and outgoing messages in an HTTP transaction. More...

#include <HttpConnection.h>

Inheritance diagram for SC::HttpConnection:

Classes
struct	ID

Public Member Functions
void	reset ()
	Prepare this client for re-use, marking it as Inactive.
ID	getConnectionID () const
	The ID used to find this client in HttpConnectionsPool.
void	markWebSocketUpgraded ()
	Marks this HTTP connection as handed off to a WebSocket owner after a successful upgrade.
bool	isWebSocketUpgraded () const
	Returns true after the HTTP layer handed this connection to WebSocket code.
Result	sendBodyCopy (int httpCode, StringSpan body, StringSpan contentType={})
	Sends a fixed-size response body by copying it into this connection's async buffer pool.
Result	sendTextCopy (int httpCode, StringSpan body)
	Sends a text/plain; charset=utf-8 response body by copying it into this connection's async buffer pool.
Result	sendJsonCopy (int httpCode, StringSpan body)
	Sends an application/json response body by copying it into this connection's async buffer pool.
Public Member Functions inherited from SC::HttpConnectionBase
void	setHeaderMemory (Span< char > memory)
Span< char >	getHeaderMemory () const
void	setTransportStreams (AsyncReadableStream &readable, AsyncWritableStream &writable)
void	resetTransportStreams ()
AsyncReadableStream &	getReadableTransportStream ()
AsyncWritableStream &	getWritableTransportStream ()
const AsyncReadableStream &	getReadableTransportStream () const
const AsyncWritableStream &	getWritableTransportStream () const
void	reset ()

Public Attributes
HttpRequest	request
HttpResponse	response
uint32_t	requestCount = 0
	Number of requests processed on this connection.
Public Attributes inherited from SC::HttpConnectionBase
ReadableSocketStream	readableSocketStream
WritableSocketStream	writableSocketStream
AsyncBuffersPool	buffersPool
AsyncPipeline	pipeline
SocketDescriptor	socket

Protected Types
enum class	State {   Inactive ,   Active }

Protected Attributes
State	state = State::Inactive
ID	connectionID
bool	webSocketUpgraded = false
Protected Attributes inherited from SC::HttpConnectionBase
Span< char >	headerMemory

Friends
struct	HttpConnectionsPool
struct	HttpAsyncServer

Additional Inherited Members
Public Types inherited from SC::HttpConnectionBase
using	ReadableSocketStream = AsyncReadableSocketStream<AsyncEventLoop>
using	WritableSocketStream = AsyncWritableSocketStream<AsyncEventLoop>

Detailed Description

Http connection abstraction holding both the incoming and outgoing messages in an HTTP transaction.

Member Function Documentation

getConnectionID()

ID SC::HttpConnection::getConnectionID ( ) const

inline

The ID used to find this client in HttpConnectionsPool.

isWebSocketUpgraded()

bool SC::HttpConnection::isWebSocketUpgraded ( ) const

inlinenodiscard

Returns true after the HTTP layer handed this connection to WebSocket code.

markWebSocketUpgraded()

void SC::HttpConnection::markWebSocketUpgraded ( )

inline

Marks this HTTP connection as handed off to a WebSocket owner after a successful upgrade.

reset()

void SC::HttpConnection::reset

(

)

Prepare this client for re-use, marking it as Inactive.

sendBodyCopy()

Result SC::HttpConnection::sendBodyCopy	(	int	httpCode,
		StringSpan	body,
		StringSpan	contentType = {} )

Sends a fixed-size response body by copying it into this connection's async buffer pool.

sendJsonCopy()

Result SC::HttpConnection::sendJsonCopy	(	int	httpCode,
		StringSpan	body )

Sends an application/json response body by copying it into this connection's async buffer pool.

sendTextCopy()

Result SC::HttpConnection::sendTextCopy	(	int	httpCode,
		StringSpan	body )

Sends a text/plain; charset=utf-8 response body by copying it into this connection's async buffer pool.

Member Data Documentation

requestCount

uint32_t SC::HttpConnection::requestCount = 0

Number of requests processed on this connection.

---

The documentation for this struct was generated from the following file:

• HttpConnection.h