proxygen: BogoTestServer Class Reference

Inheritance diagram for BogoTestServer:

Public Member Functions
	BogoTestServer (EventBase *evb, uint16_t port, std::shared_ptr< FizzServerContext > serverContext, std::shared_ptr< SSLContext > sslContext)

void	connectSuccess () noexceptoverride

void	connectErr (const AsyncSocketException &ex) noexceptoverride

void	fizzHandshakeSuccess (AsyncFizzServer *) noexceptoverride

void	fizzHandshakeError (AsyncFizzServer *, folly::exception_wrapper ex) noexceptoverride

void	fizzHandshakeAttemptFallback (std::unique_ptr< folly::IOBuf > clientHello) override

void	getReadBuffer (void *, size_t ) override

void	readDataAvailable (size_t) noexceptoverride

bool	isBufferMovable () noexceptoverride

void	readBufferAvailable (std::unique_ptr< IOBuf > buf) noexceptoverride

void	readEOF () noexceptoverride

void	readErr (const AsyncSocketException &) noexceptoverride

void	handshakeSuc (folly::AsyncSSLSocket *) noexceptoverride

void	handshakeErr (folly::AsyncSSLSocket *, const folly::AsyncSocketException &ex) noexceptoverride

bool	unimplemented () const

bool	success () const

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

Public Member Functions inherited from fizz::server::AsyncFizzServerT< SM >::HandshakeCallback
virtual	~HandshakeCallback ()=default

virtual void	fizzHandshakeSuccess (AsyncFizzServerT *transport) noexcept=0

virtual void	fizzHandshakeError (AsyncFizzServerT *transport, folly::exception_wrapper ex) noexcept=0

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

virtual bool	handshakeVer (AsyncSSLSocket , bool preverifyOk, X509_STORE_CTX ) noexcept

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

virtual size_t	maxBufferSize () const

Private Attributes
EventBase *	evb_

AsyncSocket::UniquePtr	socket_

std::shared_ptr< FizzServerContext >	serverContext_

AsyncFizzServer::UniquePtr	transport_

std::shared_ptr< SSLContext >	sslContext_

AsyncSSLSocket::UniquePtr	sslSocket_

bool	unimplemented_ {false}

Optional< bool >	success_

Detailed Description

Definition at line 40 of file BogoShim.cpp.

Constructor & Destructor Documentation

BogoTestServer::BogoTestServer	(	EventBase *	evb,
		uint16_t	port,
		std::shared_ptr< FizzServerContext >	serverContext,
		std::shared_ptr< SSLContext >	sslContext
	)

inline

Definition at line 45 of file BogoShim.cpp.

References socket_.

       : evb_(evb), serverContext_(serverContext), sslContext_(sslContext) {
     socket_ = AsyncSocket::UniquePtr(new AsyncSocket(evb));
     socket_->connect(this, "::", port, 1000);
   }

Member Function Documentation

void BogoTestServer::connectErr ( const AsyncSocketException & ex )

inlineoverridevirtualnoexcept

connectErr() will be invoked if the connection attempt fails.

Parameters

ex	An exception describing the error that occurred.

Implements folly::AsyncSocket::ConnectCallback.

Definition at line 61 of file BogoShim.cpp.

References folly::INFO, and socket_.

                                                                     {
     LOG(INFO) << "TCP connect failed: " << ex.what();
     socket_.reset();
     success_ = false;
   }

void BogoTestServer::connectSuccess ( )

inlineoverridevirtualnoexcept

connectSuccess() will be invoked when the connection has been successfully established.

Implements folly::AsyncSocket::ConnectCallback.

Definition at line 55 of file BogoShim.cpp.

References folly::gen::move, socket_, and transport_.

                                           {
     transport_ = AsyncFizzServer::UniquePtr(
         new AsyncFizzServer(std::move(socket_), serverContext_));
     transport_->accept(this);
   }

void BogoTestServer::fizzHandshakeAttemptFallback ( std::unique_ptr< folly::IOBuf > clientHello )

inlineoverridevirtual

Implements fizz::server::AsyncFizzServerT< SM >::HandshakeCallback.

Definition at line 80 of file BogoShim.cpp.

