org.lsst.sal

Interface SAL<C extends SALCommand,E extends SALEvent,T extends SALTelemetry>

Type Parameters:

C - The base class for all commands sent and received by this implementation

E - The base class for all events sent and received by this implementation

T - The base class for all telemetry sent and received by this implementation

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ATCamera, SALCamera, SALImplementation

public interface SAL<C extends SALCommand,E extends SALEvent,T extends SALTelemetry>
extends AutoCloseable

A generic interface to SAL.

Author:

tonyj

Method Summary

Modifier and Type	Method and Description
void	close()
SALReceivedCommand<C>	getNextCommand(Duration timeout) Fetch the next command, or timeout if specified duration is exceeded.
E	getNextEvent(Duration timeout)
T	getTelemetry(Duration timeout)
SALCommandResponse	issueCommand(C command) Issue a command,
void	logEvent(E event) Sends an event
void	sendTelemetry(T telemetry)

Method Detail

getNextCommand

SALReceivedCommand<C> getNextCommand(Duration timeout)
                              throws SALException

Fetch the next command, or timeout if specified duration is exceeded. After receiving a command the receiver is responsible for calling methods in returned SALReceivedCommand to acknowledge and respond to the command.

Parameters:

timeout - The maximum time to wait before timing out

Returns:

The next command received, or null if the wait times-out.

Throws:

SALException - If a communication or similar error occurs

issueCommand

SALCommandResponse issueCommand(C command)
                         throws SALException

Issue a command,

Parameters:

command - The command to issue.

Returns:

The CommandResponse, which can be used to obtain the response(s) from the client.

Throws:

SALException - If a communication or similar error occurs

logEvent

void logEvent(E event)
       throws SALException

Sends an event

Parameters:

event - The event to send

Throws:

SALException - If a communication or similar error occurs

getNextEvent

E getNextEvent(Duration timeout)
        throws SALException

Throws:

SALException

sendTelemetry

void sendTelemetry(T telemetry)
            throws SALException

Throws:

SALException

getTelemetry

T getTelemetry(Duration timeout)
        throws SALException

Throws:

SALException

close

void close()
    throws SALException

Specified by:

close in interface AutoCloseable

Throws:

SALException