Package com.couchbase.client.dcp.config

Enum Class DcpControl.Names

java.lang.Object
java.lang.Enum<DcpControl.Names>
com.couchbase.client.dcp.config.DcpControl.Names
All Implemented Interfaces:
Serializable, Comparable<DcpControl.Names>, java.lang.constant.Constable
Enclosing class:
DcpControl
public static enum DcpControl.Names extends Enum<DcpControl.Names>
All the possible control options available.

Note that not all params might be supported by the used server version, see the description for each for more information.

  • Enum Constant Details

    • ENABLE_NOOP

      @SinceCouchbase("3.0") public static final DcpControl.Names ENABLE_NOOP
      Used to enable to tell the Producer that the Consumer supports detecting dead connections through the use of a noop. The value for this message should be set to either "true" or "false". See the page on dead connections for more details. This parameter is available starting in Couchbase 3.0.

    • CONNECTION_BUFFER_SIZE

      @SinceCouchbase("3.0") public static final DcpControl.Names CONNECTION_BUFFER_SIZE
      Used to tell the Producer the size of the Consumer side buffer in bytes which the Consumer is using for flow control. The value of this parameter should be an integer in string form between 1 and 2^32. See the page on flow control for more details. This parameter is available starting in Couchbase 3.0.

    • SET_NOOP_INTERVAL

      @SinceCouchbase("3.0.1") public static final DcpControl.Names SET_NOOP_INTERVAL
      Sets the noop interval on the Producer. Values for this parameter should be an integer in string form between 20 and 10800. This allows the noop interval to be set between 20 seconds and 3 hours. This parameter should always be set when enabling noops to prevent the Consumer and Producer having a different noop interval. This parameter is available starting in Couchbase 3.0.1.

    • SET_PRIORITY

      @SinceCouchbase("4.0") public static final DcpControl.Names SET_PRIORITY
      Sets the priority that the connection should have when sending data. The priority may be set to "high", "medium", or "low". High priority connections will send messages at a higher rate than medium and low priority connections. This parameter is availale starting in Couchbase 4.0.

    • ENABLE_EXT_METADATA

      @SinceCouchbase("4.0") public static final DcpControl.Names ENABLE_EXT_METADATA
      Enables sending extended meta data. This meta data is mainly used for internal server processes and will vary between different releases of Couchbase. See the documentation on extended meta data for more information on what will be sent. Each version of Couchbase will support a specific version of extended meta data. This parameter is available starting in Couchbase 4.0.

    • ENABLE_VALUE_COMPRESSION

      @Deprecated @SinceCouchbase("4.5") public static final DcpControl.Names ENABLE_VALUE_COMPRESSION
      Deprecated.
      in favor of specifying compression settings by calling DcpControl.compression(CompressionMode). Scheduled for removal in next major version.
      Compresses values using snappy compression before sending them. This parameter is available starting in Couchbase 4.5.

    • SUPPORTS_CURSOR_DROPPING

      @SinceCouchbase("4.5") public static final DcpControl.Names SUPPORTS_CURSOR_DROPPING
      Tells the server that the client can tolerate the server dropping the connection. The server will only do this if the client cannot read data from the stream fast enough and it is highly recommended to be used in all situations. We only support disabling cursor dropping for backwards compatibility. This parameter is available starting in Couchbase 4.5.

    • ENABLE_EXPIRY_OPCODE

      @SinceCouchbase("6.5") public static final DcpControl.Names ENABLE_EXPIRY_OPCODE
      Tells the server that the client would like to receive expiry opcodes when an item is expired. The value of this should be set to 'true' for this control to occur, and 'false' will turn them off which is also its default state. Note by setting this to true, the delete time is required inside the expiration packets so delete times (and therefore delete_v2) is implicitly enabled. This option is available in versions from Couchbase 6.5. For a general overview of this feature, see expiry-opcode-output.md.

  • Method Details

    • values

      public static DcpControl.Names[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static DcpControl.Names valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • value

      public String value()