Package co.paralleluniverse.actors.behaviors

Class EventSourceActor<Event>

java.lang.Object

co.paralleluniverse.actors.ActorImpl<Message>

co.paralleluniverse.actors.Actor<java.lang.Object,java.lang.Void>

co.paralleluniverse.actors.behaviors.BehaviorActor

co.paralleluniverse.actors.behaviors.EventSourceActor<Event>

All Implemented Interfaces:

ActorBuilder<java.lang.Object,java.lang.Void>, Joinable<java.lang.Void>, Port<java.lang.Object>, PortAutoCloseable, ReceivePort<java.lang.Object>, Stranded, SuspendableCallable<java.lang.Void>, java.io.Serializable, java.lang.AutoCloseable

public class EventSourceActor<Event>
extends BehaviorActor

A behavior actor that can be notified of *event* messages, which are delivered to *event handlers* which may be registered with the actor. The event handlers are called synchronously on the same strand as the actor's, so they may delay processing by other handlers if they block the strand.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class co.paralleluniverse.actors.ActorImpl

ActorImpl.ActorLifecycleListener

Nested classes/interfaces inherited from interface co.paralleluniverse.strands.channels.ReceivePort

ReceivePort.EOFException

Field Summary

Fields inherited from class co.paralleluniverse.actors.ActorImpl

flightRecorder, ref

Constructor Summary

Constructors

Constructor	Description
EventSourceActor()	Creates a new event-source actor.
EventSourceActor(Initializer initializer)	Creates a new event-source actor.
EventSourceActor(Initializer initializer, MailboxConfig mailboxConfig)	Creates a new event-source actor.
EventSourceActor(MailboxConfig mailboxConfig)	Creates a new event-source actor.
EventSourceActor(java.lang.String name)	Creates a new event-source actor.
EventSourceActor(java.lang.String name, Initializer initializer)	Creates a new event-source actor.
EventSourceActor(java.lang.String name, Initializer initializer, MailboxConfig mailboxConfig)	Creates a new event-source actor.
EventSourceActor(java.lang.String name, Initializer initializer, Strand strand, MailboxConfig mailboxConfig)	Creates a new event-source actor.
EventSourceActor(java.lang.String name, MailboxConfig mailboxConfig)	Creates a new event-source actor.

Method Summary

Modifier and Type	Method	Description
protected boolean	addHandler(EventHandler<Event> handler)
static <Event> EventSourceActor<Event>	currentEventSourceActor()
protected void	handleMessage(java.lang.Object m1)	Called by the default BehaviorActor.behavior() method to handle each incoming message.
org.slf4j.Logger	log()	The Logger object associated with this actor.
protected EventSource<Event>	makeRef(ActorRef<java.lang.Object> ref)
protected void	notify(Event event)
protected void	onTerminate(java.lang.Throwable cause)	This method is called by the BehaviorActor at the end of BehaviorActor.doRun().
EventSource<Event>	ref()	Returns the ActorRef to this actor, if it has been started.
protected boolean	removeHandler(EventHandler<Event> handler)
protected EventSource<Event>	self()	Returns the ActorRef to this actor, if it has been started.
EventSource<Event>	spawn()	Starts a new fiber and runs the actor in it.
EventSource<Event>	spawn(FiberFactory ff)	Starts a new fiber using the given scheduler and runs the actor in it.
EventSource<Event>	spawn(StrandFactory sf)	Starts a new fiber using the given scheduler and runs the actor in it.
EventSource<Event>	spawnThread()	Starts a new thread and runs the actor in it.

Methods inherited from class co.paralleluniverse.actors.behaviors.BehaviorActor

behavior, checkCodeSwap, doRun, getInitializer, handleLifecycleMessage, init, isRunning, onStart, shutdown, terminate

Methods inherited from class co.paralleluniverse.actors.Actor

addLifecycleListener, build, checkThrownIn, close, currentActor, filterMessage, get, get, getActor, getDeathCause, getMonitor, getName, getQueueLength, getStrand, hire, hire, internalSend, internalSendNonSuspendable, interrupt, isClosed, isDone, isInActor, isRegistered, isStarted, join, join, link, linked, mailbox, migrate, migrateAndRestart, monitor, monitorAddDeath, monitorAddMessage, monitorResetSkippedMessages, monitorSkippedMessage, newActor, newActor, onCodeChange, readResolve, receive, receive, receive, register, register, reinstantiate, removeLifecycleListener, removeObserverListeners, run, sendSync, setForwardWatch, setMonitor, setName, setStrand, start, stopMonitor, throwIn, toString, tryReceive, trySend, unlink, unlinked, unregister, unwatch, verifyInActor, verifyOnActorStrand, watch, writeReplace

Methods inherited from class co.paralleluniverse.actors.ActorImpl

close, getLifecycleListener, getMailbox, isRecordingLevel, record, record, record, record, record, record, record, sendOrInterrupt

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EventSourceActor

public EventSourceActor(java.lang.String name,
                        Initializer initializer,
                        Strand strand,
                        MailboxConfig mailboxConfig)

Creates a new event-source actor.

Parameters:

name - the actor name (may be null).

initializer - an optional delegate object that will be run upon actor initialization and termination. May be null.

