web::http::client::SocketContext Class Reference

#include <SocketContext.h>

Inheritance diagram for web::http::client::SocketContext:

Collaboration diagram for web::http::client::SocketContext:

Public Member Functions
	SocketContext (core::socket::stream::SocketConnection *socketConnection, const std::function< void(const std::shared_ptr< Request > &)> &onRequestBegin, const std::function< void(const std::shared_ptr< Request > &)> &onRequestEnd, bool pipelinedRequests)
	~SocketContext () override
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
SocketConnection *	getSocketConnection () const
virtual void	switchSocketContext (SocketContext *newSocketContext)
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
enum	Flags {   NONE = 0b00000000 , HTTP10 = 0b00000001 , HTTP11 = 0b00000010 , KEEPALIVE = 0b00000100 ,   CLOSE = 0b00001000 }
using	Super = core::socket::stream::SocketContext
using	Request = web::http::client::Request
using	Response = web::http::client::Response

Private Member Functions
void	requestPrepared (Request &&request)
void	initiateRequest (Request &request)
void	requestDelivered (Request &&request, bool success)
void	responseStarted ()
void	deliverResponse (Response &&response)
void	deliverResponseParseError (int status, const std::string &reason)
void	responseDelivered (bool httpClose)
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 > &)>	onRequestBegin
std::function< void(const std::shared_ptr< Request > &)>	onRequestEnd
std::list< Request >	pendingRequests
std::list< Request >	deliveredRequests
bool	pipelinedRequests = false
std::shared_ptr< Request >	currentRequest = nullptr
std::shared_ptr< Request >	masterRequest
ResponseParser	parser
int	flags = Flags::NONE

Friends
class	web::http::client::Request

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

Detailed Description

Definition at line 43 of file SocketContext.h.

Member Typedef Documentation

Request

using web::http::client::SocketContext::Request = web::http::client::Request

private

Definition at line 47 of file SocketContext.h.

Response

using web::http::client::SocketContext::Response = web::http::client::Response

private

Definition at line 48 of file SocketContext.h.

Super

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

private

Definition at line 45 of file SocketContext.h.

Member Enumeration Documentation

Flags

enum web::http::client::SocketContext::Flags

private

Enumerator
NONE
HTTP10
HTTP11
KEEPALIVE
CLOSE

Definition at line 86 of file SocketContext.h.

                   { //
            NONE = 0b00000000,
            HTTP10 = 0b00000001,
            HTTP11 = 0b00000010,
            KEEPALIVE = 0b00000100,
            CLOSE = 0b00001000
        };

Constructor & Destructor Documentation

SocketContext()

web::http::client::SocketContext::SocketContext	(	core::socket::stream::SocketConnection *	socketConnection,
		const std::function< void(const std::shared_ptr< Request > &)> &	onRequestBegin,
		const std::function< void(const std::shared_ptr< Request > &)> &	onRequestEnd,
		bool	pipelinedRequests )

Definition at line 39 of file SocketContext.cpp.

        : Super(socketConnection)
        , onRequestBegin(onRequestBegin)
        , onRequestEnd(onRequestEnd)
        , pipelinedRequests(pipelinedRequests)
        , masterRequest(std::make_shared<Request>(this, getSocketConnection()->getConfiguredServer()))
        , parser(
              this,
              [this]() {
                  responseStarted();
              },
              [this](web::http::client::Response&& response) {
                  LOG(INFO) << getSocketConnection()->getConnectionName() << " HTTP: Response parsed: HTTP/" << response.httpMajor << "."
                            << response.httpMinor << " " << response.statusCode << " " << response.reason;
 
                  deliverResponse(std::move(response));
              },
              [this](int status, const std::string& reason) {
                  deliverResponseParseError(status, reason);
              }) {
        masterRequest->setMasterRequest(masterRequest);
    }

References pipelinedRequests, and SocketContext().

Referenced by SocketContext().

Here is the call graph for this function:

Here is the caller graph for this function:

~SocketContext()

web::http::client::SocketContext::~SocketContext ( )

overridevirtual

Reimplemented from core::socket::SocketContext.

