- java.lang.Object
-
- org.praxislive.core.protocols.StartableProtocol
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.praxislive.core.Protocol
Protocol.Type<T extends Protocol>, Protocol.TypeProvider
-
-
Field Summary
Fields Modifier and Type Field Description static ComponentInfo
API_INFO
A component info for this protocol.static StartableProtocol
INSTANCE
Deprecated.static String
IS_RUNNING
Name of the is-running control.static ControlInfo
IS_RUNNING_INFO
Info for the is-running control.static String
START
Name of the start control.static ControlInfo
START_INFO
Info for the start control.static String
STOP
Name of the stop control.static ControlInfo
STOP_INFO
Info for the stop control.
-
Constructor Summary
Constructors Constructor Description StartableProtocol()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Stream<String>
controls()
The names of the controls that a component advertising this protocol must provide.ControlInfo
getControlInfo(String control)
Query the ControlInfo for the provided control name on this protocol.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.praxislive.core.Protocol
optionalControls
-
-
-
-
Field Detail
-
INSTANCE
@Deprecated public static final StartableProtocol INSTANCE
Deprecated.
-
START
public static final String START
Name of the start control.- See Also:
- Constant Field Values
-
STOP
public static final String STOP
Name of the stop control.- See Also:
- Constant Field Values
-
IS_RUNNING
public static final String IS_RUNNING
Name of the is-running control.- See Also:
- Constant Field Values
-
START_INFO
public static final ControlInfo START_INFO
Info for the start control. It is an action control that should "start" the component. It may respond with an error if for some reason the component cannot be started.
-
STOP_INFO
public static final ControlInfo STOP_INFO
Info for the stop control. It is an action control that should "stop" the component. It may respond with an error if for some reason the component cannot be stopped.
-
IS_RUNNING_INFO
public static final ControlInfo IS_RUNNING_INFO
Info for the is-running control. It is a read-only boolean property that responds whether the component is currently running / started.
-
API_INFO
public static final ComponentInfo API_INFO
A component info for this protocol. Can be used withInfo.ComponentInfoBuilder.merge(org.praxislive.core.ComponentInfo)
.
-
-
Method Detail
-
controls
public Stream<String> controls()
Description copied from interface:Protocol
The names of the controls that a component advertising this protocol must provide.
-
getControlInfo
public ControlInfo getControlInfo(String control)
Description copied from interface:Protocol
Query the ControlInfo for the provided control name on this protocol. The component implementing this protocol will generally use the control info provided here inside its component info. In exceptional circumstances, the component may extend or adapt the behaviour of the control, as long as it is fully compatible with this control info and the specification.- Specified by:
getControlInfo
in interfaceProtocol
- Parameters:
control
- name of control- Returns:
- control info for named control
-
-