Package org.yamcs.protobuf

Interface ClientMessageOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ClientMessage, ClientMessage.Builder
public interface ClientMessageOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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
    String
    getType()
    Message type.
    com.google.protobuf.ByteString
    getTypeBytes()
    Message type.
    boolean
    hasOptions()
    Options specific to the type

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getType

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

    • getTypeBytes

      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;
      Returns:
      The bytes for type.

    • hasOptions

      boolean hasOptions()
       Options specific to the type
      .google.protobuf.Any options = 2;
      Returns:
      Whether the options field is set.

    • getOptions

      com.google.protobuf.Any getOptions()
       Options specific to the type
      .google.protobuf.Any options = 2;
      Returns:
      The options.

    • getOptionsOrBuilder

      com.google.protobuf.AnyOrBuilder getOptionsOrBuilder()
       Options specific to the type
      .google.protobuf.Any options = 2;

    • getId

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

    • getCall

      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;
      Returns:
      The call.

    • getMaxDroppedWrites

      @Deprecated 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];
      Returns:
      The maxDroppedWrites.

    • getLowPriority

      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;
      Returns:
      The lowPriority.