Definition at line 65 of file SocketContext.cpp.

                                  {
        if (!deliveredRequests.empty()) {
            LOG(DEBUG) << getSocketConnection()->getConnectionName() << " HTTP: Responses missed";
            for (const Request& request : deliveredRequests) {
                LOG(DEBUG) << "  " << request.method << " " << request.url << " HTTP/" << request.httpMajor << "." << request.httpMinor;
            }
        }
 
        if (!pendingRequests.empty()) {
            LOG(DEBUG) << getSocketConnection()->getConnectionName() << " HTTP: Requests ignored";
            for (const Request& request : pendingRequests) {
                LOG(DEBUG) << "  " << request.method << " " << request.url << " HTTP/" << request.httpMajor << "." << request.httpMinor;
            }
        }
    }

Member Function Documentation

deliverResponse()

void web::http::client::SocketContext::deliverResponse ( Response && response )

private

Definition at line 201 of file SocketContext.cpp.

                                                           {
        const std::shared_ptr<Request> request = std::make_shared<Request>(std::move(deliveredRequests.front()));
        deliveredRequests.pop_front();
 
        const std::string requestLine = std::string(request->method)
                                            .append(" ")
                                            .append(request->url)
                                            .append(" HTTP/")
                                            .append(std::to_string(request->httpMajor))
                                            .append(".")
                                            .append(std::to_string(request->httpMinor));
 
        LOG(INFO) << getSocketConnection()->getConnectionName() << " HTTP: Response ready: " << requestLine;
 
        const bool httpClose =
            response.connectionState == ConnectionState::Close ||
            (response.connectionState == ConnectionState::Default &&
             ((response.httpMajor == 0 && response.httpMinor == 9) || (response.httpMajor == 1 && response.httpMinor == 0)));
 
        request->deliverResponse(request, std::make_shared<Response>(std::move(response)));
 
        responseDelivered(httpClose);
 
        LOG(INFO) << getSocketConnection()->getConnectionName() << " HTTP: Response completed: " << requestLine;
    }

References responseDelivered().

Here is the call graph for this function:

deliverResponseParseError()

void web::http::client::SocketContext::deliverResponseParseError ( int status, const std::string & reason )

private

Definition at line 227 of file SocketContext.cpp.

                                                                                     {
        const std::shared_ptr<Request> request = std::make_shared<Request>(std::move(deliveredRequests.front()));
        deliveredRequests.pop_front();
 
        LOG(WARNING) << getSocketConnection()->getConnectionName() << " HTTP: Response parse error: " << reason << " (" << status << ") "
                     << std::string(request->method)
                            .append(" ")
                            .append(request->url)
                            .append(" HTTP/")
                            .append(std::to_string(request->httpMajor))
                            .append(".")
                            .append(std::to_string(request->httpMinor));
 
        request->deliverResponseParseError(request, reason);
 
        shutdownWrite(true);
    }

initiateRequest()

void web::http::client::SocketContext::initiateRequest ( Request & request )

private

Definition at line 112 of file SocketContext.cpp.

                                                        {
        currentRequest = std::make_shared<Request>(std::move(request));
 
        const std::string requestLine = std::string(currentRequest->method)
                                            .append(" ")
                                            .append(currentRequest->url)
                                            .append(" HTTP/")
                                            .append(std::to_string(currentRequest->httpMajor))
                                            .append(".")
                                            .append(std::to_string(currentRequest->httpMinor));
 
        LOG(DEBUG) << getSocketConnection()->getConnectionName() << " HTTP: Request delivering: " << requestLine;
 
        if (!currentRequest->initiate()) {
            LOG(WARNING) << getSocketConnection()->getConnectionName() << " HTTP: Request delivering failed: " << requestLine;
 
            core::EventReceiver::atNextTick([this, masterRequest = static_cast<std::weak_ptr<Request>>(masterRequest)]() {
                if (!masterRequest.expired()) {
                    if (!pendingRequests.empty()) {
                        Request& request = pendingRequests.front();
 
                        LOG(DEBUG) << getSocketConnection()->getConnectionName() << " HTTP: Request dequeued: " << request.method << " "
                                   << request.url << " HTTP/" << request.httpMajor << "." << request.httpMinor;
 
                        initiateRequest(request);
                        pendingRequests.pop_front();
                    } else {
                        currentRequest = nullptr;
                    }
                }
            });
        }
    }

Referenced by requestPrepared().

Here is the caller graph for this function:

onConnected()

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

overrideprivatevirtual

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

