Module org.yamcs.api
Package org.yamcs.protobuf

Class ClientMessage

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.yamcs.protobuf.ClientMessage
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, ClientMessageOrBuilder
public final class ClientMessage extends com.google.protobuf.GeneratedMessageV3 implements ClientMessageOrBuilder
Protobuf type yamcs.api.ClientMessage
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ClientMessage.Builder
    Protobuf type yamcs.api.ClientMessage

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CALL_FIELD_NUMBER
     
    static final int
    ID_FIELD_NUMBER
     
    static final int
    LOWPRIORITY_FIELD_NUMBER
     
    static final int
    MAXDROPPEDWRITES_FIELD_NUMBER
     
    static final int
    OPTIONS_FIELD_NUMBER
     
    static final int
    TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    int
    getCall()
    If applicable, the call associated with this message This should be used when the client is streaming multiple messages handled by the same call.
    static ClientMessage
    getDefaultInstance()
     
    ClientMessage
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    int
    getId()
    Optional client-side message identifier, returned in reply messages.
    boolean
    getLowPriority()
    If set to true, permit the server to drop messages if writing the message would cause the channel to exceed the highWaterMark (see https://docs.yamcs.org/yamcs-server-manual/services/global/http-server/) This attribute is only applied when it is set on the first message of a call.
    int
    getMaxDroppedWrites()
    Deprecated. 
    com.google.protobuf.Any
    getOptions()
    Options specific to the type
    com.google.protobuf.AnyOrBuilder
    getOptionsOrBuilder()
    Options specific to the type
    com.google.protobuf.Parser<ClientMessage>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getType()
    Message type.
    com.google.protobuf.ByteString
    getTypeBytes()
    Message type.
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    int
    hashCode()
     
    boolean
    hasOptions()
    Options specific to the type
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ClientMessage.Builder
    newBuilder()
     
    static ClientMessage.Builder
    newBuilder(ClientMessage prototype)
     
    ClientMessage.Builder
    newBuilderForType()
     
    protected ClientMessage.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static ClientMessage
    parseDelimitedFrom(InputStream input)
     
    static ClientMessage
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ClientMessage
    parseFrom(byte[] data)
     
    static ClientMessage
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ClientMessage
    parseFrom(com.google.protobuf.ByteString data)
     
    static ClientMessage
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ClientMessage
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ClientMessage
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ClientMessage
    parseFrom(InputStream input)
     
    static ClientMessage
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ClientMessage
    parseFrom(ByteBuffer data)
     
    static ClientMessage
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ClientMessage>
    parser()
     
    ClientMessage.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getType

      public String getType()
       Message type. Typically the name of a topic to subscribe to, or a built-in like "cancel".
      string type = 1;
      Specified by:
      getType in interface ClientMessageOrBuilder
      Returns:
      The type.

    • getTypeBytes

      public com.google.protobuf.ByteString getTypeBytes()
       Message type. Typically the name of a topic to subscribe to, or a built-in like "cancel".
      string type = 1;
      Specified by:
      getTypeBytes in interface ClientMessageOrBuilder
      Returns:
      The bytes for type.

    • hasOptions

      public boolean hasOptions()
       Options specific to the type
      .google.protobuf.Any options = 2;
      Specified by:
      hasOptions in interface ClientMessageOrBuilder
      Returns:
      Whether the options field is set.

    • getOptions

      public com.google.protobuf.Any getOptions()
       Options specific to the type
      .google.protobuf.Any options = 2;
      Specified by:
      getOptions in interface ClientMessageOrBuilder
      Returns:
      The options.

    • getOptionsOrBuilder

      public com.google.protobuf.AnyOrBuilder getOptionsOrBuilder()
       Options specific to the type
      .google.protobuf.Any options = 2;
      Specified by:
      getOptionsOrBuilder in interface ClientMessageOrBuilder

    • getId

      public int getId()
       Optional client-side message identifier, returned in reply messages.
      int32 id = 3;
      Specified by:
      getId in interface ClientMessageOrBuilder
      Returns:
      The id.

    • getCall

      public int getCall()
       If applicable, the call associated with this message
 This should be used when the client is streaming multiple messages
 handled by the same call.
      int32 call = 4;
      Specified by:
      getCall in interface ClientMessageOrBuilder
      Returns:
      The call.

    • getMaxDroppedWrites

      @Deprecated public int getMaxDroppedWrites()
      Deprecated.
       If set, permit the server to keep a WebSocket connection despite frame writes
 getting dropped (channel not open or not writable). If unset the default is 0,
 meaning that if the server can't write a frame, it will close the connection
 (impacting all calls on that connection).
 This attribute is only applied when it is set on the first message of a call.
 Since Yamcs 5.7.6 this option is deprecated in favour of lowPriority below.
      int32 maxDroppedWrites = 5 [deprecated = true];
      Specified by:
      getMaxDroppedWrites in interface ClientMessageOrBuilder
      Returns:
      The maxDroppedWrites.

    • getLowPriority

      public boolean getLowPriority()
      If set to true, permit the server to drop messages if writing the message would cause the
 channel to exceed the highWaterMark
 (see https://docs.yamcs.org/yamcs-server-manual/services/global/http-server/)
 This attribute is only applied when it is set on the first message of a call.
 Note that if a message exceeds the highWaterMark, with this option set it will always be dropped.
 A warning will be printed in the Yamcs logs in this case.
      bool lowPriority = 6;
      Specified by:
      getLowPriority in interface ClientMessageOrBuilder
      Returns:
      The lowPriority.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ClientMessage parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClientMessage parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClientMessage parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClientMessage parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClientMessage parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClientMessage parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClientMessage parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ClientMessage parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ClientMessage parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ClientMessage parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ClientMessage parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ClientMessage parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ClientMessage.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ClientMessage.Builder newBuilder()

    • newBuilder

      public static ClientMessage.Builder newBuilder(ClientMessage prototype)

    • toBuilder

      public ClientMessage.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ClientMessage.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ClientMessage getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ClientMessage> parser()

    • getParserForType

      public com.google.protobuf.Parser<ClientMessage> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public ClientMessage getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder