Package mxaccess_gateway.v1

Class MxaccessGateway.ReadBulkCommand

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
mxaccess_gateway.v1.MxaccessGateway.ReadBulkCommand
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, MxaccessGateway.ReadBulkCommandOrBuilder
Enclosing class:
MxaccessGateway
public static final class MxaccessGateway.ReadBulkCommand extends com.google.protobuf.GeneratedMessage implements MxaccessGateway.ReadBulkCommandOrBuilder
 Bulk Read — snapshot the current value for each requested tag. MXAccess COM
 has no synchronous Read; the worker implements ReadBulk as:

 - If the tag is already in the session's item registry AND that item is
 currently advised AND the worker has a cached OnDataChange for it, the
 reply returns the cached value WITHOUT modifying the existing
 subscription (was_cached = true).
 - Otherwise the worker takes the snapshot lifecycle itself: AddItem +
 Advise, wait up to `timeout_ms` for the first OnDataChange, then
 UnAdvise + RemoveItem before returning. The session is left exactly
 as it was before the call (was_cached = false).

 `timeout_ms == 0` uses the gateway-configured default (1000 ms).
Protobuf type mxaccess_gateway.v1.ReadBulkCommand
See Also:

  • Field Details

    • SERVER_HANDLE_FIELD_NUMBER

      public static final int SERVER_HANDLE_FIELD_NUMBER
      See Also:

    • TAG_ADDRESSES_FIELD_NUMBER

      public static final int TAG_ADDRESSES_FIELD_NUMBER
      See Also:

    • TIMEOUT_MS_FIELD_NUMBER

      public static final int TIMEOUT_MS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getServerHandle

      public int getServerHandle()
      int32 server_handle = 1;
      Specified by:
      getServerHandle in interface MxaccessGateway.ReadBulkCommandOrBuilder
      Returns:
      The serverHandle.

    • getTagAddressesList

      public com.google.protobuf.ProtocolStringList getTagAddressesList()
      repeated string tag_addresses = 2;
      Specified by:
      getTagAddressesList in interface MxaccessGateway.ReadBulkCommandOrBuilder
      Returns:
      A list containing the tagAddresses.

    • getTagAddressesCount

      public int getTagAddressesCount()
      repeated string tag_addresses = 2;
      Specified by:
      getTagAddressesCount in interface MxaccessGateway.ReadBulkCommandOrBuilder
      Returns:
      The count of tagAddresses.

    • getTagAddresses

      public String getTagAddresses(int index)
      repeated string tag_addresses = 2;
      Specified by:
      getTagAddresses in interface MxaccessGateway.ReadBulkCommandOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The tagAddresses at the given index.

    • getTagAddressesBytes

      public com.google.protobuf.ByteString getTagAddressesBytes(int index)
      repeated string tag_addresses = 2;
      Specified by:
      getTagAddressesBytes in interface MxaccessGateway.ReadBulkCommandOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the tagAddresses at the given index.

    • getTimeoutMs

      public int getTimeoutMs()
      uint32 timeout_ms = 3;
      Specified by:
      getTimeoutMs in interface MxaccessGateway.ReadBulkCommandOrBuilder
      Returns:
      The timeoutMs.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 MxaccessGateway.ReadBulkCommand parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static MxaccessGateway.ReadBulkCommand parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static MxaccessGateway.ReadBulkCommand parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static MxaccessGateway.ReadBulkCommand.Builder newBuilder()

    • newBuilder

      public static MxaccessGateway.ReadBulkCommand.Builder newBuilder(MxaccessGateway.ReadBulkCommand prototype)

    • toBuilder

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

    • newBuilderForType

      protected MxaccessGateway.ReadBulkCommand.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static MxaccessGateway.ReadBulkCommand getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<MxaccessGateway.ReadBulkCommand> 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.GeneratedMessage

    • getDefaultInstanceForType

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