org.rvpf.pap

Interface PAPServer

All Known Implementing Classes:

DNP3Outstation, ModbusServer, PAPServer.Abstract

public interface PAPServer

PAP server.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PAPServer.Abstract Abstract.

Method Summary

Modifier and Type	Method and Description
void	addPointValue(PointValue pointValue) Adds a point value.
Optional<PAPProxy.Responder>	getResponder() Gets the responder.
Logger	getThisLogger() Gets the logger.
boolean	isUpdating() Asks if we are currently updating.
Optional<PointValue>	nextUpdate(long timeout) Returns the next update.
void	setResponder(PAPProxy.Responder responder) Sets the responder.
boolean	setUp(KeyedGroups serverProperties) Sets up.
boolean	setUpListener(KeyedGroups listenerProperties) Sets up a listener.
void	start() Starts.
void	stop() Stops.
void	tearDown() Tears down what has been set up.

Method Detail

addPointValue

void addPointValue(@Nonnull
                   PointValue pointValue)

Adds a point value.

Parameters:

pointValue - The point value.

getResponder

@Nonnull
 @CheckReturnValue
Optional<PAPProxy.Responder> getResponder()

Gets the responder.

Returns:

The optional responder.

getThisLogger

@Nonnull
 @CheckReturnValue
Logger getThisLogger()

Gets the logger.

Returns:

The logger.

isUpdating

@CheckReturnValue
boolean isUpdating()

Asks if we are currently updating.

Returns:

True if updating.

nextUpdate

@Nonnull
 @CheckReturnValue
Optional<PointValue> nextUpdate(long timeout)
                                                       throws InterruptedException

Returns the next update.

Parameters:

timeout - A time limit in millis to wait for a point value (negative for infinite).

Returns:

The next update (empty if none).

Throws:

InterruptedException - When interrupted.

setResponder

void setResponder(@Nonnull
                  PAPProxy.Responder responder)

Sets the responder.

Parameters:

responder - The responder.

setUp

@CheckReturnValue
boolean setUp(@Nonnull
                                 KeyedGroups serverProperties)

Sets up.

Parameters:

serverProperties - The protocol specific server properties.

Returns:

True on success.

setUpListener

@CheckReturnValue
boolean setUpListener(@Nonnull
                                         KeyedGroups listenerProperties)

Sets up a listener.

Parameters:

listenerProperties - The listener properties.

Returns:

True on success.

start

void start()

Starts.

stop

void stop()

Stops.

tearDown

void tearDown()

Tears down what has been set up.