org.agilewiki.jactor.apc

Class JAPCMailbox

java.lang.Object

org.agilewiki.jactor.apc.JAPCMailbox

All Implemented Interfaces:

APCMailbox, BufferedEventsDestination<JAMessage>

Direct Known Subclasses:

JLPCMailbox

public class JAPCMailbox
extends Object
implements APCMailbox

An implementation of APCMailbox.

Constructor Summary

Constructors

Constructor and Description
JAPCMailbox(BufferedEventsQueue<JAMessage> bufferedEventQueue, MailboxFactory mailboxFactory) Create a JAPCMailbox.
JAPCMailbox(ThreadManager threadManager, boolean autonomous, MailboxFactory mailboxFactory) Create a JAPCMailbox.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	dispatchEvents() The dispatchMessages method processes any messages in the queue.
JARequest	getCurrentRequest() Returns the request message being processed.
EventQueue<ArrayList<JAMessage>>	getEventQueue() Returns the event queue.
ExceptionHandler	getExceptionHandler() Returns the exception handler.
boolean	isEmpty() The isEmpty method returns true when there are no pending messages, though the results may not always be correct due to concurrency issues.
void	putBufferedEvents(ArrayList<JAMessage> bufferedEvents) The putBufferedEvents method adds events to be processed.
void	response(JARequest jaRequest, Object unwrappedResponse) _ReturnF the response for processing.
void	send(BufferedEventsDestination<JAMessage> destination, JARequest request) Buffer the request for subsequent sending.
void	sendPendingMessages() Send any pending Messages.
void	setCurrentRequest(JARequest currentRequest) Assigns the request message to be processed.
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

JAPCMailbox

public JAPCMailbox(BufferedEventsQueue<JAMessage> bufferedEventQueue,
           MailboxFactory mailboxFactory)

Create a JAPCMailbox. Use this constructor when providing an implementation of BufferedEventsQueue other than JABufferedEventsQueue.

Parameters:

bufferedEventQueue - The lower-level mailbox which transports messages as 1-way events.

JAPCMailbox

public JAPCMailbox(ThreadManager threadManager,
           boolean autonomous,
           MailboxFactory mailboxFactory)

Create a JAPCMailbox.

Parameters:

threadManager - Provides a thread for processing dispatched events.

autonomous - Inhibits the acquireControl operation when true.

Method Detail

getExceptionHandler

public final ExceptionHandler getExceptionHandler()

Returns the exception handler.

Specified by:

getExceptionHandler in interface APCMailbox

Returns:

The exception handler.

setExceptionHandler

public final void setExceptionHandler(ExceptionHandler exceptionHandler)

Assign an exception handler.

Specified by:

setExceptionHandler in interface APCMailbox

Parameters:

exceptionHandler - The exception handler.

getCurrentRequest

public final JARequest getCurrentRequest()

Returns the request message being processed.

Specified by:

getCurrentRequest in interface APCMailbox

Returns:

The request message being processed.

setCurrentRequest

public final void setCurrentRequest(JARequest currentRequest)

Assigns the request message to be processed.

Specified by:

setCurrentRequest in interface APCMailbox

Parameters:

currentRequest - The request message being processed.

isEmpty

public final boolean isEmpty()

The isEmpty method returns true when there are no pending messages, though the results may not always be correct due to concurrency issues.

Specified by:

isEmpty in interface APCMailbox

dispatchEvents

public boolean dispatchEvents()

The dispatchMessages method processes any messages in the queue. True is returned if any messages were actually processed.

Specified by:

dispatchEvents in interface APCMailbox

putBufferedEvents

public final void putBufferedEvents(ArrayList<JAMessage> bufferedEvents)

The putBufferedEvents method adds events to be processed.

Specified by:

putBufferedEvents in interface BufferedEventsDestination<JAMessage>

Parameters:

bufferedEvents - The events to be processed.

sendPendingMessages

public final void sendPendingMessages()

Send any pending Messages.

Specified by:

sendPendingMessages in interface APCMailbox

setInitialBufferCapacity

public final void setInitialBufferCapacity(int initialBufferCapacity)

Set the initial capacity for buffered outgoing messages.

Specified by:

setInitialBufferCapacity in interface APCMailbox

Parameters:

initialBufferCapacity - The initial capacity for buffered outgoing messages.

send

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

Buffer the request for subsequent sending.

Specified by:

send in interface APCMailbox

Parameters:

destination - Buffered events receiver.

request - The request to be sent.

response

public final void response(JARequest jaRequest,
            Object unwrappedResponse)

_ReturnF the response for processing.

Specified by:

response in interface APCMailbox

Parameters:

unwrappedResponse -

getEventQueue

public EventQueue<ArrayList<JAMessage>> getEventQueue()

Returns the event queue.

Specified by:

getEventQueue in interface APCMailbox

Returns:

The event queue.