Hypertable::FsBroker::Lib::Request::Parameters::Read Class Reference

Request parameters for read requests. More...

#include <Read.h>

Inheritance diagram for Hypertable::FsBroker::Lib::Request::Parameters::Read:

Collaboration diagram for Hypertable::FsBroker::Lib::Request::Parameters::Read:

Public Member Functions
	Read ()
	Constructor. More...
	Read (int32_t fd, uint32_t amount)
	Constructor. More...
int32_t	get_fd ()
	Gets file descriptor. More...
uint32_t	get_amount ()
	Gets amount of data to read. More...
Public Member Functions inherited from Hypertable::Serializable
virtual size_t	encoded_length () const
	Returns serialized object length. More...
virtual void	encode (uint8_t **bufp) const
	Writes serialized representation of object to a buffer. More...
virtual void	decode (const uint8_t **bufp, size_t *remainp)
	Reads serialized representation of object from a buffer. More...

Private Member Functions
uint8_t	encoding_version () const override
	Returns encoding version. More...
size_t	encoded_length_internal () const override
	Returns internal serialized length. More...
void	encode_internal (uint8_t **bufp) const override
	Writes serialized representation of object to a buffer. More...
void	decode_internal (uint8_t version, const uint8_t **bufp, size_t *remainp) override
	Reads serialized representation of object from a buffer. More...

Private Attributes
int32_t	m_fd {}
	File descriptor to which read applies. More...
uint32_t	m_amount
	Amount of data to read. More...

Additional Inherited Members

Detailed Description

Request parameters for read requests.

Definition at line 46 of file Read.h.

Constructor & Destructor Documentation

Hypertable::FsBroker::Lib::Request::Parameters::Read::Read ( )

inline

Constructor.

Empty initialization for decoding.

Definition at line 51 of file Read.h.

Hypertable::FsBroker::Lib::Request::Parameters::Read::Read ( int32_t  fd, uint32_t  amount  )

inline

Constructor.

Initializes with parameters for encoding. Sets m_fd to fd and m_amount to amount.

Parameters

fd	File descriptor
amount	Amount of data to read

Definition at line 58 of file Read.h.

Member Function Documentation

void Read::decode_internal ( uint8_t  version, const uint8_t **  bufp, size_t *  remainp  )

overrideprivatevirtual

Reads serialized representation of object from a buffer.

This function is to be overridden by derived classes and should decode the object per-se as encoded with encode_internal().

Parameters

version	Encoding version
bufp	Address of destination buffer pointer (advanced by call)
remainp	Address of integer holding amount of serialized encoding remaining

See also

encode_internal() for encoding format

Implements Hypertable::Serializable.

Definition at line 50 of file Read.cc.

void Read::encode_internal ( uint8_t **  bufp ) const

overrideprivatevirtual

Writes serialized representation of object to a buffer.

This function is to be overridden by derived classes and should encode the object per-se.

Parameters

bufp	Address of destination buffer pointer (advanced by call)

Implements Hypertable::Serializable.

Definition at line 45 of file Read.cc.

size_t Read::encoded_length_internal ( ) const

overrideprivatevirtual

Returns internal serialized length.

This function is to be overridden by derived classes and should return the length of the the serialized object per-se.

Returns

Internal serialized length

See also

encode_internal() for encoding format

Implements Hypertable::Serializable.

Definition at line 41 of file Read.cc.

uint8_t Read::encoding_version ( ) const

overrideprivatevirtual

Returns encoding version.

Returns

Encoding version

Implements Hypertable::Serializable.

Definition at line 37 of file Read.cc.

uint32_t Hypertable::FsBroker::Lib::Request::Parameters::Read::get_amount ( )

inline

Gets amount of data to read.

Returns

Amount of data to read

Definition at line 66 of file Read.h.

int32_t Hypertable::FsBroker::Lib::Request::Parameters::Read::get_fd ( )

inline

Gets file descriptor.

Returns

File descriptor

Definition at line 62 of file Read.h.

Member Data Documentation

uint32_t Hypertable::FsBroker::Lib::Request::Parameters::Read::m_amount

private

Amount of data to read.

Definition at line 83 of file Read.h.

int32_t Hypertable::FsBroker::Lib::Request::Parameters::Read::m_fd {}

private

File descriptor to which read applies.

Definition at line 80 of file Read.h.

---

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

• /home/doug/src/hypertable/src/cc/FsBroker/Lib/Request/Parameters/Read.h
• /home/doug/src/hypertable/src/cc/FsBroker/Lib/Request/Parameters/Read.cc