Oracle® Fusion Middleware C++ API Reference for Oracle Coherence: AbstractKeyBundler::Bundle Class Reference

Detailed Description

Bundle

Public Types

typedef spec::Handle

Handle

Bundle Handle definition.

typedef spec::View

View

Bundle View definition.

typedef spec::Holder

Holder

Bundle Holder definition.

Public Member Functions

virtual bool

add (Object::Holder ohKey)

Add the specified key to the Bundle.

virtual bool

addAll (Collection::View vColKeys)

Add the specified collection of keys to the Bundle.

virtual Object::Holder

process (bool fBurst, Object::Holder ohKey)

Process the specified key according to this Bundle state.

virtual Map::View

processAll (bool fBurst, Collection::View vColKeys)

Process the specified kye collection according to this Bundle state.

virtual int32_t

getBundleSize () const

Obtain this bundle size.

The return value should be expressed in the same units as the value returned by the getSizeThreshold method.

Returns:: the bundle size

virtual void

ensureResults ()

Obtain results of the bundled requests.

This method should be implemented by concrete Bundle implementations using the most efficient mechanism.

virtual bool

releaseThread ()

Release all bundle resources associated with the current thread.

Returns:: true if all entered threads have released

Protected Member Functions

Bundle (AbstractBundler::Handle hBundler)

Default constructor.

Constructor & Destructor Documentation

Bundle ( AbstractBundler::Handle hBundler ) [protected]

Default constructor.

Parameters:

hBundler

the AbstructBundler

Reimplemented from AbstractBundler::Bundle.

Member Function Documentation

virtual bool add ( Object::Holder ohKey ) [virtual]

Add the specified key to the Bundle.

Note: a call to this method must be externally synchronized for this Bundle object.

Parameters:

ohKey

the key to add to this Bundle

Returns:: true if this Bundle was empty prior to this call

virtual bool addAll ( Collection::View vColKeys ) [virtual]

Add the specified collection of keys to the Bundle.

Note: a call to this method must be externally synchronized for this Bundle object.

Parameters:

vColKeys

the collection of keys to add to this Bundle

Returns:: true if this Bundle was empty prior to this call

virtual Object::Holder process	(	bool	fBurst,
		Object::Holder	ohKey
	)			`[virtual]`

Process the specified key according to this Bundle state.

Parameters:

	fBurst	true if this thread is supposed to perform an actual bundled operation (burst); false otherwise
	ohKey	the key to process

Returns:: an execution result according to the caller's contract

virtual Map::View processAll	(	bool	fBurst,
		Collection::View	vColKeys
	)			`[virtual]`

Process the specified kye collection according to this Bundle state.

Parameters:

	fBurst	true if this thread is supposed to perform an actual bundled operation (burst); false otherwise
	vColKeys	the collection of keys to process

Returns:: an execution result according to the caller's contract