net::strus::api::StorageClient Class Reference

Object representing a client connection to the storage. More...

#include <bindingObjects.hpp>

Public Member Functions
	StorageClient (const StorageClient &o)
	Copy constructor. More...
	~StorageClient ()
	Destructor. More...
Index	nofDocumentsInserted () const
	Get the number of documents inserted into the storage return the total number of documents. More...
StorageTransaction	createTransaction () const
	Create a transaction return the transaction object created. More...
StatisticsIterator	createInitStatisticsIterator (bool sign) const
	Create an iterator on the storage statistics (total value) to distribute for initialization/deinitialization. More...
StatisticsIterator	createUpdateStatisticsIterator () const
	Create an iterator on the storage statistics (relative value) to distribute after storage updates return the statistics message iterator object created. More...
DocumentBrowser	createDocumentBrowser ()
	Create a document browser instance. More...
void	close ()
	Close of the storage client. More...

Friends
class	Context
class	Query
class	QueryEval

Detailed Description

Object representing a client connection to the storage.

Remarks

The only way to construct a storage client instance is to call Context::createStorageClient(const std::string&)

Constructor & Destructor Documentation

net::strus::api::StorageClient::StorageClient

(

const StorageClient &

o

)

Copy constructor.

net::strus::api::StorageClient::~StorageClient ( )

inline

Destructor.

Member Function Documentation

void net::strus::api::StorageClient::close

(

)

Close of the storage client.

DocumentBrowser net::strus::api::StorageClient::createDocumentBrowser

(

)

Create a document browser instance.

StatisticsIterator net::strus::api::StorageClient::createInitStatisticsIterator

(

bool

sign

)

const

Create an iterator on the storage statistics (total value) to distribute for initialization/deinitialization.

Parameters

[in]

sign

true = registration, false = deregistration return the statistics iterator object created

StorageTransaction net::strus::api::StorageClient::createTransaction

(

)

const

Create a transaction return the transaction object created.

StatisticsIterator net::strus::api::StorageClient::createUpdateStatisticsIterator

(

)

const

Create an iterator on the storage statistics (relative value) to distribute after storage updates return the statistics message iterator object created.

Index net::strus::api::StorageClient::nofDocumentsInserted

(

)

const

Get the number of documents inserted into the storage return the total number of documents.

Friends And Related Function Documentation

friend class Context

friend

friend class Query

friend

friend class QueryEval

friend

---

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

• /home/patrick/Projects/github/strusBindings/include/strus/bindingObjects.hpp