org.agilewiki.jactor.lpc

Class JLPCActor

java.lang.Object

org.agilewiki.jactor.lpc.JLPCActor

All Implemented Interfaces:

Actor, APCRequestSource, RequestProcessor, RequestSource, TargetActor

Direct Known Subclasses:

JActorName, JAFactory, JANBLock, JAProperties

public abstract class JLPCActor
extends Object
implements TargetActor, RequestProcessor, RequestSource

An actor which implements Local Procedure Calls (LPC) and mostly works synchronously. Actors need to implement the processRequest method.

 public class Multiply {
     public int a;
     public int b;
 }

 public class Multiplier extends JLPCActor {

     public Multiplier(Mailbox mailbox) {
         super(mailbox);
     }

     protected void processRequest(Object req, RP rp)
             throws Exception {
         Multiply m = (Multiply) req;
         rp.process(new Integer(m.a * m.b));
     }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JLPCActor.SMBuilder Creates a _SMBuilder.

Constructor Summary

Constructors

Constructor and Description
JLPCActor()

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptEvent(APCRequestSource apcRequestSource, Request request) Wraps and enqueues an unwrapped request in the requester's inbox.
void	acceptRequest(APCRequestSource apcRequestSource, Request request, RP rp) Wraps and enqueues an unwrapped request in the requester's inbox.
String	getActorType() Returns the actor type.
JLPCActor	getAncestor(Class targetClass) Returns A matching ancestor from the parent chain.
ExceptionHandler	getExceptionHandler() Returns the exception handler.
ActorFactory	getFactory() Returns the factory.
Mailbox	getMailbox() Returns the actor's mailbox.
MailboxFactory	getMailboxFactory() Returns the mailbox factory.
JLPCActor	getMatch(Class targetClass)
JLPCActor	getParent() Returns the actor's parent.
boolean	hasDataItem(String name) Returns true when the concurrent data of the actor, or its parent, contains the named data item.
void	haveEvents() A notification that there are incoming requests and responses that are ready for processing.
void	initialize() Initialize a degraded LiteActor
void	initialize(Actor parent) Initialize a degraded LiteActor
void	initialize(Mailbox mailbox) Initialize a LiteActor
void	initialize(Mailbox mailbox, Actor parent) Initialize a LiteActor
void	initialize(Mailbox mailbox, Actor parent, ActorFactory factory) Initialize a LiteActor
protected Requirement[]	requirements() Returns the actor's requirements.
void	responseFrom(BufferedEventsQueue<JAMessage> eventQueue, JAResponse japcResponse) Enqueues the response in the responder's outbox.
protected void	send(Actor actor, Request request, RP rp) Send a request to another actor.
void	send(BufferedEventsDestination<JAMessage> destination, JARequest japcRequest) Sends a request to a mailbox.
protected void	sendEvent(Actor actor, Request request) Send a request to another actor and discard any response.
void	setExceptionHandler(ExceptionHandler exceptionHandler) Assign an exception handler.
void	setInitialBufferCapacity(int initialBufferCapacity) Set the initial capacity for buffered outgoing messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

JLPCActor

public JLPCActor()

Method Detail

initialize

public final void initialize()
                      throws Exception

Initialize a degraded LiteActor

Throws:

Exception

initialize

public final void initialize(Actor parent)
                      throws Exception

Initialize a degraded LiteActor

Parameters:

parent - The parent actor.

Throws:

Exception

initialize

public final void initialize(Mailbox mailbox)
                      throws Exception

Initialize a LiteActor

Parameters:

mailbox - A mailbox which may be shared with other actors.

Throws:

Exception

initialize

public final void initialize(Mailbox mailbox,
              Actor parent)
                      throws Exception

Initialize a LiteActor

Parameters:

mailbox - A mailbox which may be shared with other actors.

parent - The parent actor.

Throws:

Exception

initialize

public void initialize(Mailbox mailbox,
              Actor parent,
              ActorFactory factory)
                throws Exception

Initialize a LiteActor

Parameters:

mailbox - A mailbox which may be shared with other actors.

parent - The parent actor.

factory - The factory.

Throws:

Exception

getParent

public final JLPCActor getParent()

Returns the actor's parent.

Specified by:

getParent in interface Actor

Returns:

The actor's parent, or null.

getMatch

public JLPCActor getMatch(Class targetClass)

Specified by:

getMatch in interface Actor

getAncestor

public final JLPCActor getAncestor(Class targetClass)

Returns A matching ancestor from the parent chain.

Specified by:

getAncestor in interface Actor

Parameters:

targetClass - A class which the ancestor is an instanceof.

Returns:

The matching ancestor, or null.

requirements

protected Requirement[] requirements()
                              throws Exception

Returns the actor's requirements.

Returns:

The actor's requirents.

Throws:

Exception

getActorType

public final String getActorType()

Returns the actor type.

Specified by:

getActorType in interface Actor

Returns:

The actor type, or null.

getFactory

public final ActorFactory getFactory()

Returns the factory.

Specified by:

getFactory in interface Actor

Returns:

The factory, or null.

getExceptionHandler

public final ExceptionHandler getExceptionHandler()

Returns the exception handler.

Specified by:

getExceptionHandler in interface RequestProcessor

Specified by:

getExceptionHandler in interface RequestSource

Returns:

The exception handler.

setExceptionHandler

public final void setExceptionHandler(ExceptionHandler exceptionHandler)

Assign an exception handler.

Specified by:

setExceptionHandler in interface RequestProcessor

Specified by:

setExceptionHandler in interface RequestSource

Specified by:

setExceptionHandler in interface TargetActor

Parameters:

exceptionHandler - The exception handler.

haveEvents

public final void haveEvents()

A notification that there are incoming requests and responses that are ready for processing.

Specified by:

haveEvents in interface RequestProcessor

getMailbox

public final Mailbox getMailbox()

Returns the actor's mailbox.

Specified by:

getMailbox in interface Actor

Specified by:

getMailbox in interface RequestSource

Returns:

The actor's mailbox.

responseFrom

public final void responseFrom(BufferedEventsQueue<JAMessage> eventQueue,
                JAResponse japcResponse)

Enqueues the response in the responder's outbox.

Specified by:

responseFrom in interface APCRequestSource

Parameters:

eventQueue - The responder's outbox.

japcResponse - The wrapped response to be enqueued.

send

public final void send(BufferedEventsDestination<JAMessage> destination,
        JARequest japcRequest)

Sends a request to a mailbox.

Specified by:

send in interface APCRequestSource

Parameters:

destination - The mailbox which is to receive the request.

japcRequest - The wrapped request to be sent.

setInitialBufferCapacity

public final void setInitialBufferCapacity(int initialBufferCapacity)

Set the initial capacity for buffered outgoing messages.

Specified by:

setInitialBufferCapacity in interface Actor

Parameters:

initialBufferCapacity - The initial capacity for buffered outgoing messages.

acceptRequest

public final void acceptRequest(APCRequestSource apcRequestSource,
                 Request request,
                 RP rp)
                         throws Exception

Wraps and enqueues an unwrapped request in the requester's inbox.

Specified by:

acceptRequest in interface Actor

Parameters:

apcRequestSource - The originator of the request.

request - The request to be sent.

rp - The request processor.

Throws:

Exception - Any uncaught exceptions raised while processing the request.

acceptEvent

public final void acceptEvent(APCRequestSource apcRequestSource,
               Request request)
                       throws Exception

Wraps and enqueues an unwrapped request in the requester's inbox.

Specified by:

acceptEvent in interface Actor

Parameters:

apcRequestSource - The originator of the request.

request - The request to be sent.

Throws:

Exception - Any uncaught exceptions raised while processing the request.

send

protected final void send(Actor actor,
        Request request,
        RP rp)
                   throws Exception

Send a request to another actor.

Parameters:

actor - The target actor.

request - The request.

rp - The response processor.

Throws:

Exception - Any uncaught exceptions raised while processing the request.

sendEvent

protected final void sendEvent(Actor actor,
             Request request)

Send a request to another actor and discard any response.

Parameters:

actor - The target actor.

request - The request.

getMailboxFactory

public final MailboxFactory getMailboxFactory()

Returns the mailbox factory.

Returns:

The mailbox factory.

hasDataItem

public final boolean hasDataItem(String name)

Returns true when the concurrent data of the actor, or its parent, contains the named data item.

Specified by:

hasDataItem in interface Actor

Parameters:

name - The key for the data item.

Returns:

True when the concurrent data of the actor, or its parent, contains the named data item.