web::http::server::SocketContext Class Reference

#include <SocketContext.h>

Inheritance diagram for web::http::server::SocketContext:

Collaboration diagram for web::http::server::SocketContext:

Public Member Functions
	SocketContext (core::socket::stream::SocketConnection *socketConnection, const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &onRequestReady)
SocketContext *	onConnected (std::function< void()> onConnectEventReceiver)
SocketContext *	onDisconnected (std::function< void()> onDisconnectEventReceiver)
Public Member Functions inherited from core::socket::stream::SocketContext
	SocketContext (core::socket::stream::SocketConnection *socketConnection)
void	sendToPeer (const char *chunk, std::size_t chunkLen) const final
bool	streamToPeer (core::pipe::Source *source) const
void	streamEof ()
std::size_t	readFromPeer (char *chunk, std::size_t chunklen) const final
void	setTimeout (const utils::Timeval &timeout) final
void	shutdownRead ()
void	shutdownWrite (bool forceClose=false)
void	close () override
std::size_t	getTotalSent () const override
std::size_t	getTotalQueued () const override
std::size_t	getTotalRead () const override
std::size_t	getTotalProcessed () const override
std::string	getOnlineSince () const override
std::string	getOnlineDuration () const override
SocketConnection *	getSocketConnection () const
void	sendToPeer (const std::string &data) const
Public Member Functions inherited from core::socket::SocketContext
	SocketContext (const SocketContext &)=delete
	SocketContext (SocketContext &&)=delete
SocketContext &	operator= (const SocketContext &)=delete
SocketContext &	operator= (SocketContext &&)=delete
void	sendToPeer (const std::string &data) const

Private Types
using	Super = core::socket::stream::SocketContext
using	Request = web::http::server::Request
using	Response = web::http::server::Response

Private Member Functions
void	deliverRequest ()
void	responseStarted (const Response &response)
void	responseCompleted (const Response &response, bool success)
void	requestCompleted (const Response &response)
void	onConnected () override
std::size_t	onReceivedFromPeer () override
void	onDisconnected () override
bool	onSignal (int signum) override
void	onWriteError (int errnum) override

Private Attributes
std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)>	onRequestReady
std::list< std::shared_ptr< Request > >	pendingRequests
std::shared_ptr< Response >	masterResponse
std::list< std::function< void()> >	onConnectEventReceiverList
std::list< std::function< void()> >	onDisconnectEventReceiverList
RequestParser	parser
bool	httpClose = false
bool	serverSentEvent = false
friend	Response

Additional Inherited Members
Protected Member Functions inherited from core::socket::stream::SocketContext
void	onReadError (int errnum) override
std::size_t	readFromPeer ()
Protected Member Functions inherited from core::socket::SocketContext
	SocketContext ()=default
virtual	~SocketContext ()

Detailed Description

Definition at line 68 of file SocketContext.h.

Member Typedef Documentation

Request

using web::http::server::SocketContext::Request = web::http::server::Request

private

Definition at line 72 of file SocketContext.h.

Response

using web::http::server::SocketContext::Response = web::http::server::Response

private

Definition at line 73 of file SocketContext.h.

Super

using web::http::server::SocketContext::Super = core::socket::stream::SocketContext

private

Definition at line 70 of file SocketContext.h.

Constructor & Destructor Documentation

SocketContext()

web::http::server::SocketContext::SocketContext	(	core::socket::stream::SocketConnection *	socketConnection,
		const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &	onRequestReady )

Definition at line 61 of file SocketContext.cpp.

        : Super(socketConnection)
        , onRequestReady(onRequestReady)
        , masterResponse(std::make_shared<Response>(this))
        , parser(
              this,
              [this]() {
                  LOG(INFO) << getSocketConnection()->getConnectionName() << " HTTP: Request start";
              },
              [this](web::http::server::Request&& request) {
                  LOG(INFO) << getSocketConnection()->getConnectionName() << " HTTP: Request parse success: " << request.method << " "
                            << request.url << " HTTP/" << request.httpMajor << "." << request.httpMinor;
 
                  pendingRequests.emplace_back(std::make_shared<Request>(std::move(request)));
 
                  if (pendingRequests.size() == 1) {
                      deliverRequest();
                  }
              },
              [this](int status, const std::string& reason) {
                  LOG(ERROR) << getSocketConnection()->getConnectionName() << " HTTP: Request parse error: " << reason << " (" << status
                             << ") ";
                  shutdownRead();
 
                  pendingRequests.emplace_back(std::make_shared<Request>(Request(status, reason)));
 
                  if (pendingRequests.size() == 1) {
                      deliverRequest();
                  }
              }) {
    }

