class FinderTcpBase Contains pure virtuals Definition #include <finder_tcp.hh> Inherited by FinderTcpMessenger List of all Methods

Annotated List Files Globals Hierarchy Index

Public Methods

•  FinderTcpBase (EventLoop& e, int fd)
• virtual  ~FinderTcpBase ()
• virtual void  read_event (int errval, const uint8_t* data, uint32_t data_bytes)
• void  set_read_enabled (bool en)
• bool  read_enabled () const
• bool  write_data (const uint8_t* data, uint32_t data_bytes)
• bool  write_data (const iovec* iov, uint32_t iovcnt)
• virtual void  write_event (int errval, const uint8_t* data, uint32_t data_bytes)
• virtual void  close_event ()
• virtual void  error_event ()
• void  close ()
• bool  closed () const

Protected Methods

•  FinderTcpBase (const FinderTcpBase&)
• FinderTcpBase&  operator= (const FinderTcpBase&)
• void  read_callback (AsyncFileOperator::Event, const uint8_t*, size_t, size_t)
• void  write_callback (AsyncFileOperator::Event, const uint8_t*, size_t, size_t)

Protected Members

• int _fd
• vector<uint8_t> _input_buffer
• AsyncFileReader _reader
• AsyncFileWriter _writer
• uint32_t _isize
• uint32_t _osize
• static const uint32_t FINDER_TCP_BUFFER_BYTES

Detailed Description

[virtual]

[pure virtual]

Method to be implemented by derived classes that is called when data arrives or an error occurs when processing when data arrives.

Parameters:

errval	error code, values are equivalent to errno.
data	pointer to data
data_bytes	size of data.

Control whether read events can occur.

Parameters:

en	boolean value with true corresponding to read enabled.

[const]

Determine whether read events can occur.

Returns: true if read events are enabled.

Write data on TCP connection. To avoid an unnecessary data copy, the client is expected to ensure the data is valid until departure_event is called with the corresponding data pointer.

Parameters:

data	pointer to data.
data_bytes	size data pointed to in bytes.

Returns: true if data accepted for writing, false if no buffer space is available at this time.

[pure virtual]

Method to be implemented by derived classes that is called when data writing completes or an error occurs when processing when write.

Parameters:

errval

error code, values are equivalent to errno.

[virtual]

Method that may be implemented by derived classes for detecting when the underlying socket is closed.

[virtual]

[const]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]