akka.contrib.pattern
Interface Aggregator


public interface Aggregator

The aggregator is to be mixed into an actor for the aggregator behavior.


Method Summary
 WorkList<scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>> addBuffer()
           
 scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> expect(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> fn)
          Adds the partial function to the receive set and keeping it in the receive set till removed.
 WorkList<scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>> expectList()
           
 scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> expectOnce(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> fn)
          Adds the partial function to the receive set, to be removed on first match.
 boolean handleMessage(java.lang.Object msg)
          Handles messages and matches against the expect list.
 boolean processing()
           
 scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive()
          Receive function for handling the aggregations.
 boolean unexpect(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> fn)
          Removes the partial function from the receive set.
 

Method Detail

processing

boolean processing()

expectList

WorkList<scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>> expectList()

addBuffer

WorkList<scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>> addBuffer()

expectOnce

scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> expectOnce(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> fn)
Adds the partial function to the receive set, to be removed on first match.

Parameters:
fn - The receive function.
Returns:
The same receive function.

expect

scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> expect(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> fn)
Adds the partial function to the receive set and keeping it in the receive set till removed.

Parameters:
fn - The receive function.
Returns:
The same receive function.

unexpect

boolean unexpect(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> fn)
Removes the partial function from the receive set.

Parameters:
fn - The receive function.
Returns:
True if the partial function is removed, false if not found.

receive

scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive()
Receive function for handling the aggregations.

Returns:
(undocumented)

handleMessage

boolean handleMessage(java.lang.Object msg)
Handles messages and matches against the expect list.

Parameters:
msg - The message to be handled.
Returns:
true if message is successfully processed, false otherwise.