Enum TapOpcode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TapOpcode>

    public enum TapOpcode
    extends java.lang.Enum<TapOpcode>
    The Opcode enum contains a list all of the different opcodes that can be passed in a tap message in the flag field.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DELETE
      Defines a delete message to specify a key has been deleted.
      END_CHECKPOINT
      Defines the end of a checkpoint.
      FLUSH
      Defines a tap flush message.
      MUTATION
      Defines a key-value mutation message to specify a key-value has changed.
      NOOP
      Defines a tap no-op message.
      OPAQUE
      Defines a opaque message to send control data to the consumer.
      REQUEST
      Defines a request message to open a tap connection.
      SASLAUTH
      Defines a SASL authorization message.
      SASLLIST
      Defines a SASL list mechanism message.
      START_CHECKPOINT
      Defines the start of a checkpoint.
      VBUCKETSET
      Defines a vBucket set message to set the state of a vBucket in the consumer.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private byte opcode
      The opcode value.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private TapOpcode​(byte opcode)
      Defines the magic value.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      byte getOpcode()  
      static TapOpcode getOpcodeByByte​(byte b)  
      static TapOpcode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TapOpcode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • NOOP

        public static final TapOpcode NOOP
        Defines a tap no-op message.
      • SASLLIST

        public static final TapOpcode SASLLIST
        Defines a SASL list mechanism message.
      • SASLAUTH

        public static final TapOpcode SASLAUTH
        Defines a SASL authorization message.
      • REQUEST

        public static final TapOpcode REQUEST
        Defines a request message to open a tap connection.
      • MUTATION

        public static final TapOpcode MUTATION
        Defines a key-value mutation message to specify a key-value has changed.
      • DELETE

        public static final TapOpcode DELETE
        Defines a delete message to specify a key has been deleted.
      • FLUSH

        public static final TapOpcode FLUSH
        Defines a tap flush message.
      • OPAQUE

        public static final TapOpcode OPAQUE
        Defines a opaque message to send control data to the consumer.
      • VBUCKETSET

        public static final TapOpcode VBUCKETSET
        Defines a vBucket set message to set the state of a vBucket in the consumer.
      • START_CHECKPOINT

        public static final TapOpcode START_CHECKPOINT
        Defines the start of a checkpoint.
      • END_CHECKPOINT

        public static final TapOpcode END_CHECKPOINT
        Defines the end of a checkpoint.
    • Field Detail

      • opcode

        private byte opcode
        The opcode value.
    • Constructor Detail

      • TapOpcode

        private TapOpcode​(byte opcode)
        Defines the magic value.
        Parameters:
        magic - - The new magic value
    • Method Detail

      • values

        public static TapOpcode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (TapOpcode c : TapOpcode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static TapOpcode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getOpcode

        public byte getOpcode()
      • getOpcodeByByte

        public static TapOpcode getOpcodeByByte​(byte b)