proxygen: wangle::PeekingAcceptorHandshakeHelper Class Reference

#include <PeekingAcceptorHandshakeHelper.h>

Inheritance diagram for wangle::PeekingAcceptorHandshakeHelper:

Classes
class	PeekCallback

Public Member Functions
	PeekingAcceptorHandshakeHelper (const folly::SocketAddress &clientAddr, std::chrono::steady_clock::time_point acceptTime, TransportInfo &tinfo, const std::vector< PeekCallback * > &peekCallbacks, size_t numBytes)

void	start (folly::AsyncSSLSocket::UniquePtr sock, AcceptorHandshakeHelper::Callback *callback) noexceptoverride

void	dropConnection (SSLErrorEnum reason=SSLErrorEnum::NO_ERROR) override

void	peekSuccess (std::vector< uint8_t > peekBytes) noexceptoverride

void	peekError (const folly::AsyncSocketException &ex) noexceptoverride

Public Member Functions inherited from folly::DelayedDestruction
virtual void	destroy ()

bool	getDestroyPending () const

Public Member Functions inherited from folly::DelayedDestructionBase
virtual	~DelayedDestructionBase ()=default

Public Member Functions inherited from wangle::SocketPeeker::Callback
virtual	~Callback ()=default

Private Member Functions
	~PeekingAcceptorHandshakeHelper () override=default

Private Attributes
folly::AsyncSSLSocket::UniquePtr	socket_

AcceptorHandshakeHelper::UniquePtr	helper_

SocketPeeker::UniquePtr	peeker_

AcceptorHandshakeHelper::Callback *	callback_

const folly::SocketAddress &	clientAddr_

std::chrono::steady_clock::time_point	acceptTime_

TransportInfo &	tinfo_

const std::vector< PeekCallback * > &	peekCallbacks_

size_t	numBytes_

Additional Inherited Members
Public Types inherited from wangle::AcceptorHandshakeHelper
using	UniquePtr = std::unique_ptr< AcceptorHandshakeHelper, folly::DelayedDestruction::Destructor >

Protected Member Functions inherited from folly::DelayedDestruction
	~DelayedDestruction () override=default

	DelayedDestruction ()

Protected Member Functions inherited from folly::DelayedDestructionBase
	DelayedDestructionBase ()

uint32_t	getDestructorGuardCount () const

Detailed Description

A hanshake helper which helpes switching between SSL and other protocols, so that we can run both SSL and other protocols over the same port at the same time. The mechanism used by this is to peek the first numBytes bytes of the socket and send it to the peek helper to decide which protocol it is.

Definition at line 32 of file PeekingAcceptorHandshakeHelper.h.

Constructor & Destructor Documentation

wangle::PeekingAcceptorHandshakeHelper::PeekingAcceptorHandshakeHelper	(	const folly::SocketAddress &	clientAddr,
		std::chrono::steady_clock::time_point	acceptTime,
		TransportInfo &	tinfo,
		const std::vector< PeekCallback * > &	peekCallbacks,
		size_t	numBytes
	)

inline

Definition at line 55 of file PeekingAcceptorHandshakeHelper.h.

Referenced by wangle::PeekingAcceptorHandshakeManager::startHelper().

       : clientAddr_(clientAddr),
         acceptTime_(acceptTime),
         tinfo_(tinfo),
         peekCallbacks_(peekCallbacks),
         numBytes_(numBytes) {}

wangle::PeekingAcceptorHandshakeHelper::~PeekingAcceptorHandshakeHelper ( )

overrideprivatedefault

Referenced by peekError().

Member Function Documentation

void wangle::PeekingAcceptorHandshakeHelper::dropConnection ( SSLErrorEnum reason = SSLErrorEnum::NO_ERROR )

inlineoverridevirtual

Implements wangle::AcceptorHandshakeHelper.

Definition at line 80 of file PeekingAcceptorHandshakeHelper.h.

References helper_, and socket_.

                                                                            {
     CHECK_NE(socket_.get() == nullptr, helper_.get() == nullptr);
     if (socket_) {
       socket_->closeNow();
     } else if (helper_) {
       helper_->dropConnection(reason);
     }
   }

void wangle::PeekingAcceptorHandshakeHelper::peekError ( const folly::AsyncSocketException & ex )

inlineoverridevirtualnoexcept

Implements wangle::SocketPeeker::Callback.

Definition at line 115 of file PeekingAcceptorHandshakeHelper.h.

References callback_, wangle::AcceptorHandshakeHelper::Callback::connectionError(), folly::none, peeker_, socket_, and ~PeekingAcceptorHandshakeHelper().

Referenced by peekSuccess().

                                                                         {
     peeker_ = nullptr;
     auto callback = callback_;
     callback_ = nullptr;
     callback->connectionError(
         socket_.get(), folly::exception_wrapper(ex), folly::none);
   }

void wangle::PeekingAcceptorHandshakeHelper::peekSuccess ( std::vector< uint8_t > peekBytes )

inlineoverridevirtualnoexcept

Implements wangle::SocketPeeker::Callback.

Definition at line 89 of file PeekingAcceptorHandshakeHelper.h.

References acceptTime_, callback_, clientAddr_, helper_, folly::gen::move, peekCallbacks_, peeker_, peekError(), socket_, tinfo_, and type.

                                                                    {
     folly::DelayedDestruction::DestructorGuard dg(this);
     peeker_ = nullptr;
 
     for (auto& peekCallback : peekCallbacks_) {
       helper_ = peekCallback->getHelper(
           peekBytes, clientAddr_, acceptTime_, tinfo_);
       if (helper_) {
         break;
       }
     }
 
     if (!helper_) {
       // could not get a helper, report error.
       auto type =
           folly::AsyncSocketException::AsyncSocketExceptionType::CORRUPTED_DATA;
       return peekError(
           folly::AsyncSocketException(type, "Unrecognized protocol"));
     }
 
     auto callback = callback_;
     callback_ = nullptr;
     helper_->start(std::move(socket_), callback);
     CHECK(!socket_);
   }

void wangle::PeekingAcceptorHandshakeHelper::start	(	folly::AsyncSSLSocket::UniquePtr	sock,
		AcceptorHandshakeHelper::Callback *	callback
	)

inlineoverridevirtualnoexcept

Implements wangle::AcceptorHandshakeHelper.

Definition at line 68 of file PeekingAcceptorHandshakeHelper.h.

References callback_, folly::gen::move, numBytes_, peeker_, and socket_.

                                                                    {
     socket_ = std::move(sock);
     callback_ = callback;
     CHECK_EQ(
         socket_->getSSLState(),
         folly::AsyncSSLSocket::SSLStateEnum::STATE_UNENCRYPTED);
     peeker_.reset(new SocketPeeker(*socket_, this, numBytes_));
     peeker_->start();
   }