proxygen: proxygen::HTTPEvent Class Reference

#include <HTTPEvent.h>

Public Types
enum	Type : uint8_t { Type::MESSAGE_BEGIN, Type::HEADERS_COMPLETE, Type::BODY, Type::CHUNK_HEADER, Type::CHUNK_COMPLETE, Type::TRAILERS_COMPLETE, Type::MESSAGE_COMPLETE, Type::UPGRADE }

Public Member Functions
	HTTPEvent (HTTPCodec::StreamID streamID, Type event, bool upgrade=false)

	HTTPEvent (HTTPCodec::StreamID streamID, Type event, size_t length)

	HTTPEvent (HTTPCodec::StreamID streamID, Type event, std::unique_ptr< HTTPMessage > headers)

	HTTPEvent (HTTPCodec::StreamID streamID, Type event, std::unique_ptr< folly::IOBuf > body)

	HTTPEvent (HTTPCodec::StreamID streamID, Type event, std::unique_ptr< HTTPHeaders > trailers)

	HTTPEvent (HTTPCodec::StreamID streamID, Type event, std::unique_ptr< HTTPException > error)

	HTTPEvent (HTTPCodec::StreamID streamID, Type event, UpgradeProtocol protocol)

Type	getEvent () const

HTTPCodec::StreamID	getStreamID () const

std::unique_ptr< HTTPMessage >	getHeaders ()

std::unique_ptr< folly::IOBuf >	getBody ()

std::unique_ptr< HTTPException >	getError ()

bool	isUpgrade () const

size_t	getChunkLength () const

std::unique_ptr< HTTPHeaders >	getTrailers ()

UpgradeProtocol	getUpgradeProtocol ()

Private Attributes
std::unique_ptr< HTTPMessage >	headers_

std::unique_ptr< folly::IOBuf >	body_

std::unique_ptr< HTTPHeaders >	trailers_

std::unique_ptr< HTTPException >	error_

HTTPCodec::StreamID	streamID_

size_t	length_

Type	event_

bool	upgrade_

UpgradeProtocol	protocol_

Detailed Description

Helper class that holds some event in the lifecycle of an HTTP request or response.

The main use for this class is to queue up events in situations where the code handling events isn't able to process them and the thing generating events isn't able to stop.

Definition at line 27 of file HTTPEvent.h.

Member Enumeration Documentation

enum proxygen::HTTPEvent::Type : uint8_t

strong

Enumerator
MESSAGE_BEGIN
HEADERS_COMPLETE
BODY
CHUNK_HEADER
CHUNK_COMPLETE
TRAILERS_COMPLETE
MESSAGE_COMPLETE
UPGRADE

Definition at line 29 of file HTTPEvent.h.

                  : uint8_t {
     // Ingress events
     MESSAGE_BEGIN,
     HEADERS_COMPLETE,
     BODY,
     CHUNK_HEADER,
     CHUNK_COMPLETE,
     TRAILERS_COMPLETE,
     MESSAGE_COMPLETE,
     UPGRADE
   };

Constructor & Destructor Documentation

proxygen::HTTPEvent::HTTPEvent	(	HTTPCodec::StreamID	streamID,
		Type	event,
		bool	upgrade = `false`
	)

inline

Definition at line 41 of file HTTPEvent.h.

                                        :
       streamID_(streamID), length_(0), event_(event),
       upgrade_(upgrade) {}

proxygen::HTTPEvent::HTTPEvent	(	HTTPCodec::StreamID	streamID,
		Type	event,
		size_t	length
	)

inline

Definition at line 46 of file HTTPEvent.h.

References CHUNK_HEADER.

                                                   :
       streamID_(streamID), length_(length), event_(event),
       upgrade_(false) {
     // This constructor should only be used for CHUNK_HEADER.
     // (Ideally we would take the event type as a template parameter
     // so we could enforce this check at compile time.  Unfortunately,
     // that would prevent us from using this constructor with
     // deferredCallbacks_.emplace().)
     CHECK(event == Type::CHUNK_HEADER);
   }

proxygen::HTTPEvent::HTTPEvent	(	HTTPCodec::StreamID	streamID,
		Type	event,
		std::unique_ptr< HTTPMessage >	headers
	)

inline

Definition at line 58 of file HTTPEvent.h.

                                                      :
         headers_(std::move(headers)), streamID_(streamID), length_(0),
         event_(event), upgrade_(false) {}

proxygen::HTTPEvent::HTTPEvent	(	HTTPCodec::StreamID	streamID,
		Type	event,
		std::unique_ptr< folly::IOBuf >	body
	)

inline

Definition at line 63 of file HTTPEvent.h.

                                                        :
       body_(std::move(body)), streamID_(streamID), length_(0),
       event_(event), upgrade_(false) {}

proxygen::HTTPEvent::HTTPEvent	(	HTTPCodec::StreamID	streamID,
		Type	event,
		std::unique_ptr< HTTPHeaders >	trailers
	)

inline

Definition at line 68 of file HTTPEvent.h.

                                                       :
         trailers_(std::move(trailers)), streamID_(streamID), length_(0),
         event_(event), upgrade_(false) {}

