org.yamcs.protobuf.ClientMessageOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
There is a newer version: 5.10.9
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: yamcs/api/websocket.proto

package org.yamcs.protobuf;

public interface ClientMessageOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.api.ClientMessage)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Message type. Typically the name of a topic to subscribe to, or a built-in like "cancel".
   * 
   *
   * string type = 1;
   * @return The type.
   */
  java.lang.String getType();
  /**
   *    * Message type. Typically the name of a topic to subscribe to, or a built-in like "cancel".
   * 
   *
   * string type = 1;
   * @return The bytes for type.
   */
  com.google.protobuf.ByteString
      getTypeBytes();

  /**
   *    * Options specific to the type
   * 
   *
   * .google.protobuf.Any options = 2;
   * @return Whether the options field is set.
   */
  boolean hasOptions();
  /**
   *    * Options specific to the type
   * 
   *
   * .google.protobuf.Any options = 2;
   * @return The options.
   */
  com.google.protobuf.Any getOptions();
  /**
   *    * Options specific to the type
   * 
   *
   * .google.protobuf.Any options = 2;
   */
  com.google.protobuf.AnyOrBuilder getOptionsOrBuilder();

  /**
   *    * Optional client-side message identifier, returned in reply messages.
   * 
   *
   * int32 id = 3;
   * @return The id.
   */
  int getId();

  /**
   *    * 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;
   * @return The call.
   */
  int getCall();

  /**
   *    * 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];
   * @deprecated
   * @return The maxDroppedWrites.
   */
  @java.lang.Deprecated int getMaxDroppedWrites();

  /**
   *    *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;
   * @return The lowPriority.
   */
  boolean getLowPriority();
}