Bitcoin Core  0.15.99
P2P Digital Currency
Public Types | Public Member Functions | Private Attributes | List of all members
HTTPRequest Class Reference

In-flight HTTP request. More...

#include <httpserver.h>

Public Types

enum  RequestMethod {

Public Member Functions

 HTTPRequest (struct evhttp_request *req)
 ~HTTPRequest ()
std::string GetURI () const
 Get requested URI. More...
CService GetPeer () const
 Get CService (address:ip) for the origin of the http request. More...
RequestMethod GetRequestMethod () const
 Get request method. More...
std::pair< bool, std::string > GetHeader (const std::string &hdr) const
 Get the request header specified by hdr, or an empty string. More...
std::string ReadBody ()
 Read request body. More...
void WriteHeader (const std::string &hdr, const std::string &value)
 Write output header. More...
void WriteReply (int nStatus, const std::string &strReply="")
 Write HTTP reply. More...

Private Attributes

struct evhttp_request * req
bool replySent

Detailed Description

In-flight HTTP request.

Thin C++ wrapper around evhttp_request.

Definition at line 57 of file httpserver.h.

Member Enumeration Documentation

◆ RequestMethod


Definition at line 67 of file httpserver.h.

Constructor & Destructor Documentation

◆ HTTPRequest()

HTTPRequest::HTTPRequest ( struct evhttp_request *  req)

Definition at line 512 of file httpserver.cpp.

◆ ~HTTPRequest()

HTTPRequest::~HTTPRequest ( )

Definition at line 516 of file httpserver.cpp.

Member Function Documentation

◆ GetHeader()

std::pair< bool, std::string > HTTPRequest::GetHeader ( const std::string &  hdr) const

Get the request header specified by hdr, or an empty string.

Return a pair (isPresent,string).

Definition at line 526 of file httpserver.cpp.

◆ GetPeer()

CService HTTPRequest::GetPeer ( ) const

Get CService (address:ip) for the origin of the http request.

Definition at line 599 of file httpserver.cpp.

Here is the call graph for this function:

◆ GetRequestMethod()

HTTPRequest::RequestMethod HTTPRequest::GetRequestMethod ( ) const

Get request method.

Definition at line 618 of file httpserver.cpp.

◆ GetURI()

std::string HTTPRequest::GetURI ( ) const

Get requested URI.

Definition at line 613 of file httpserver.cpp.

◆ ReadBody()

std::string HTTPRequest::ReadBody ( )

Read request body.

As this consumes the underlying buffer, call this only once. Repeated calls will return an empty string.

Trivial implementation: if this is ever a performance bottleneck, internal copying can be avoided in multi-segment buffers by using evbuffer_peek and an awkward loop. Though in that case, it'd be even better to not copy into an intermediate string but use a stream abstraction to consume the evbuffer on the fly in the parsing algorithm.

Definition at line 537 of file httpserver.cpp.

◆ WriteHeader()

void HTTPRequest::WriteHeader ( const std::string &  hdr,
const std::string &  value 

Write output header.

call this before calling WriteErrorReply or Reply.

Definition at line 557 of file httpserver.cpp.

Here is the caller graph for this function:

◆ WriteReply()

void HTTPRequest::WriteReply ( int  nStatus,
const std::string &  strReply = "" 

Write HTTP reply.

Closure sent to main thread to request a reply to be sent to a HTTP request.

nStatus is the HTTP status code to send. strReply is the body of the reply. Keep it empty to send a standard message.

Can be called only once. As this will give the request back to the main thread, do not call any other HTTPRequest methods after calling this.

Replies must be sent in the main loop in the main http thread, this cannot be done from worker threads.

Definition at line 569 of file httpserver.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ replySent

bool HTTPRequest::replySent

Definition at line 61 of file httpserver.h.

◆ req

struct evhttp_request* HTTPRequest::req

Definition at line 60 of file httpserver.h.

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