- All Superinterfaces:
com.google.common.util.concurrent.Service
- All Known Subinterfaces:
FileTransferService
,TmIndexService
- All Known Implementing Classes:
AbstractYamcsService
,AlarmRecorder
,CcsdsTmIndex
,CfdpService
,CfsEventDecoder
,CommandHistoryRecorder
,EventRecorder
,HttpServer
,ParameterArchive
,ParameterRecorder
,ProcessorCreatorService
,ProcessRunner
,ReplayServer
,ReplicationMaster
,ReplicationServer
,ReplicationSlave
,SystemParametersCollector
,SystemParametersService
,TimeCorrelationService
,TimelineService
,XtceTmRecorder
public interface YamcsService
extends com.google.common.util.concurrent.Service
Required interface of a Yamcs Service. A Yamcs Service is a Guava service with hooks in the Yamcs configuration
system.
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service
com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State
-
Method Summary
Methods inherited from interface com.google.common.util.concurrent.Service
addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync
-
Method Details
-
getSpec
Returns the valid configuration options for this service.- Returns:
- the argument specification, or
null
if the args should not be validated.
-
getYamcsInstance
String getYamcsInstance()returns the instance name- Returns:
-
init
default void init(String yamcsInstance, String serviceName, YConfiguration config) throws InitException Initialize this service. This is called before the service is started. All operations should finish fast.- Parameters:
yamcsInstance
- The yamcs instance, ornull
if this is a global service.serviceName
- The service name.config
- The configured arguments for this service. IfgetSpec()
is implemented then this contains the arguments after being validated (including any defaults).- Throws:
InitException
- When something goes wrong during the execution of this method.
-