Oracle Coherence for C++ API
Release 3.7.1.0

E22845-01

PriorityProcessor Class Reference

#include <coherence/util/processor/PriorityProcessor.hpp>

Inherits AbstractPriorityTask, InvocableMap::EntryProcessor, and PortableObject.

List of all members.


Detailed Description

PriorityProcessor is used to explicitly control the scheduling priority and timeouts for execution of EntryProcessor-based methods.

Author:
tb 2008.05.23
 

Public Types

typedef spec::Handle Handle
 PriorityProcessor Handle definition.
typedef spec::View View
 PriorityProcessor View definition.
typedef spec::Holder Holder
 PriorityProcessor Holder definition.

Public Member Functions

virtual Object::Holder process (InvocableMap::Entry::Handle hEntry) const
 Process a Map::Entry object.

Parameters:
 hEntry the Entry to process
Returns:
the result of the processing, if any
virtual Map::View processAll (Set::View vSetEntries) const
 Process a Set of InvocableMap::Entry objects.

This method is semantically equivalent to:

   Map::Handle hMapResults = HashMap::create();
   for (Iterator::Handle hIter = vSetEntries->iterator();
       iter->hasNext; )
       {
       InvocableMap::Entry::Handle hEntry =
               cast<InvocableMap::Entry::Handle>(hIter->next());
       hMapResults->put(hEntry->getKey(), process(hEntry));
       }
   return hMapResults;
 

Parameters:
 vSetEntries a Set of InvocableMap::Entry objects to process
Returns:
a Map containing the results of the processing, up to one entry for each InvocableMap::Entry that was processed, keyed by the keys of the Map that were processed, with a corresponding value being the result of the processing for each key
virtual
InvocableMap::EntryProcessor::View 
getProcessor () const
 Obtain the underlying processor.
virtual void readExternal (PofReader::Handle hIn)
  
virtual void writeExternal (PofWriter::Handle hOut) const
  
virtual void toStream (std::ostream &out) const
 Output a human-readable description of this Object to the given stream.

coherence::lang::operator<<(std::ostream, Object::View) is defined and will call into the toStream method, to output Objects. If a managed String object is desired, the COH_TO_STRING macro can be used to build up a String from streamable contents.

 Object::View vKey   = ...
 Object::View vValue = ...
 std::cout << vKey << " = " << vValue << std::endl;

 String::Handle hs = COH_TO_STRING(vKey << " = " << vValue);

Parameters:
 out the stream used to output the description

Protected Member Functions

 PriorityProcessor ()
 Construct a PriorityProcessor.
 PriorityProcessor (InvocableMap::EntryProcessor::View vProcessor)
 Construct a PriorityProcessor.

Protected Attributes

MemberView
< InvocableMap::EntryProcessor
m_vProcessor
 The underlying entry processor.

Constructor & Destructor Documentation

PriorityProcessor (  )  [protected]

Construct a PriorityProcessor.

Returns:
a new PriorityProcessor

PriorityProcessor ( InvocableMap::EntryProcessor::View  vProcessor  )  [protected]

Construct a PriorityProcessor.

Parameters:
 processor the processor wrapped by this PriorityProcessor


Member Function Documentation

virtual InvocableMap::EntryProcessor::View getProcessor (  )  const [virtual]

Obtain the underlying processor.

Returns:
the processor wrapped by this PriorityProcessor


The documentation for this class was generated from the following file:
Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.