folly::ReadEOFCallback Class Reference

#include <AsyncSSLSocketTest.h>

Inheritance diagram for folly::ReadEOFCallback:

Public Member Functions
	ReadEOFCallback (WriteCallbackBase *wcb)
void	getReadBuffer (void **bufReturn, size_t *lenReturn) override
void	readDataAvailable (size_t) noexceptoverride
void	readEOF () noexceptoverride
Public Member Functions inherited from folly::ReadCallbackBase
	ReadCallbackBase (WriteCallbackBase *wcb)
	~ReadCallbackBase () override
void	setSocket (const std::shared_ptr< AsyncSSLSocket > &socket)
void	setState (StateEnum s)
void	readErr (const AsyncSocketException &ex) noexceptoverride
Public Member Functions inherited from folly::AsyncReader::ReadCallback
virtual	~ReadCallback ()=default
virtual bool	isBufferMovable () noexcept
virtual size_t	maxBufferSize () const
virtual void	readBufferAvailable (std::unique_ptr< IOBuf >) noexcept

Additional Inherited Members
Public Attributes inherited from folly::ReadCallbackBase
std::shared_ptr< AsyncSSLSocket >	socket_
WriteCallbackBase *	wcb_
StateEnum	state

Detailed Description

Definition at line 400 of file AsyncSSLSocketTest.h.

Constructor & Destructor Documentation

folly::ReadEOFCallback::ReadEOFCallback ( WriteCallbackBase *  wcb )

inlineexplicit

Definition at line 402 of file AsyncSSLSocketTest.h.

: ReadCallbackBase(wcb) {}

Member Function Documentation

void folly::ReadEOFCallback::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 405 of file AsyncSSLSocketTest.h.

                                                                   {
    *bufReturn = nullptr;
    *lenReturn = 0;
  }

void folly::ReadEOFCallback::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 410 of file AsyncSSLSocketTest.h.

References FAIL.

                                                     {
    // This should never to called.
    FAIL();
  }

void folly::ReadEOFCallback::readEOF ( )

inlineoverridevirtualnoexcept

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

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

Reimplemented from folly::ReadCallbackBase.

Definition at line 415 of file AsyncSSLSocketTest.h.

References folly::ReadCallbackBase::readEOF(), and folly::STATE_SUCCEEDED.

                                   {
    ReadCallbackBase::readEOF();
    setState(STATE_SUCCEEDED);
  }

---

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

• proxygen/folly/folly/io/async/test/AsyncSSLSocketTest.h