Definition at line 271 of file SocketContext.cpp.

                                    {
        LOG(INFO) << getSocketConnection()->getConnectionName() << " HTTP: connected";
 
        onRequestBegin(masterRequest);
    }

onDisconnected()

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

overrideprivatevirtual

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

Definition at line 287 of file SocketContext.cpp.

                                       {
        if (!deliveredRequests.empty()) {
            const Request& request = deliveredRequests.front();
            if (request.httpMajor == 1 && request.httpMinor == 0) {
                deliverResponse(parser.getResponse());
            }
        }
 
        onRequestEnd(masterRequest);
 
        LOG(INFO) << getSocketConnection()->getConnectionName() << " HTTP: disconnected";
    }

References web::http::client::Request::httpMajor, and web::http::client::Request::httpMinor.

onReceivedFromPeer()

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

overrideprivatevirtual

Implements core::socket::SocketContext.

Definition at line 277 of file SocketContext.cpp.

                                                {
        std::size_t consumed = 0;
 
        if (!deliveredRequests.empty()) {
            consumed = parser.parse();
        }
 
        return consumed;
    }

onSignal()

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

overrideprivatevirtual

Implements core::socket::SocketContext.

Definition at line 300 of file SocketContext.cpp.

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

onWriteError()

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

overrideprivatevirtual

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

Definition at line 306 of file SocketContext.cpp.

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

requestDelivered()

void web::http::client::SocketContext::requestDelivered ( Request && request, bool success )

private

Definition at line 146 of file SocketContext.cpp.

                                                                        {
        const std::string requestLine = std::string(request.method)
                                            .append(" ")
                                            .append(request.url)
                                            .append(" HTTP/")
                                            .append(std::to_string(request.httpMajor))
                                            .append(".")
                                            .append(std::to_string(request.httpMinor));
 
        if (success) {
            LOG(DEBUG) << getSocketConnection()->getConnectionName() << " HTTP: Request delivered: " << requestLine;
 
            deliveredRequests.emplace_back(std::move(request));
 
            if (pipelinedRequests) {
                core::EventReceiver::atNextTick([this, masterRequest = static_cast<std::weak_ptr<Request>>(masterRequest)]() {
                    if (!masterRequest.expired()) {
                        if (!pendingRequests.empty()) {
                            Request& request = pendingRequests.front();
 
                            LOG(DEBUG) << getSocketConnection()->getConnectionName() << " HTTP: Request dequeued: " << request.method << " "
                                       << request.url << " HTTP/" << request.httpMajor << "." << request.httpMinor;
 
                            initiateRequest(request);
                            pendingRequests.pop_front();
                        } else {
                            currentRequest = nullptr;
                        }
                    }
                });
            }
        } else {
            LOG(WARNING) << getSocketConnection()->getConnectionName() << " HTTP: Request delivering failed: " << requestLine;
 
            shutdownWrite();
        }
    }

References pipelinedRequests.

requestPrepared()

void web::http::client::SocketContext::requestPrepared ( Request && request )

private

Definition at line 81 of file SocketContext.cpp.

                                                         {
        const std::string requestLine = std::string(request.method)
                                            .append(" ")
                                            .append(request.url)
                                            .append(" HTTP/")
                                            .append(std::to_string(request.httpMajor))
                                            .append(".")
                                            .append(std::to_string(request.httpMinor));
 
        if ((flags == Flags::NONE || (flags & Flags::HTTP11) == Flags::HTTP11 || (flags & Flags::KEEPALIVE) == Flags::KEEPALIVE) &&
            (flags & Flags::CLOSE) != Flags::CLOSE) {
            LOG(INFO) << getSocketConnection()->getConnectionName() << " HTTP: Request accepted: " << requestLine;
 
            flags = (flags & ~Flags::HTTP11) | ((request.httpMajor == 1 && request.httpMinor == 1) ? Flags::HTTP11 : Flags::NONE);
            flags = (flags & ~Flags::HTTP10) | ((request.httpMajor == 1 && request.httpMinor == 0) ? Flags::HTTP10 : Flags::NONE);
            flags = (flags & ~Flags::KEEPALIVE) |
                    (web::http::ciContains(request.header("Connection"), "keep-alive") ? Flags::KEEPALIVE : Flags::NONE);
            flags = (flags & ~Flags::CLOSE) | (web::http::ciContains(request.header("Connection"), "close") ? Flags::CLOSE : Flags::NONE);
 
            if (!currentRequest) {
                initiateRequest(request);
            } else {
                LOG(DEBUG) << getSocketConnection()->getConnectionName() << " HTTP: Request queued: " << requestLine;
 
                pendingRequests.emplace_back(std::move(request));
            }
        } else {
            LOG(WARNING) << getSocketConnection()->getConnectionName() << " HTTP: Request rejected: " << requestLine;
        }
    }