References core::socket::stream::SocketConnection::getConnectionName(), core::socket::stream::SocketContext::getSocketConnection(), masterResponse, onRequestReady, parser, web::http::server::RequestParser::RequestParser(), and core::socket::stream::SocketContext::SocketContext().

Referenced by web::http::server::SocketContextFactory::create().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

deliverRequest()

void web::http::server::SocketContext::deliverRequest ( )

private

Definition at line 107 of file SocketContext.cpp.

                                       {
        if (!pendingRequests.empty()) {
            const std::shared_ptr<Request>& pendingRequest = pendingRequests.front();
 
            if (pendingRequest->status == 0) {
                LOG(INFO) << getSocketConnection()->getConnectionName() << " HTTP: Request deliver: " << pendingRequest->method << " "
                          << pendingRequest->url << " HTTP/" << pendingRequest->httpMajor << "." << pendingRequest->httpMinor;
 
                masterResponse->init();
                masterResponse->requestMethod = pendingRequest->method;
                masterResponse->httpMajor = pendingRequest->httpMajor;
                masterResponse->httpMinor = pendingRequest->httpMinor;
 
                const std::string connection = pendingRequest->get("Connection");
                if (!connection.empty()) {
                    masterResponse->set("Connection", connection);
                }
 
                onRequestReady(pendingRequest, masterResponse);
            } else {
                masterResponse->init();
                masterResponse->httpMajor = 1;
                masterResponse->httpMinor = 1;
 
                masterResponse->status(pendingRequest->status).send(pendingRequest->reason);
            }
        } else {
            LOG(INFO) << getSocketConnection()->getConnectionName() << " HTTP: No more pending request";
        }
    }

References web::http::server::Request::get(), core::socket::stream::SocketConnection::getConnectionName(), core::socket::stream::SocketContext::getSocketConnection(), web::http::server::Request::httpMajor, web::http::server::Response::httpMajor, web::http::server::Request::httpMinor, web::http::server::Response::httpMinor, web::http::server::Response::init(), masterResponse, web::http::server::Request::method, onRequestReady, pendingRequests, web::http::server::Request::reason, web::http::server::Response::requestMethod, web::http::server::Response::send(), web::http::server::Response::set(), web::http::server::Request::status, web::http::server::Response::status(), and web::http::server::Request::url.

Referenced by requestCompleted().

Here is the call graph for this function:

Here is the caller graph for this function:

onConnected() [1/2]

void web::http::server::SocketContext::onConnected ( )

overrideprivatevirtual

Implements core::socket::stream::SocketContext.

Definition at line 206 of file SocketContext.cpp.

                                    {
        LOG(INFO) << getSocketConnection()->getConnectionName() << " HTTP: Connected";
 
        for (auto& onConnectEventReceiver : onConnectEventReceiverList) {
            onConnectEventReceiver();
        }
    }

References core::socket::stream::SocketConnection::getConnectionName(), core::socket::stream::SocketContext::getSocketConnection(), and onConnectEventReceiverList.

Here is the call graph for this function:

onConnected() [2/2]

SocketContext * web::http::server::SocketContext::onConnected

(

std::function< void()>

onConnectEventReceiver

)

Definition at line 95 of file SocketContext.cpp.

                                                                                        {
        onConnectEventReceiverList.push_back(std::move(onConnectEventReceiver));
 
        return this;
    }

References onConnectEventReceiverList.

onDisconnected() [1/2]

void web::http::server::SocketContext::onDisconnected ( )

overrideprivatevirtual

Implements core::socket::stream::SocketContext.

Definition at line 224 of file SocketContext.cpp.

                                       {
        masterResponse->disconnect();
 
        LOG(INFO) << getSocketConnection()->getConnectionName() << " HTTP: Received disconnect";
 
        for (auto& onDisconnectEventReceiver : onDisconnectEventReceiverList) {
            onDisconnectEventReceiver();
        }
    }

References web::http::server::Response::disconnect(), core::socket::stream::SocketConnection::getConnectionName(), core::socket::stream::SocketContext::getSocketConnection(), masterResponse, and onDisconnectEventReceiverList.