strand - this actor's strand.

mailboxConfig - this actor's mailbox settings.

EventSourceActor

public EventSourceActor(java.lang.String name,
                        Initializer initializer,
                        MailboxConfig mailboxConfig)

Creates a new event-source actor.

Parameters:

name - the actor name (may be null).

initializer - an optional delegate object that will be run upon actor initialization and termination. May be null.

mailboxConfig - this actor's mailbox settings.

EventSourceActor

public EventSourceActor(java.lang.String name,
                        Initializer initializer)

Creates a new event-source actor.

Parameters:

name - the actor name (may be null).

initializer - an optional delegate object that will be run upon actor initialization and termination. May be null.

EventSourceActor

public EventSourceActor(Initializer initializer,
                        MailboxConfig mailboxConfig)

Creates a new event-source actor.

Parameters:

initializer - an optional delegate object that will be run upon actor initialization and termination. May be null.

mailboxConfig - this actor's mailbox settings.

EventSourceActor

public EventSourceActor(Initializer initializer)

Creates a new event-source actor.

Parameters:

initializer - an optional delegate object that will be run upon actor initialization and termination. May be null.

EventSourceActor

public EventSourceActor(java.lang.String name,
                        MailboxConfig mailboxConfig)

Creates a new event-source actor.

Parameters:

name - the actor name (may be null).

mailboxConfig - this actor's mailbox settings.

EventSourceActor

public EventSourceActor(java.lang.String name)

Creates a new event-source actor.

Parameters:

name - the actor name (may be null).

EventSourceActor

public EventSourceActor(MailboxConfig mailboxConfig)

Creates a new event-source actor.

Parameters:

mailboxConfig - this actor's mailbox settings.

EventSourceActor

public EventSourceActor()

Creates a new event-source actor.

Method Detail

makeRef

protected EventSource<Event> makeRef(ActorRef<java.lang.Object> ref)

Overrides:

makeRef in class BehaviorActor

ref

public EventSource<Event> ref()

Description copied from class: Actor

Returns the ActorRef to this actor, if it has been started.

Overrides:

ref in class BehaviorActor

Returns:

the ActorRef of this actor if it has been started, or null otherwise.

self

protected EventSource<Event> self()

Description copied from class: Actor

Returns the ActorRef to this actor, if it has been started.

Overrides:

self in class BehaviorActor

Returns:

the ActorRef of this actor if it has been started, or null otherwise.

spawn

public EventSource<Event> spawn(StrandFactory sf)

Description copied from class: Actor

Starts a new fiber using the given scheduler and runs the actor in it. The fiber's name will be set to this actor's name.

Overrides:

spawn in class BehaviorActor

Parameters:

sf - the factory (or scheduler) that will be used to create the actor's fiber.

Returns:

This actors' ActorRef

spawn

public EventSource<Event> spawn(FiberFactory ff)

Description copied from class: Actor

Starts a new fiber using the given scheduler and runs the actor in it. The fiber's name will be set to this actor's name.

Overrides:

spawn in class BehaviorActor

Parameters:

ff - the factory (or scheduler) that will be used to create the actor's fiber.

Returns:

This actors' ActorRef

spawn

public EventSource<Event> spawn()

Description copied from class: Actor

Starts a new fiber and runs the actor in it. The fiber's name will be set to this actor's name.

Overrides:

spawn in class BehaviorActor

Returns:

This actors' ActorRef

spawnThread

public EventSource<Event> spawnThread()

Description copied from class: Actor

Starts a new thread and runs the actor in it. The fiber's name will be set to this actor's name.

Overrides:

spawnThread in class BehaviorActor

Returns:

This actors' ActorRef

currentEventSourceActor

public static <Event> EventSourceActor<Event> currentEventSourceActor()

log

public org.slf4j.Logger log()

Description copied from class: BehaviorActor

The Logger object associated with this actor.

Specified by:

log in class BehaviorActor

addHandler

protected boolean addHandler(EventHandler<Event> handler)
                      throws SuspendExecution,
                             java.lang.InterruptedException

Throws:

SuspendExecution

java.lang.InterruptedException

removeHandler

protected boolean removeHandler(EventHandler<Event> handler)
                         throws SuspendExecution,
                                java.lang.InterruptedException

Throws:

SuspendExecution

java.lang.InterruptedException

notify

protected void notify(Event event)
               throws SuspendExecution

Throws:

SuspendExecution

handleMessage

protected final void handleMessage(java.lang.Object m1)
                            throws java.lang.InterruptedException,
                                   SuspendExecution

Description copied from class: BehaviorActor

Called by the default BehaviorActor.behavior() method to handle each incoming message. By default, this method does nothing.

Overrides:

handleMessage in class BehaviorActor

Parameters:

m1 - the message received by the actor.

Throws:

java.lang.InterruptedException

SuspendExecution

onTerminate

protected void onTerminate(java.lang.Throwable cause)
                    throws SuspendExecution,
                           java.lang.InterruptedException

Description copied from class: BehaviorActor

This method is called by the BehaviorActor at the end of BehaviorActor.doRun(). By default, this method calls terminate().

Overrides:

onTerminate in class BehaviorActor

Throws:

SuspendExecution

java.lang.InterruptedException