References evb_, folly::gen::move, sslSocket_, and transport_.

                                                       {
     auto fd = transport_->getUnderlyingTransport<AsyncSocket>()->detachFd();
     transport_.reset();
     if (!sslContext_) {
       unimplemented_ = true;
     } else {
       sslSocket_ =
           AsyncSSLSocket::UniquePtr(new AsyncSSLSocket(sslContext_, evb_, fd));
       sslSocket_->setPreReceivedData(std::move(clientHello));
       sslSocket_->sslAccept(this);
     }
   }

void BogoTestServer::fizzHandshakeError	(	AsyncFizzServer *	,
		folly::exception_wrapper	ex
	)

inlineoverridenoexcept

Definition at line 72 of file BogoShim.cpp.

References folly::INFO, and transport_.

                                                    {
     LOG(INFO) << "Handshake error: " << ex.what();
     transport_.reset();
     success_ = false;
   }

void BogoTestServer::fizzHandshakeSuccess ( AsyncFizzServer * )

inlineoverridenoexcept

Definition at line 67 of file BogoShim.cpp.

References transport_.

                                                                 {
     success_ = true;
     transport_->setReadCB(this);
   }

void BogoTestServer::getReadBuffer	(	void **	bufReturn,
		size_t *	lenReturn
	)

inlineoverridevirtual

When data becomes available, getReadBuffer() will be invoked to get the buffer into which data should be read.

This method allows the ReadCallback to delay buffer allocation until data becomes available. This allows applications to manage large numbers of idle connections, without having to maintain a separate read buffer for each idle connection.

It is possible that in some cases, getReadBuffer() may be called multiple times before readDataAvailable() is invoked. In this case, the data will be written to the buffer returned from the most recent call to readDataAvailable(). If the previous calls to readDataAvailable() returned different buffers, the ReadCallback is responsible for ensuring that they are not leaked.

If getReadBuffer() throws an exception, returns a nullptr buffer, or returns a 0 length, the ReadCallback will be uninstalled and its readError() method will be invoked.

getReadBuffer() is not allowed to change the transport state before it returns. (For example, it should never uninstall the read callback, or set a different read callback.)

Parameters

bufReturn	getReadBuffer() should update *bufReturn to contain the address of the read buffer. This parameter will never be nullptr.
lenReturn	getReadBuffer() should update *lenReturn to contain the maximum number of bytes that may be written to the read buffer. This parameter will never be nullptr.

Implements folly::AsyncReader::ReadCallback.

Definition at line 94 of file BogoShim.cpp.

                                                    {
     throw std::runtime_error("getReadBuffer not implemented");
   }

void BogoTestServer::handshakeErr	(	folly::AsyncSSLSocket *	sock,
		const folly::AsyncSocketException &	ex
	)

inlineoverridevirtualnoexcept

handshakeErr() is called if an error occurs while establishing the SSL connection.

The HandshakeCB will be uninstalled before handshakeErr() is called.

Parameters

sock	SSL socket on which the handshake was initiated
ex	An exception representing the error.

Implements folly::AsyncSSLSocket::HandshakeCB.

Definition at line 127 of file BogoShim.cpp.

References folly::INFO, and sslSocket_.

                                                              {
     LOG(INFO) << "SSL Handshake error: " << ex.what();
     sslSocket_.reset();
     success_ = false;
   }

void BogoTestServer::handshakeSuc ( folly::AsyncSSLSocket * sock )

inlineoverridevirtualnoexcept

handshakeSuc() is called when a new SSL connection is established, i.e., after SSL_accept/connect() returns successfully.

The HandshakeCB will be uninstalled before handshakeSuc() is called.

Parameters

sock	SSL socket on which the handshake was initiated

Implements folly::AsyncSSLSocket::HandshakeCB.

Definition at line 123 of file BogoShim.cpp.

                                                             {
     success_ = true;
   }

bool BogoTestServer::isBufferMovable ( )

inlineoverridevirtualnoexcept

When data becomes available, isBufferMovable() will be invoked to figure out which API will be used, readBufferAvailable() or readDataAvailable(). If isBufferMovable() returns true, that means ReadCallback supports the IOBuf ownership transfer and readBufferAvailable() will be used. Otherwise, not.

By default, isBufferMovable() always return false. If readBufferAvailable() is implemented and to be invoked, You should overwrite isBufferMovable() and return true in the inherited class.