Here is the call graph for this function:

onDisconnected() [2/2]

SocketContext * web::http::server::SocketContext::onDisconnected

(

std::function< void()>

onDisconnectEventReceiver

)

Definition at line 101 of file SocketContext.cpp.

                                                                                              {
        onDisconnectEventReceiverList.push_back(std::move(onDisconnectEventReceiver));
 
        return this;
    }

References onDisconnectEventReceiverList.

onReceivedFromPeer()

std::size_t web::http::server::SocketContext::onReceivedFromPeer ( )

overrideprivatevirtual

Implements core::socket::SocketContext.

Definition at line 214 of file SocketContext.cpp.

                                                {
        std::size_t consumed = 0;
 
        if (!serverSentEvent && !httpClose) {
            consumed = parser.parse();
        }
 
        return consumed;
    }

References httpClose, web::http::Parser::parse(), parser, and serverSentEvent.

Here is the call graph for this function:

onSignal()

bool web::http::server::SocketContext::onSignal ( int signum )

overrideprivatevirtual

Implements core::socket::SocketContext.

Definition at line 234 of file SocketContext.cpp.

                                           {
        LOG(INFO) << getSocketConnection()->getConnectionName() << " HTTP: Received signal " << signum;
 
        return true;
    }

References core::socket::stream::SocketConnection::getConnectionName(), and core::socket::stream::SocketContext::getSocketConnection().

Here is the call graph for this function:

onWriteError()

void web::http::server::SocketContext::onWriteError ( int errnum )

overrideprivatevirtual

Reimplemented from core::socket::stream::SocketContext.

Definition at line 240 of file SocketContext.cpp.

                                                                {
        // Do nothing in case of an write error
    }

requestCompleted()

void web::http::server::SocketContext::requestCompleted ( const Response & response )

private

Definition at line 172 of file SocketContext.cpp.

                                                                 {
        const std::shared_ptr<Request> request = std::move(pendingRequests.front());
        pendingRequests.pop_front();
 
        LOG(INFO) << getSocketConnection()->getConnectionName() << " HTTP: Response completed for request: " << request->method << " "
                  << request->url << " HTTP/" << request->httpMajor << "." << request->httpMinor;
        LOG(INFO) << getSocketConnection()->getConnectionName() << "   "
                  << "HTTP/" + std::to_string(response.httpMajor)
                                   .append(".")
                                   .append(std::to_string(response.httpMinor))
                                   .append(" ")
                                   .append(std::to_string(response.statusCode))
                                   .append(" ")
                                   .append(StatusCode::reason(response.statusCode));
 
        httpClose = response.connectionState == ConnectionState::Close ||
                    (response.connectionState == ConnectionState::Default &&
                     ((response.httpMajor == 0 && response.httpMinor == 9) || (response.httpMajor == 1 && response.httpMinor == 0)));
 
        if (httpClose) {
            LOG(DEBUG) << getSocketConnection()->getConnectionName() << " HTTP: Connection = Close";
        } else {
            LOG(DEBUG) << getSocketConnection()->getConnectionName() << " HTTP: Connection = Keep-Alive";
 
            if (!pendingRequests.empty()) {
                core::EventReceiver::atNextTick([this, response = std::weak_ptr<Response>(masterResponse)]() {
                    if (!response.expired()) {
                        deliverRequest();
                    }
                });
            }
        }
    }

References core::EventReceiver::atNextTick(), web::http::Close, web::http::server::Response::connectionState, web::http::Default, deliverRequest(), core::socket::stream::SocketConnection::getConnectionName(), core::socket::stream::SocketContext::getSocketConnection(), httpClose, web::http::server::Request::httpMajor, web::http::server::Response::httpMajor, web::http::server::Request::httpMinor, web::http::server::Response::httpMinor, masterResponse, web::http::server::Request::method, pendingRequests, web::http::StatusCode::reason(), web::http::server::Response::statusCode, and web::http::server::Request::url.

Referenced by responseCompleted().

Here is the call graph for this function:

Here is the caller graph for this function:

responseCompleted()

void web::http::server::SocketContext::responseCompleted ( const Response & response, bool success )

private

