proxygen
folly::NoopReadCallback Class Reference
Inheritance diagram for folly::NoopReadCallback:
folly::ReadCallbackBase folly::AsyncReader::ReadCallback

Public Member Functions

 NoopReadCallback ()
 
void getReadBuffer (void **buf, size_t *lenReturn) override
 
void readDataAvailable (size_t) 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
 
void readEOF () 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
 

Public Attributes

uint8_t buffer_ {0}
 
- Public Attributes inherited from folly::ReadCallbackBase
std::shared_ptr< AsyncSSLSocketsocket_
 
WriteCallbackBasewcb_
 
StateEnum state
 

Detailed Description

Definition at line 230 of file AsyncSSLSocketTest2.cpp.

Constructor & Destructor Documentation

folly::NoopReadCallback::NoopReadCallback ( )
inline

Definition at line 232 of file AsyncSSLSocketTest2.cpp.

References folly::STATE_SUCCEEDED.

232  : ReadCallbackBase(nullptr) {
234  }
ReadCallbackBase(WriteCallbackBase *wcb)
state
Definition: http_parser.c:272

Member Function Documentation

void folly::NoopReadCallback::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
bufReturngetReadBuffer() should update *bufReturn to contain the address of the read buffer. This parameter will never be nullptr.
lenReturngetReadBuffer() 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 236 of file AsyncSSLSocketTest2.cpp.

References buffer_.

236  {
237  *buf = &buffer_;
238  *lenReturn = 1;
239  }
void folly::NoopReadCallback::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
lenThe number of bytes placed in the buffer.

Implements folly::AsyncReader::ReadCallback.

Definition at line 240 of file AsyncSSLSocketTest2.cpp.

240 {}

Member Data Documentation

uint8_t folly::NoopReadCallback::buffer_ {0}

Definition at line 242 of file AsyncSSLSocketTest2.cpp.


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