org.rvpf.processor.receptionist

Class SOMReceptionist

Object

Receptionist.Abstract

SOMReceptionist

All Implemented Interfaces:

Receptionist

public final class SOMReceptionist
extends Receptionist.Abstract

SOM receptionist.

Nested Class Summary

Nested classes/interfaces inherited from interface Receptionist

Receptionist.Abstract

Field Summary

Fields

Modifier and Type	Field and Description
static String	QUEUE_PROPERTIES The reception queue properties.

Fields inherited from class Receptionist.Abstract

DEFAULT_WAIT, WAIT_PROPERTY

Constructor Summary

Constructors

Constructor and Description
SOMReceptionist()

Method Summary

Modifier and Type	Method and Description
protected void	doClose() Closes the input Queue.
protected void	doCommit() Registers that the notices have been processed.
protected Optional<PointValue>	doFetchNotice(int limit, long wait) Fetches a notice.
protected void	doOpen() Opens the input Queue.
protected void	doRollback() Forgets that the notices have been received.
boolean	setUp(Metadata metadata) Sets up access to the messaging system.
void	tearDown() Tears down what has been set up.

Methods inherited from class Receptionist.Abstract

close, commit, fetchNotices, getMetadata, getThisLogger, open, receptionTime, rollback

Methods inherited from class Object

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

Field Detail

QUEUE_PROPERTIES

public static final String QUEUE_PROPERTIES

The reception queue properties.

See Also:

Constant Field Values

Constructor Detail

SOMReceptionist

public SOMReceptionist()

Method Detail

setUp

public boolean setUp(Metadata metadata)

Sets up access to the messaging system.

Specified by:

setUp in interface Receptionist

Overrides:

setUp in class Receptionist.Abstract

Parameters:

metadata - The processor metadata.

Returns:

True on success.

tearDown

public void tearDown()

Tears down what has been set up.

Specified by:

tearDown in interface Receptionist

Overrides:

tearDown in class Receptionist.Abstract

doClose

protected void doClose()

Closes the input Queue.

Called while synchronized on this. May be called while already closed.

Specified by:

doClose in class Receptionist.Abstract

doCommit

protected void doCommit()
                 throws InterruptedException,
                        ServiceNotAvailableException

Registers that the notices have been processed.

Called while synchronized on this.

Specified by:

doCommit in class Receptionist.Abstract

Throws:

InterruptedException - When the Service is stopped.

ServiceNotAvailableException - When the service is not available.

doFetchNotice

protected Optional<PointValue> doFetchNotice(int limit,
                                             long wait)
                                      throws ServiceNotAvailableException

Fetches a notice.

Specified by:

doFetchNotice in class Receptionist.Abstract

Parameters:

limit - The read ahead limit.

wait - Negative is forever, 0 is no wait, other is milliseconds.

Returns:

A point value (empty on timeout).

Throws:

ServiceNotAvailableException - When the service is not available.

doOpen

protected void doOpen()

Opens the input Queue.

Called while synchronized on this.

Specified by:

doOpen in class Receptionist.Abstract

doRollback

protected void doRollback()
                   throws InterruptedException,
                          ServiceNotAvailableException

Forgets that the notices have been received.

Specified by:

doRollback in class Receptionist.Abstract

Throws:

InterruptedException - When the Service is stopped.

ServiceNotAvailableException - When the service is not available.