mongo::ClusteredCursor Class Reference

#include <parallel.h>

Inheritance diagram for mongo::ClusteredCursor:

[legend]

List of all members.

Public Member Functions
	ClusteredCursor (const string &ns, const BSONObj &q, int options=0, const BSONObj &fields=BSONObj())
	ClusteredCursor (QueryMessage &q)
virtual BSONObj	explain ()
void	init ()
virtual bool	more ()=0
virtual BSONObj	next ()=0
virtual string	type () const =0
virtual	~ClusteredCursor ()
Static Public Member Functions
static BSONObj	concatQuery (const BSONObj &query, const BSONObj &extraFilter)
Protected Member Functions
virtual void	_explain (map< string, list< BSONObj > > &out)=0
virtual void	_init ()=0
BSONObj	explain (const string &server, BSONObj extraFilter=BSONObj())
auto_ptr< DBClientCursor >	query (const string &server, int num=0, BSONObj extraFilter=BSONObj(), int skipLeft=0)
Static Protected Member Functions
static BSONObj	_concatFilter (const BSONObj &filter, const BSONObj &extraFilter)
Protected Attributes
int	_batchSize
bool	_didInit
bool	_done
BSONObj	_fields
string	_ns
int	_options
BSONObj	_query

---

Detailed Description

this is a cursor that works over a set of servers can be used in serial/paralellel as controlled by sub classes

Definition at line 69 of file parallel.h.

---

Constructor & Destructor Documentation

mongo::ClusteredCursor::ClusteredCursor

(

QueryMessage &

q

)

mongo::ClusteredCursor::ClusteredCursor	(	const string &	ns,
		const BSONObj &	q,
		int	options = 0,
		const BSONObj &	fields = BSONObj()
	)

virtual mongo::ClusteredCursor::~ClusteredCursor

(

)

[virtual]

---

Member Function Documentation

static BSONObj mongo::ClusteredCursor::_concatFilter	(	const BSONObj &	filter,
		const BSONObj &	extraFilter
	)			[static, protected]

virtual void mongo::ClusteredCursor::_explain

(

map< string, list< BSONObj > > &

out

)

[protected, pure virtual]

Implemented in mongo::SerialServerClusteredCursor, and mongo::ParallelSortClusteredCursor.

virtual void mongo::ClusteredCursor::_init

(

)

[protected, pure virtual]

Implemented in mongo::SerialServerClusteredCursor, and mongo::ParallelSortClusteredCursor.

static BSONObj mongo::ClusteredCursor::concatQuery	(	const BSONObj &	query,
		const BSONObj &	extraFilter
	)			[static]

BSONObj mongo::ClusteredCursor::explain	(	const string &	server,
		BSONObj	extraFilter = BSONObj()
	)			[protected]

virtual BSONObj mongo::ClusteredCursor::explain

(

)

[virtual]

void mongo::ClusteredCursor::init

(

)

call before using

virtual bool mongo::ClusteredCursor::more

(

)

[pure virtual]

Implemented in mongo::SerialServerClusteredCursor, and mongo::ParallelSortClusteredCursor.

virtual BSONObj mongo::ClusteredCursor::next

(

)

[pure virtual]

Implemented in mongo::SerialServerClusteredCursor, and mongo::ParallelSortClusteredCursor.

auto_ptr<DBClientCursor> mongo::ClusteredCursor::query	(	const string &	server,
		int	num = 0,
		BSONObj	extraFilter = BSONObj(),
		int	skipLeft = 0
	)			[protected]

virtual string mongo::ClusteredCursor::type

(

)

const [pure virtual]

Implemented in mongo::SerialServerClusteredCursor, and mongo::ParallelSortClusteredCursor.

---

Member Data Documentation

int mongo::ClusteredCursor::_batchSize [protected]

Definition at line 102 of file parallel.h.

bool mongo::ClusteredCursor::_didInit [protected]

Definition at line 104 of file parallel.h.

bool mongo::ClusteredCursor::_done [protected]

Definition at line 106 of file parallel.h.

BSONObj mongo::ClusteredCursor::_fields [protected]

Definition at line 101 of file parallel.h.

string mongo::ClusteredCursor::_ns [protected]

Definition at line 98 of file parallel.h.

int mongo::ClusteredCursor::_options [protected]

Definition at line 100 of file parallel.h.

BSONObj mongo::ClusteredCursor::_query [protected]

Definition at line 99 of file parallel.h.

---

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

• parallel.h