This method allows the AsyncSocket/AsyncSSLSocket do buffer allocation by itself until data becomes available. Compared with the pre/post buffer allocation in getReadBuffer()/readDataAvailabe(), readBufferAvailable() has two advantages. First, this can avoid memcpy. E.g., in AsyncSSLSocket, the decrypted data was copied from the openssl internal buffer to the readbuf buffer. With the buffer ownership transfer, the internal buffer can be directly "moved" to ReadCallback. Second, the memory allocation can be more precise. The reason is AsyncSocket/AsyncSSLSocket can allocate the memory of precise size because they have more context about the available data than ReadCallback. Think about the getReadBuffer() pre-allocate 4072 bytes buffer, but the available data is always 16KB (max OpenSSL record size).

Reimplemented from folly::AsyncReader::ReadCallback.

Definition at line 102 of file BogoShim.cpp.

                                            {
     return true;
   }

void BogoTestServer::readBufferAvailable ( std::unique_ptr< IOBuf > )

inlineoverridevirtualnoexcept

readBufferAvailable() will be invoked when data has been successfully read.

Note that only either readBufferAvailable() or readDataAvailable() will be invoked according to the return value of isBufferMovable(). The timing and aftereffect of readBufferAvailable() are the same as readDataAvailable()

Parameters

readBuf The unique pointer of read buffer.

Reimplemented from folly::AsyncReader::ReadCallback.

Definition at line 106 of file BogoShim.cpp.

References folly::gen::move, transport_, uint8_t, and fizz::detail::write().

                                                                        {
     io::Cursor cursor(buf.get());
     std::unique_ptr<IOBuf> write = IOBuf::create(0);
     io::Appender appender(write.get(), 50);
     while (!cursor.isAtEnd()) {
       uint8_t byte;
       cursor.pull(&byte, 1);
       byte ^= 0xff;
       appender.push(&byte, 1);
     }
     transport_->writeChain(nullptr, std::move(write));
   }

void BogoTestServer::readDataAvailable ( size_t len )

inlineoverridevirtualnoexcept

readDataAvailable() will be invoked when data has been successfully read into the buffer returned by the last call to getReadBuffer().

The read callback remains installed after readDataAvailable() returns. It must be explicitly uninstalled to stop receiving read events. getReadBuffer() will be called at least once before each call to readDataAvailable(). getReadBuffer() will also be called before any call to readEOF().

Parameters

len	The number of bytes placed in the buffer.

Implements folly::AsyncReader::ReadCallback.

Definition at line 98 of file BogoShim.cpp.

                                                      {
     CHECK(false) << "readDataAvailable not implemented";
   }

void BogoTestServer::readEOF ( )

inlineoverridevirtualnoexcept

readEOF() will be invoked when the transport is closed.

The read callback will be automatically uninstalled immediately before readEOF() is invoked.

Implements folly::AsyncReader::ReadCallback.

Definition at line 119 of file BogoShim.cpp.

119 {}

void BogoTestServer::readErr ( const AsyncSocketException & ex )

inlineoverridevirtualnoexcept

readError() will be invoked if an error occurs reading from the transport.

The read callback will be automatically uninstalled immediately before readError() is invoked.

Parameters

ex	An exception describing the error that occurred.

Implements folly::AsyncReader::ReadCallback.

Definition at line 121 of file BogoShim.cpp.

121 {}

bool BogoTestServer::success ( ) const

inline

Definition at line 139 of file BogoShim.cpp.

                        {
     return *success_;
   }

bool BogoTestServer::unimplemented ( ) const

inline

Definition at line 135 of file BogoShim.cpp.

                              {
     return unimplemented_;
   }

Member Data Documentation

EventBase* BogoTestServer::evb_

private

Definition at line 144 of file BogoShim.cpp.

std::shared_ptr<FizzServerContext> BogoTestServer::serverContext_

private

Definition at line 147 of file BogoShim.cpp.

AsyncSocket::UniquePtr BogoTestServer::socket_

private

Definition at line 145 of file BogoShim.cpp.

std::shared_ptr<SSLContext> BogoTestServer::sslContext_

private

Definition at line 150 of file BogoShim.cpp.

AsyncSSLSocket::UniquePtr BogoTestServer::sslSocket_

private

Definition at line 151 of file BogoShim.cpp.

Optional<bool> BogoTestServer::success_

private

Definition at line 154 of file BogoShim.cpp.

AsyncFizzServer::UniquePtr BogoTestServer::transport_

private

Definition at line 148 of file BogoShim.cpp.

bool BogoTestServer::unimplemented_ {false}

private

Definition at line 153 of file BogoShim.cpp.

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

proxygen/fizz/fizz/test/BogoShim.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation