org.rvpf.processor.receptionist

Interface Receptionist

All Known Implementing Classes:

Receptionist.Abstract, SOMReceptionist, StoreListenerReceptionist

public interface Receptionist

Receptionist.

The receptionist protocol is used by the processor to receive the point value change event notices.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Receptionist.Abstract Abstract receptionist.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the input Queue.
void	commit() Registers that the notices have been processed.
List<PointValue>	fetchNotices(int limit, long wait) Fetches notices.
void	open() Opens the input Queue.
long	receptionTime() Returns and resets the reception time.
void	rollback() 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.

Method Detail

close

void close()

Closes the input Queue.

commit

void commit()
     throws InterruptedException,
            ServiceNotAvailableException

Registers that the notices have been processed.

Throws:

InterruptedException - When the service is stopped.

ServiceNotAvailableException - When the service is not available.

fetchNotices

@Nonnull
 @CheckReturnValue
List<PointValue> fetchNotices(int limit,
                                                            long wait)
                                                     throws InterruptedException,
                                                            ServiceNotAvailableException

Fetches notices.

Parameters:

limit - The limit for the number of notices.

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

Returns:

The notices.

Throws:

InterruptedException - When the service is stopped.

ServiceNotAvailableException - When the service is not available.

open

void open()

Opens the input Queue.

receptionTime

@CheckReturnValue
long receptionTime()

Returns and resets the reception time.

Returns:

The reception time.

rollback

void rollback()
       throws InterruptedException,
              ServiceNotAvailableException

Forgets that the notices have been received.

Throws:

InterruptedException - When the service is stopped.

ServiceNotAvailableException - When the service is not available.

setUp

@CheckReturnValue
boolean setUp(Metadata metadata)

Sets up access to the messaging system.

Parameters:

metadata - The processor metadata.

Returns:

True on success.

tearDown

void tearDown()

Tears down what has been set up.