Class RecvBufRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, RecvBufRequestOrBuilder

    public final class RecvBufRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements RecvBufRequestOrBuilder
     Use of the fields below may vary by implementation.  For example
     the buf_ptr and num_bytes may be set only for local operations and
     not sent on the wire, or only sent on the wire in one direction.
     
    Protobuf type org.platanios.tensorflow.proto.RecvBufRequest
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RecvBufRequest.Builder
      Use of the fields below may vary by implementation.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Detail

      • BUF_RENDEZVOUS_KEY_FIELD_NUMBER

        public static final int BUF_RENDEZVOUS_KEY_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CLIENT_LOCALITY_FIELD_NUMBER

        public static final int CLIENT_LOCALITY_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SERVER_LOCALITY_FIELD_NUMBER

        public static final int SERVER_LOCALITY_FIELD_NUMBER
        See Also:
        Constant Field Values
      • TRANSPORT_OPTIONS_FIELD_NUMBER

        public static final int TRANSPORT_OPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SRC_DEVICE_FIELD_NUMBER

        public static final int SRC_DEVICE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DST_DEVICE_FIELD_NUMBER

        public static final int DST_DEVICE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • REQUEST_ID_FIELD_NUMBER

        public static final int REQUEST_ID_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SRC_INCARNATION_FIELD_NUMBER

        public static final int SRC_INCARNATION_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getStepId

        public long getStepId()
         Used at server side to find the correct BufRendezvous.
         
        int64 step_id = 1;
        Specified by:
        getStepId in interface RecvBufRequestOrBuilder
        Returns:
        The stepId.
      • getBufRendezvousKey

        public java.lang.String getBufRendezvousKey()
         Arbitrary string identifying a BufRendezvous entry.
         
        string buf_rendezvous_key = 2;
        Specified by:
        getBufRendezvousKey in interface RecvBufRequestOrBuilder
        Returns:
        The bufRendezvousKey.
      • getBufRendezvousKeyBytes

        public com.google.protobuf.ByteString getBufRendezvousKeyBytes()
         Arbitrary string identifying a BufRendezvous entry.
         
        string buf_rendezvous_key = 2;
        Specified by:
        getBufRendezvousKeyBytes in interface RecvBufRequestOrBuilder
        Returns:
        The bytes for bufRendezvousKey.
      • getNumBytes

        public long getNumBytes()
         Size of value expected, must agree with BufRendezvous entry.
         
        int64 num_bytes = 3;
        Specified by:
        getNumBytes in interface RecvBufRequestOrBuilder
        Returns:
        The numBytes.
      • getBufPtr

        public long getBufPtr()
         When RDMA is in use, address of destination field on client.
         
        fixed64 buf_ptr = 4;
        Specified by:
        getBufPtr in interface RecvBufRequestOrBuilder
        Returns:
        The bufPtr.
      • hasClientLocality

        public boolean hasClientLocality()
         Optional information on client-side device locality.
         
        .org.platanios.tensorflow.proto.DeviceLocality client_locality = 5;
        Specified by:
        hasClientLocality in interface RecvBufRequestOrBuilder
        Returns:
        Whether the clientLocality field is set.
      • getClientLocality

        public DeviceLocality getClientLocality()
         Optional information on client-side device locality.
         
        .org.platanios.tensorflow.proto.DeviceLocality client_locality = 5;
        Specified by:
        getClientLocality in interface RecvBufRequestOrBuilder
        Returns:
        The clientLocality.
      • hasServerLocality

        public boolean hasServerLocality()
         Optional information on server-side device locality.
         
        .org.platanios.tensorflow.proto.DeviceLocality server_locality = 6;
        Specified by:
        hasServerLocality in interface RecvBufRequestOrBuilder
        Returns:
        Whether the serverLocality field is set.
      • getServerLocality

        public DeviceLocality getServerLocality()
         Optional information on server-side device locality.
         
        .org.platanios.tensorflow.proto.DeviceLocality server_locality = 6;
        Specified by:
        getServerLocality in interface RecvBufRequestOrBuilder
        Returns:
        The serverLocality.
      • hasTransportOptions

        public boolean hasTransportOptions()
         Optional, implementation-specific data.
         
        .org.platanios.tensorflow.proto.google.Any transport_options = 7;
        Specified by:
        hasTransportOptions in interface RecvBufRequestOrBuilder
        Returns:
        Whether the transportOptions field is set.
      • getTransportOptions

        public Any getTransportOptions()
         Optional, implementation-specific data.
         
        .org.platanios.tensorflow.proto.google.Any transport_options = 7;
        Specified by:
        getTransportOptions in interface RecvBufRequestOrBuilder
        Returns:
        The transportOptions.
      • getSrcDevice

        public java.lang.String getSrcDevice()
         For annotating timeline and device incarnation check.
         
        string src_device = 8;
        Specified by:
        getSrcDevice in interface RecvBufRequestOrBuilder
        Returns:
        The srcDevice.
      • getSrcDeviceBytes

        public com.google.protobuf.ByteString getSrcDeviceBytes()
         For annotating timeline and device incarnation check.
         
        string src_device = 8;
        Specified by:
        getSrcDeviceBytes in interface RecvBufRequestOrBuilder
        Returns:
        The bytes for srcDevice.
      • getDstDevice

        public java.lang.String getDstDevice()
         Optional, for annotating the timeline.
         
        string dst_device = 9;
        Specified by:
        getDstDevice in interface RecvBufRequestOrBuilder
        Returns:
        The dstDevice.
      • getDstDeviceBytes

        public com.google.protobuf.ByteString getDstDeviceBytes()
         Optional, for annotating the timeline.
         
        string dst_device = 9;
        Specified by:
        getDstDeviceBytes in interface RecvBufRequestOrBuilder
        Returns:
        The bytes for dstDevice.
      • getRequestId

        public long getRequestId()
         Depending on the RPC system in use, it may be necessary to set this
         id to detect resends of RPCs where the server is not aware that
         the prior RPC failed.
         
        int64 request_id = 10;
        Specified by:
        getRequestId in interface RecvBufRequestOrBuilder
        Returns:
        The requestId.
      • getSrcIncarnation

        public long getSrcIncarnation()
         Incarnation number of the source device, used to detect worker failures.
         
        uint64 src_incarnation = 11;
        Specified by:
        getSrcIncarnation in interface RecvBufRequestOrBuilder
        Returns:
        The srcIncarnation.
      • isInitialized

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

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException
      • getSerializedSize

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

        public boolean equals​(java.lang.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 RecvBufRequest parseFrom​(java.nio.ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static RecvBufRequest parseFrom​(java.nio.ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static RecvBufRequest parseFrom​(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static RecvBufRequest parseFrom​(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static RecvBufRequest parseFrom​(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static RecvBufRequest parseFrom​(java.io.InputStream input)
                                        throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static RecvBufRequest parseFrom​(java.io.InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static RecvBufRequest parseDelimitedFrom​(java.io.InputStream input)
                                                 throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static RecvBufRequest parseDelimitedFrom​(java.io.InputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static RecvBufRequest parseFrom​(com.google.protobuf.CodedInputStream input)
                                        throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static RecvBufRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

        public RecvBufRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public RecvBufRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected RecvBufRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static RecvBufRequest getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<RecvBufRequest> parser()
      • getParserForType

        public com.google.protobuf.Parser<RecvBufRequest> 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.GeneratedMessageV3
      • getDefaultInstanceForType

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