Module org.yamcs.core

Package org.yamcs.cmdhistory

Class StreamCommandHistoryPublisher

java.lang.Object

org.yamcs.cmdhistory.StreamCommandHistoryPublisher

All Implemented Interfaces:

CommandHistoryPublisher

public class StreamCommandHistoryPublisher
extends Object
implements CommandHistoryPublisher

Injects the command history updates in the command history stream

Nested Class Summary

Nested classes/interfaces inherited from interface org.yamcs.cmdhistory.CommandHistoryPublisher

CommandHistoryPublisher.AckStatus

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DUMP_CMDHIST_STREAM_NAME
static final String	REALTIME_CMDHIST_STREAM_NAME

Fields inherited from interface org.yamcs.cmdhistory.CommandHistoryPublisher

AcknowledgeQueued_KEY, AcknowledgeReleased_KEY, AcknowledgeSent_KEY, CcsdsSeq_KEY, CommandComplete_KEY, Queue_KEY, SUFFIX_MESSAGE, SUFFIX_RETURN, SUFFIX_STATUS, SUFFIX_TIME, TransmissionConstraints_KEY, Verifier_KEY_PREFIX

Constructor Summary

Constructors

Constructor	Description
StreamCommandHistoryPublisher(String archiveInstance)

Method Summary

Modifier and Type	Method	Description
void	addCommand(PreparedCommand pc)
String	getInstance()
Stream	getStream()
void	publish(org.yamcs.protobuf.Commanding.CommandId cmdId, String key, byte[] binary)
void	publish(org.yamcs.protobuf.Commanding.CommandId cmdId, String key, int value)
void	publish(org.yamcs.protobuf.Commanding.CommandId cmdId, String key, long instant)
void	publish(org.yamcs.protobuf.Commanding.CommandId cmdId, String key, String value)
void	publish(org.yamcs.protobuf.Commanding.CommandId cmdId, String key, DataType dt, Object value)
void	publishAck(org.yamcs.protobuf.Commanding.CommandId cmdId, String key, long time, CommandHistoryPublisher.AckStatus state, String message, ParameterValue resultPv)	Publish an acknowledgement status to the command history.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.yamcs.cmdhistory.CommandHistoryPublisher

commandFailed, publish, publishAck, publishAck

Field Details

REALTIME_CMDHIST_STREAM_NAME

public static final String REALTIME_CMDHIST_STREAM_NAME

See Also:

• Constant Field Values

DUMP_CMDHIST_STREAM_NAME

public static final String DUMP_CMDHIST_STREAM_NAME

See Also:

• Constant Field Values

Constructor Details

StreamCommandHistoryPublisher

public StreamCommandHistoryPublisher(String archiveInstance)

Method Details

publish

public void publish(org.yamcs.protobuf.Commanding.CommandId cmdId,
 String key,
 String value)

Specified by:

publish in interface CommandHistoryPublisher

publish

public void publish(org.yamcs.protobuf.Commanding.CommandId cmdId,
 String key,
 long instant)

Specified by:

publish in interface CommandHistoryPublisher

publish

public void publish(org.yamcs.protobuf.Commanding.CommandId cmdId,
 String key,
 int value)

Specified by:

publish in interface CommandHistoryPublisher

publish

public void publish(org.yamcs.protobuf.Commanding.CommandId cmdId,
 String key,
 byte[] binary)

Specified by:

publish in interface CommandHistoryPublisher

publish

public void publish(org.yamcs.protobuf.Commanding.CommandId cmdId,
 String key,
 DataType dt,
 Object value)

publishAck

public void publishAck(org.yamcs.protobuf.Commanding.CommandId cmdId,
 String key,
 long time,
 CommandHistoryPublisher.AckStatus state,
 String message,
 ParameterValue resultPv)

Description copied from interface: CommandHistoryPublisher

Publish an acknowledgement status to the command history.

Entries (corresponding to command history columns) are created:

• key_Time
• key_Status
• key_Message
• key_Return

Specified by:

publishAck in interface CommandHistoryPublisher

addCommand

public void addCommand(PreparedCommand pc)

Specified by:

addCommand in interface CommandHistoryPublisher

getInstance

public String getInstance()

getStream

public Stream getStream()