0.9.8.10
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Hypertable::Lib::RangeServer::Request::Parameters::CreateScanner Class Reference

Request parameters for create scanner function. More...

#include <CreateScanner.h>

Inheritance diagram for Hypertable::Lib::RangeServer::Request::Parameters::CreateScanner:
Inheritance graph
[legend]
Collaboration diagram for Hypertable::Lib::RangeServer::Request::Parameters::CreateScanner:
Collaboration graph
[legend]

Public Member Functions

 CreateScanner ()
 Constructor. More...
 
 CreateScanner (const TableIdentifier &table, const RangeSpec &range_spec, const ScanSpec &scan_spec)
 Constructor. More...
 
const TableIdentifiertable ()
 Gets table identifier. More...
 
const RangeSpecrange_spec ()
 Gets range specification. More...
 
const ScanSpecscan_spec ()
 Gets scan specification. 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

TableIdentifier m_table
 Table identifier More...
 
RangeSpec m_range_spec
 Range specification More...
 
ScanSpec m_scan_spec
 Scan specification. More...
 

Additional Inherited Members

Detailed Description

Request parameters for create scanner function.

Definition at line 50 of file CreateScanner.h.

Constructor & Destructor Documentation

Hypertable::Lib::RangeServer::Request::Parameters::CreateScanner::CreateScanner ( )
inline

Constructor.

Empty initialization for decoding.

Definition at line 55 of file CreateScanner.h.

Hypertable::Lib::RangeServer::Request::Parameters::CreateScanner::CreateScanner ( const TableIdentifier table,
const RangeSpec range_spec,
const ScanSpec scan_spec 
)
inline

Constructor.

Initializes with parameters for encoding.

Parameters
tableTable identifier
range_specRange specification
scan_specScan specification

Definition at line 62 of file CreateScanner.h.

Member Function Documentation

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

Reads serialized representation of object from a buffer.

Parameters
versionEncoding version
bufpAddress of destination buffer pointer (advanced by call)
remainpAddress of integer holding amount of serialized object remaining
See also
encode_internal() for encoding format

Implements Hypertable::Serializable.

Definition at line 72 of file CreateScanner.cc.

void CreateScanner::encode_internal ( uint8_t **  bufp) const
overrideprivatevirtual

Writes serialized representation of object to a buffer.

Parameters
bufpAddress of destination buffer pointer (advanced by call)

Encoding is as follows:

Encoding Description
TableIdentifier Table identifier
RangeSpec Range specification
ScanSpec Scan specification

Implements Hypertable::Serializable.

Definition at line 66 of file CreateScanner.cc.

size_t CreateScanner::encoded_length_internal ( ) const
overrideprivatevirtual

Returns internal serialized length.

Returns
Internal serialized length
See also
encode_internal() for encoding format

Implements Hypertable::Serializable.

Definition at line 41 of file CreateScanner.cc.

uint8_t CreateScanner::encoding_version ( ) const
overrideprivatevirtual

Returns encoding version.

Returns
Encoding version

Implements Hypertable::Serializable.

Definition at line 37 of file CreateScanner.cc.

const RangeSpec& Hypertable::Lib::RangeServer::Request::Parameters::CreateScanner::range_spec ( )
inline

Gets range specification.

Returns
Range specification

Definition at line 72 of file CreateScanner.h.

const ScanSpec& Hypertable::Lib::RangeServer::Request::Parameters::CreateScanner::scan_spec ( )
inline

Gets scan specification.

Returns
Scan specification

Definition at line 76 of file CreateScanner.h.

const TableIdentifier& Hypertable::Lib::RangeServer::Request::Parameters::CreateScanner::table ( )
inline

Gets table identifier.

Returns
Table identifier

Definition at line 68 of file CreateScanner.h.

Member Data Documentation

RangeSpec Hypertable::Lib::RangeServer::Request::Parameters::CreateScanner::m_range_spec
private

Range specification

Definition at line 106 of file CreateScanner.h.

ScanSpec Hypertable::Lib::RangeServer::Request::Parameters::CreateScanner::m_scan_spec
private

Scan specification.

Definition at line 109 of file CreateScanner.h.

TableIdentifier Hypertable::Lib::RangeServer::Request::Parameters::CreateScanner::m_table
private

Table identifier

Definition at line 103 of file CreateScanner.h.


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