Definition at line 161 of file SocketContext.cpp.

                                                                                {
        if (success) {
            requestCompleted(response);
        } else {
            LOG(WARNING) << getSocketConnection()->getConnectionName() << " HTTP: Response completed with error: " << response.statusCode
                         << " " << StatusCode::reason(response.statusCode);
 
            shutdownWrite(true);
        }
    }

References core::socket::stream::SocketConnection::getConnectionName(), core::socket::stream::SocketContext::getSocketConnection(), web::http::StatusCode::reason(), requestCompleted(), core::socket::stream::SocketContext::shutdownWrite(), and web::http::server::Response::statusCode.

Referenced by web::http::server::Response::sendCompleted().

Here is the call graph for this function:

Here is the caller graph for this function:

responseStarted()

void web::http::server::SocketContext::responseStarted ( const Response & response )

private

Definition at line 138 of file SocketContext.cpp.

                                                                {
        if (!pendingRequests.empty()) {
            const std::shared_ptr<Request>& pendingRequest = pendingRequests.front();
 
            serverSentEvent = web::http::ciContains(pendingRequest->get("Accept"), "text/event-stream");
 
            if (serverSentEvent) {
                getSocketConnection()->setReadTimeout(0);
            }
 
            LOG(INFO) << getSocketConnection()->getConnectionName() << " HTTP: Response start for request: " << pendingRequest->method
                      << " " << pendingRequest->url << " HTTP/" << pendingRequest->httpMajor << "." << pendingRequest->httpMinor;
            LOG(INFO) << getSocketConnection()->getConnectionName() << "   "
                      << "HTTP/" + std::to_string(response.httpMajor)
                                       .append(".")
                                       .append(std::to_string(response.httpMinor))
                                       .append(" ")
                                       .append(std::to_string(response.statusCode))
                                       .append(" ")
                                       .append(StatusCode::reason(response.statusCode));
        }
    }

References web::http::ciContains(), web::http::server::Request::get(), core::socket::stream::SocketConnection::getConnectionName(), core::socket::stream::SocketContext::getSocketConnection(), web::http::server::Request::httpMajor, web::http::server::Response::httpMajor, web::http::server::Request::httpMinor, web::http::server::Response::httpMinor, web::http::server::Request::method, pendingRequests, web::http::StatusCode::reason(), serverSentEvent, core::socket::stream::SocketConnection::setReadTimeout(), web::http::server::Response::statusCode, and web::http::server::Request::url.

Referenced by web::http::server::Response::sendHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

httpClose

bool web::http::server::SocketContext::httpClose = false

private

Definition at line 105 of file SocketContext.h.

Referenced by onReceivedFromPeer(), and requestCompleted().

masterResponse

std::shared_ptr<Response> web::http::server::SocketContext::masterResponse

private

Definition at line 98 of file SocketContext.h.

Referenced by deliverRequest(), onDisconnected(), requestCompleted(), and SocketContext().

onConnectEventReceiverList

std::list<std::function<void()> > web::http::server::SocketContext::onConnectEventReceiverList

private

Definition at line 100 of file SocketContext.h.

Referenced by onConnected(), and onConnected().

onDisconnectEventReceiverList

std::list<std::function<void()> > web::http::server::SocketContext::onDisconnectEventReceiverList

private

Definition at line 101 of file SocketContext.h.

Referenced by onDisconnected(), and onDisconnected().

onRequestReady

std::function<void(const std::shared_ptr<Request>&, const std::shared_ptr<Response>&)> web::http::server::SocketContext::onRequestReady

private

Definition at line 89 of file SocketContext.h.

Referenced by deliverRequest(), and SocketContext().

parser

RequestParser web::http::server::SocketContext::parser

private

Definition at line 103 of file SocketContext.h.

Referenced by onReceivedFromPeer(), and SocketContext().

pendingRequests

std::list<std::shared_ptr<Request> > web::http::server::SocketContext::pendingRequests

private

Definition at line 97 of file SocketContext.h.

Referenced by deliverRequest(), requestCompleted(), and responseStarted().

Response

friend web::http::server::SocketContext::Response

private

Definition at line 108 of file SocketContext.h.

serverSentEvent

bool web::http::server::SocketContext::serverSentEvent = false

private

Definition at line 106 of file SocketContext.h.

Referenced by onReceivedFromPeer(), and responseStarted().

---

The documentation for this class was generated from the following files:

• web/http/server/SocketContext.h
• web/http/server/SocketContext.cpp