org.agilewiki.jactor.apc

Interface APCMailbox

All Superinterfaces:

BufferedEventsDestination<JAMessage>

All Known Subinterfaces:

Mailbox

All Known Implementing Classes:

JAPCMailbox, JLPCMailbox

public interface APCMailbox
extends BufferedEventsDestination<JAMessage>

Serves as the asynchronous transport for APCMessages.

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	response(JARequest jaRequest, Object unwrappedResponse)
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 interface org.agilewiki.jactor.bufferedEvents.BufferedEventsDestination

putBufferedEvents

Method Detail

getExceptionHandler

ExceptionHandler getExceptionHandler()

Returns the exception handler.

Returns:

The exception handler.

setExceptionHandler

void setExceptionHandler(ExceptionHandler exceptionHandler)

Assign an exception handler.

Parameters:

exceptionHandler - The exception handler.

getCurrentRequest

JARequest getCurrentRequest()

Returns the request message being processed.

Returns:

The request message being processed.

setCurrentRequest

void setCurrentRequest(JARequest currentRequest)

Assigns the request message to be processed.

Parameters:

currentRequest - The request message being processed.

sendPendingMessages

void sendPendingMessages()

Send any pending messages.

setInitialBufferCapacity

void setInitialBufferCapacity(int initialBufferCapacity)

Set the initial capacity for buffered outgoing messages.

Parameters:

initialBufferCapacity - The initial capacity for buffered outgoing messages.

send

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

Buffer the request for subsequent sending.

Parameters:

destination - Buffered events receiver.

request - The request to be sent.

response

void response(JARequest jaRequest,
            Object unwrappedResponse)

isEmpty

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.

dispatchEvents

boolean dispatchEvents()

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

getEventQueue

EventQueue<ArrayList<JAMessage>> getEventQueue()

Returns the event queue.

Returns:

The event queue.