HttpRequestHandler.hpp

This File On Github
Ask A Question

API: latest
module: oatpp
#include "oatpp/web/server/HttpRequestHandler.hpp"

HttpRequestHandler

HTTP request handler.

namespace oatpp { namespace web { namespace server { 
  class HttpRequestHandler {}
}}}

Typedefs

Type Name Summary
oatpp::web::protocol::http::Status Status Convenience typedef for oatpp::web::protocol::http::Status.
oatpp::web::protocol::http::Header Header Convenience typedef for oatpp::web::protocol::http::Header.
oatpp::web::protocol::http::Headers Headers Convenience typedef for oatpp::web::protocol::http::Headers.
oatpp::web::protocol::http::QueryParams QueryParams Convenience typedef for oatpp::web::protocol::http::QueryParams.
oatpp::web::protocol::http::incoming::Request IncomingRequest Convenience typedef for oatpp::web::protocol::http::incoming::Request.
oatpp::web::protocol::http::outgoing::Response OutgoingResponse Convenience typedef for oatpp::web::protocol::http::outgoing::Response.
oatpp::web::protocol::http::outgoing::ResponseFactory ResponseFactory Convenience typedef for oatpp::web::protocol::http::outgoing::ResponseFactory.
oatpp::web::protocol::http::HttpError HttpError Convenience typedef for oatpp::web::protocol::http::HttpError.

Methods

Return Type Name Summary
std::shared_ptr<OutgoingResponse> handle Handle incoming http request.
oatpp::async::CoroutineStarterForResult<const std::shared_ptr<OutgoingResponse>&> handleAsync Handle incoming http request in Asynchronous manner.
[none] ~HttpRequestHandler You have to provide a definition for destructors, otherwise its undefined behaviour.

HttpRequestHandler::Status

Convenience typedef for oatpp::web::protocol::http::Status.

typedef oatpp::web::protocol::http::Status Status

HttpRequestHandler::Header

Convenience typedef for oatpp::web::protocol::http::Header.

typedef oatpp::web::protocol::http::Header Header

HttpRequestHandler::Headers

Convenience typedef for oatpp::web::protocol::http::Headers.

typedef oatpp::web::protocol::http::Headers Headers

HttpRequestHandler::QueryParams

Convenience typedef for oatpp::web::protocol::http::QueryParams.

typedef oatpp::web::protocol::http::QueryParams QueryParams

HttpRequestHandler::IncomingRequest

Convenience typedef for oatpp::web::protocol::http::incoming::Request.

typedef oatpp::web::protocol::http::incoming::Request IncomingRequest

HttpRequestHandler::OutgoingResponse

Convenience typedef for oatpp::web::protocol::http::outgoing::Response.

typedef oatpp::web::protocol::http::outgoing::Response OutgoingResponse

HttpRequestHandler::ResponseFactory

Convenience typedef for oatpp::web::protocol::http::outgoing::ResponseFactory.

typedef oatpp::web::protocol::http::outgoing::ResponseFactory ResponseFactory

HttpRequestHandler::HttpError

Convenience typedef for oatpp::web::protocol::http::HttpError.

typedef oatpp::web::protocol::http::HttpError HttpError

HttpRequestHandler::handle

Handle incoming http request.
Implement this method.

virtual std::shared_ptr<OutgoingResponse> handle(const std::shared_ptr<IncomingRequest>& request)

HttpRequestHandler::handleAsync

Handle incoming http request in Asynchronous manner.
Implement this method.

virtual oatpp::async::CoroutineStarterForResult<const std::shared_ptr<OutgoingResponse>&>
handleAsync(const std::shared_ptr<IncomingRequest>& request)

HttpRequestHandler::~HttpRequestHandler

You have to provide a definition for destructors, otherwise its undefined behaviour.

virtual ~HttpRequestHandler() = default