proxygen::HTTPEvent::HTTPEvent	(	HTTPCodec::StreamID	streamID,
		Type	event,
		std::unique_ptr< HTTPException >	error
	)

inline

Definition at line 73 of file HTTPEvent.h.

                                                      :
         error_(std::move(error)), streamID_(streamID), length_(0),
         event_(event), upgrade_(false) {}

proxygen::HTTPEvent::HTTPEvent	(	HTTPCodec::StreamID	streamID,
		Type	event,
		UpgradeProtocol	protocol
	)

inline

Definition at line 78 of file HTTPEvent.h.

                                            :
         streamID_(streamID), length_(0), event_(event),
         upgrade_(false), protocol_(protocol) {}

Member Function Documentation

std::unique_ptr<folly::IOBuf> proxygen::HTTPEvent::getBody ( )

inline

Definition at line 89 of file HTTPEvent.h.

References body_, and folly::gen::move.

89 { return std::move(body_); }

folly::gen::move

constexpr detail::Map< Move > move

Definition: Base-inl.h:2567

proxygen::HTTPEvent::body_

std::unique_ptr< folly::IOBuf > body_

Definition: HTTPEvent.h:113

size_t proxygen::HTTPEvent::getChunkLength ( ) const

inline

Definition at line 98 of file HTTPEvent.h.

References CHUNK_HEADER, event_, and length_.

                                 {
     CHECK(event_ == Type::CHUNK_HEADER);
     return length_;
   }

std::unique_ptr<HTTPException> proxygen::HTTPEvent::getError ( )

inline

Definition at line 91 of file HTTPEvent.h.

References error_, and folly::gen::move.

91 { return std::move(error_); }

proxygen::HTTPEvent::error_

std::unique_ptr< HTTPException > error_

Definition: HTTPEvent.h:115

folly::gen::move

constexpr detail::Map< Move > move

Definition: Base-inl.h:2567

Type proxygen::HTTPEvent::getEvent ( ) const

inline

Definition at line 83 of file HTTPEvent.h.

References event_.

Referenced by proxygen::HTTPTransaction::resumeIngress().

83 { return event_; }

proxygen::HTTPEvent::event_

Type event_

Definition: HTTPEvent.h:118

std::unique_ptr<HTTPMessage> proxygen::HTTPEvent::getHeaders ( )

inline

Definition at line 87 of file HTTPEvent.h.

References headers_, and folly::gen::move.

87 { return std::move(headers_); }

folly::gen::move

constexpr detail::Map< Move > move

Definition: Base-inl.h:2567

proxygen::HTTPEvent::headers_

std::unique_ptr< HTTPMessage > headers_

Definition: HTTPEvent.h:112

HTTPCodec::StreamID proxygen::HTTPEvent::getStreamID ( ) const

inline

Definition at line 85 of file HTTPEvent.h.

References streamID_.

85 { return streamID_; }

proxygen::HTTPEvent::streamID_

HTTPCodec::StreamID streamID_

Definition: HTTPEvent.h:116

std::unique_ptr<HTTPHeaders> proxygen::HTTPEvent::getTrailers ( )

inline

Definition at line 103 of file HTTPEvent.h.

References folly::gen::move, and trailers_.

                                            {
     return std::move(trailers_);
   }

UpgradeProtocol proxygen::HTTPEvent::getUpgradeProtocol ( )

inline

Definition at line 107 of file HTTPEvent.h.

References protocol_.

                                        {
     return protocol_;
   }

bool proxygen::HTTPEvent::isUpgrade ( ) const

inline

Definition at line 93 of file HTTPEvent.h.

References event_, MESSAGE_COMPLETE, and upgrade_.

                          {
     CHECK(event_ == Type::MESSAGE_COMPLETE);
     return upgrade_;
   }

Member Data Documentation

std::unique_ptr<folly::IOBuf> proxygen::HTTPEvent::body_

private

Definition at line 113 of file HTTPEvent.h.

Referenced by getBody().

std::unique_ptr<HTTPException> proxygen::HTTPEvent::error_

private

Definition at line 115 of file HTTPEvent.h.

Referenced by getError().

Type proxygen::HTTPEvent::event_

private

Definition at line 118 of file HTTPEvent.h.

Referenced by getChunkLength(), getEvent(), and isUpgrade().

std::unique_ptr<HTTPMessage> proxygen::HTTPEvent::headers_

private

Definition at line 112 of file HTTPEvent.h.

Referenced by getHeaders().

size_t proxygen::HTTPEvent::length_

private

Definition at line 117 of file HTTPEvent.h.

Referenced by getChunkLength().

UpgradeProtocol proxygen::HTTPEvent::protocol_

private

Definition at line 120 of file HTTPEvent.h.

Referenced by getUpgradeProtocol().

HTTPCodec::StreamID proxygen::HTTPEvent::streamID_

private

Definition at line 116 of file HTTPEvent.h.

Referenced by getStreamID().

std::unique_ptr<HTTPHeaders> proxygen::HTTPEvent::trailers_

private

Definition at line 114 of file HTTPEvent.h.

Referenced by getTrailers().

bool proxygen::HTTPEvent::upgrade_

private

Definition at line 119 of file HTTPEvent.h.

Referenced by isUpgrade().

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

proxygen/lib/http/session/HTTPEvent.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation