Package org.yamcs.client.processor

Class ProcessorClient.CommandBuilder

java.lang.Object

org.yamcs.client.processor.ProcessorClient.CommandBuilder

Enclosing class:

ProcessorClient

public static class ProcessorClient.CommandBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
int	getSizeOfTheLastCommandIssued()	Can be called just after issue() has been called to get the size of the last command issued
CompletableFuture<Command>	issue()	Issue the command, and returns a future that awaits the initial response.
CompletableFuture<Command>	issue(Executor executor)	Issue the command, and returns a future that awaits the initial response on the specified executor.
String	toString()
ProcessorClient.CommandBuilder	withArgument(String name, Object value)
ProcessorClient.CommandBuilder	withComment(String comment)
ProcessorClient.CommandBuilder	withDisableTransmissionConstraints()
ProcessorClient.CommandBuilder	withDisableVerification()
ProcessorClient.CommandBuilder	withDryRun(boolean dryRun)
ProcessorClient.CommandBuilder	withExtra(String option, Yamcs.Value value)
ProcessorClient.CommandBuilder	withOrigin(String origin)
ProcessorClient.CommandBuilder	withSequenceNumber(int sequenceNumber)
ProcessorClient.CommandBuilder	withVerifierConfig(String verifier, Commanding.VerifierConfig config)

Methods inherited from class java.lang.Object

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

Method Details

withArgument

public ProcessorClient.CommandBuilder withArgument(String name,
 Object value)

withSequenceNumber

public ProcessorClient.CommandBuilder withSequenceNumber(int sequenceNumber)

withOrigin

public ProcessorClient.CommandBuilder withOrigin(String origin)

withComment

public ProcessorClient.CommandBuilder withComment(String comment)

withDisableTransmissionConstraints

public ProcessorClient.CommandBuilder withDisableTransmissionConstraints()

withDisableVerification

public ProcessorClient.CommandBuilder withDisableVerification()

withVerifierConfig

public ProcessorClient.CommandBuilder withVerifierConfig(String verifier,
 Commanding.VerifierConfig config)

withDryRun

public ProcessorClient.CommandBuilder withDryRun(boolean dryRun)

withExtra

public ProcessorClient.CommandBuilder withExtra(String option,
 Yamcs.Value value)

issue

public CompletableFuture<Command> issue()

Issue the command, and returns a future that awaits the initial response.

issue

public CompletableFuture<Command> issue(Executor executor)

Issue the command, and returns a future that awaits the initial response on the specified executor.

A use case for this is to provide a single-threaded executor, thereby guaranteeing in-order delivery.

getSizeOfTheLastCommandIssued

public int getSizeOfTheLastCommandIssued()

Can be called just after issue() has been called to get the size of the last command issued

not thread safe

toString

public String toString()

Overrides:

toString in class Object