org.rvpf.store.server.sink

Interface SinkModule

All Known Implementing Classes:

NullSink, PipeSink, ScriptSink, SinkModule.Abstract

public interface SinkModule

Sink module.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SinkModule.Abstract Abstract sink module.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this sink.
boolean	delete(VersionedValue versionedValue) Deletes a value.
void	open() Opens this Sink.
boolean	setUp(SinkServiceAppImpl sinkAppImpl) Sets up the sink for action.
void	tearDown() Tears down what has been set up.
boolean	update(VersionedValue versionedValue) Updates a value.

Method Detail

close

void close()

Closes this sink.

delete

@CheckReturnValue
boolean delete(@Nonnull
                                  VersionedValue versionedValue)

Deletes a value.

Parameters:

versionedValue - The point value to delete.

Returns:

True if notification may proceed.

open

void open()
   throws ServiceNotReadyException

Opens this Sink.

Throws:

ServiceNotReadyException - When the service is not ready.

setUp

@CheckReturnValue
boolean setUp(@Nonnull
                                 SinkServiceAppImpl sinkAppImpl)

Sets up the sink for action.

Parameters:

sinkAppImpl - The sink application implementation.

Returns:

True on success.

tearDown

void tearDown()

Tears down what has been set up.

update

@CheckReturnValue
boolean update(@Nonnull
                                  VersionedValue versionedValue)

Updates a value.

Parameters:

versionedValue - The new point value.

Returns:

True if notification may proceed.