References CLOSE, flags, HTTP10, HTTP11, web::http::client::Request::httpMajor, web::http::client::Request::httpMinor, initiateRequest(), KEEPALIVE, and NONE.

Here is the call graph for this function:

responseDelivered()

void web::http::client::SocketContext::responseDelivered ( bool httpClose )

private

Definition at line 245 of file SocketContext.cpp.

                                                        {
        if (httpClose) {
            LOG(DEBUG) << getSocketConnection()->getConnectionName() << " HTTP: Connection = Close";
        } else {
            LOG(DEBUG) << getSocketConnection()->getConnectionName() << " HTTP: Connection = Keep-Alive";
 
            if (!pipelinedRequests) {
                core::EventReceiver::atNextTick([this, masterRequest = static_cast<std::weak_ptr<Request>>(masterRequest)]() {
                    if (!masterRequest.expired()) {
                        if (!pendingRequests.empty()) {
                            Request& request = pendingRequests.front();
 
                            LOG(DEBUG) << getSocketConnection()->getConnectionName() << " HTTP: Request dequeued: " << request.method << " "
                                       << request.url << " HTTP/" << request.httpMajor << "." << request.httpMinor;
 
                            initiateRequest(request);
                            pendingRequests.pop_front();
                        } else {
                            currentRequest = nullptr;
                        }
                    }
                });
            }
        }
    }

References pipelinedRequests.

Referenced by deliverResponse().

Here is the caller graph for this function:

responseStarted()

void web::http::client::SocketContext::responseStarted ( )

private

Definition at line 184 of file SocketContext.cpp.

                                        {
        if (!deliveredRequests.empty()) {
            const std::string requestLine = std::string(deliveredRequests.front().method)
                                                .append(" ")
                                                .append(deliveredRequests.front().url)
                                                .append(" HTTP/")
                                                .append(std::to_string(deliveredRequests.front().httpMajor))
                                                .append(".")
                                                .append(std::to_string(deliveredRequests.front().httpMinor));
 
            LOG(INFO) << getSocketConnection()->getConnectionName() << " HTTP: Response started: " << requestLine;
        } else {
            LOG(ERROR) << getSocketConnection()->getConnectionName() << " HTTP: Response without delivered request";
            shutdownWrite(true);
        }
    }

Friends And Related Symbol Documentation

web::http::client::Request

friend class web::http::client::Request

friend

Definition at line 95 of file SocketContext.h.

Member Data Documentation

currentRequest

std::shared_ptr<Request> web::http::client::SocketContext::currentRequest = nullptr

private

Definition at line 81 of file SocketContext.h.

deliveredRequests

std::list<Request> web::http::client::SocketContext::deliveredRequests

private

Definition at line 77 of file SocketContext.h.

flags

int web::http::client::SocketContext::flags = Flags::NONE

private

Definition at line 93 of file SocketContext.h.

Referenced by requestPrepared().

masterRequest

std::shared_ptr<Request> web::http::client::SocketContext::masterRequest

private

Definition at line 82 of file SocketContext.h.

onRequestBegin

std::function<void(const std::shared_ptr<Request>&)> web::http::client::SocketContext::onRequestBegin

private

Definition at line 67 of file SocketContext.h.

onRequestEnd

std::function<void(const std::shared_ptr<Request>&)> web::http::client::SocketContext::onRequestEnd

private

Definition at line 68 of file SocketContext.h.

parser

ResponseParser web::http::client::SocketContext::parser

private

Definition at line 84 of file SocketContext.h.

pendingRequests

std::list<Request> web::http::client::SocketContext::pendingRequests

private

Definition at line 76 of file SocketContext.h.

pipelinedRequests

bool web::http::client::SocketContext::pipelinedRequests = false

private

Definition at line 79 of file SocketContext.h.

Referenced by requestDelivered(), responseDelivered(), and SocketContext().

---

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

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