Package io.grpc.channelz.v1

Class SocketData

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.grpc.channelz.v1.SocketData
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SocketDataOrBuilder, Serializable
public final class SocketData extends com.google.protobuf.GeneratedMessage implements SocketDataOrBuilder
 SocketData is data associated for a specific Socket.  The fields present
 are specific to the implementation, so there may be minor differences in
 the semantics.  (e.g. flow control windows)
Protobuf type grpc.channelz.v1.SocketData
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • STREAMS_STARTED_FIELD_NUMBER

      public static final int STREAMS_STARTED_FIELD_NUMBER
      See Also:

    • streamsStarted_

      private long streamsStarted_

    • STREAMS_SUCCEEDED_FIELD_NUMBER

      public static final int STREAMS_SUCCEEDED_FIELD_NUMBER
      See Also:

    • streamsSucceeded_

      private long streamsSucceeded_

    • STREAMS_FAILED_FIELD_NUMBER

      public static final int STREAMS_FAILED_FIELD_NUMBER
      See Also:

    • streamsFailed_

      private long streamsFailed_

    • MESSAGES_SENT_FIELD_NUMBER

      public static final int MESSAGES_SENT_FIELD_NUMBER
      See Also:

    • messagesSent_

      private long messagesSent_

    • MESSAGES_RECEIVED_FIELD_NUMBER

      public static final int MESSAGES_RECEIVED_FIELD_NUMBER
      See Also:

    • messagesReceived_

      private long messagesReceived_

    • KEEP_ALIVES_SENT_FIELD_NUMBER

      public static final int KEEP_ALIVES_SENT_FIELD_NUMBER
      See Also:

    • keepAlivesSent_

      private long keepAlivesSent_

    • LAST_LOCAL_STREAM_CREATED_TIMESTAMP_FIELD_NUMBER

      public static final int LAST_LOCAL_STREAM_CREATED_TIMESTAMP_FIELD_NUMBER
      See Also:

    • lastLocalStreamCreatedTimestamp_

      private com.google.protobuf.Timestamp lastLocalStreamCreatedTimestamp_

    • LAST_REMOTE_STREAM_CREATED_TIMESTAMP_FIELD_NUMBER

      public static final int LAST_REMOTE_STREAM_CREATED_TIMESTAMP_FIELD_NUMBER
      See Also:

    • lastRemoteStreamCreatedTimestamp_

      private com.google.protobuf.Timestamp lastRemoteStreamCreatedTimestamp_

    • LAST_MESSAGE_SENT_TIMESTAMP_FIELD_NUMBER

      public static final int LAST_MESSAGE_SENT_TIMESTAMP_FIELD_NUMBER
      See Also:

    • lastMessageSentTimestamp_

      private com.google.protobuf.Timestamp lastMessageSentTimestamp_

    • LAST_MESSAGE_RECEIVED_TIMESTAMP_FIELD_NUMBER

      public static final int LAST_MESSAGE_RECEIVED_TIMESTAMP_FIELD_NUMBER
      See Also:

    • lastMessageReceivedTimestamp_

      private com.google.protobuf.Timestamp lastMessageReceivedTimestamp_

    • LOCAL_FLOW_CONTROL_WINDOW_FIELD_NUMBER

      public static final int LOCAL_FLOW_CONTROL_WINDOW_FIELD_NUMBER
      See Also:

    • localFlowControlWindow_

      private com.google.protobuf.Int64Value localFlowControlWindow_

    • REMOTE_FLOW_CONTROL_WINDOW_FIELD_NUMBER

      public static final int REMOTE_FLOW_CONTROL_WINDOW_FIELD_NUMBER
      See Also:

    • remoteFlowControlWindow_

      private com.google.protobuf.Int64Value remoteFlowControlWindow_

    • OPTION_FIELD_NUMBER

      public static final int OPTION_FIELD_NUMBER
      See Also:

    • option_

      private List<SocketOption> option_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final SocketData DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<SocketData> PARSER

  • Constructor Details

    • SocketData

      private SocketData(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • SocketData

      private SocketData()

  • 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

    • getStreamsStarted

      public long getStreamsStarted()
       The number of streams that have been started.
      int64 streams_started = 1;
      Specified by:
      getStreamsStarted in interface SocketDataOrBuilder
      Returns:
      The streamsStarted.

    • getStreamsSucceeded

      public long getStreamsSucceeded()
       The number of streams that have ended successfully:
 On client side, received frame with eos bit set;
 On server side, sent frame with eos bit set.
      int64 streams_succeeded = 2;
      Specified by:
      getStreamsSucceeded in interface SocketDataOrBuilder
      Returns:
      The streamsSucceeded.

    • getStreamsFailed

      public long getStreamsFailed()
       The number of streams that have ended unsuccessfully:
 On client side, ended without receiving frame with eos bit set;
 On server side, ended without sending frame with eos bit set.
      int64 streams_failed = 3;
      Specified by:
      getStreamsFailed in interface SocketDataOrBuilder
      Returns:
      The streamsFailed.

    • getMessagesSent

      public long getMessagesSent()
       The number of grpc messages successfully sent on this socket.
      int64 messages_sent = 4;
      Specified by:
      getMessagesSent in interface SocketDataOrBuilder
      Returns:
      The messagesSent.

    • getMessagesReceived

      public long getMessagesReceived()
       The number of grpc messages received on this socket.
      int64 messages_received = 5;
      Specified by:
      getMessagesReceived in interface SocketDataOrBuilder
      Returns:
      The messagesReceived.

    • getKeepAlivesSent

      public long getKeepAlivesSent()
       The number of keep alives sent.  This is typically implemented with HTTP/2
 ping messages.
      int64 keep_alives_sent = 6;
      Specified by:
      getKeepAlivesSent in interface SocketDataOrBuilder
      Returns:
      The keepAlivesSent.

    • hasLastLocalStreamCreatedTimestamp

      public boolean hasLastLocalStreamCreatedTimestamp()
       The last time a stream was created by this endpoint.  Usually unset for
 servers.
      .google.protobuf.Timestamp last_local_stream_created_timestamp = 7;
      Specified by:
      hasLastLocalStreamCreatedTimestamp in interface SocketDataOrBuilder
      Returns:
      Whether the lastLocalStreamCreatedTimestamp field is set.

    • getLastLocalStreamCreatedTimestamp

      public com.google.protobuf.Timestamp getLastLocalStreamCreatedTimestamp()
       The last time a stream was created by this endpoint.  Usually unset for
 servers.
      .google.protobuf.Timestamp last_local_stream_created_timestamp = 7;
      Specified by:
      getLastLocalStreamCreatedTimestamp in interface SocketDataOrBuilder
      Returns:
      The lastLocalStreamCreatedTimestamp.

    • getLastLocalStreamCreatedTimestampOrBuilder

      public com.google.protobuf.TimestampOrBuilder getLastLocalStreamCreatedTimestampOrBuilder()
       The last time a stream was created by this endpoint.  Usually unset for
 servers.
      .google.protobuf.Timestamp last_local_stream_created_timestamp = 7;
      Specified by:
      getLastLocalStreamCreatedTimestampOrBuilder in interface SocketDataOrBuilder

    • hasLastRemoteStreamCreatedTimestamp

      public boolean hasLastRemoteStreamCreatedTimestamp()
       The last time a stream was created by the remote endpoint.  Usually unset
 for clients.
      .google.protobuf.Timestamp last_remote_stream_created_timestamp = 8;
      Specified by:
      hasLastRemoteStreamCreatedTimestamp in interface SocketDataOrBuilder
      Returns:
      Whether the lastRemoteStreamCreatedTimestamp field is set.

    • getLastRemoteStreamCreatedTimestamp

      public com.google.protobuf.Timestamp getLastRemoteStreamCreatedTimestamp()
       The last time a stream was created by the remote endpoint.  Usually unset
 for clients.
      .google.protobuf.Timestamp last_remote_stream_created_timestamp = 8;
      Specified by:
      getLastRemoteStreamCreatedTimestamp in interface SocketDataOrBuilder
      Returns:
      The lastRemoteStreamCreatedTimestamp.

    • getLastRemoteStreamCreatedTimestampOrBuilder

      public com.google.protobuf.TimestampOrBuilder getLastRemoteStreamCreatedTimestampOrBuilder()
       The last time a stream was created by the remote endpoint.  Usually unset
 for clients.
      .google.protobuf.Timestamp last_remote_stream_created_timestamp = 8;
      Specified by:
      getLastRemoteStreamCreatedTimestampOrBuilder in interface SocketDataOrBuilder

    • hasLastMessageSentTimestamp

      public boolean hasLastMessageSentTimestamp()
       The last time a message was sent by this endpoint.
      .google.protobuf.Timestamp last_message_sent_timestamp = 9;
      Specified by:
      hasLastMessageSentTimestamp in interface SocketDataOrBuilder
      Returns:
      Whether the lastMessageSentTimestamp field is set.

    • getLastMessageSentTimestamp

      public com.google.protobuf.Timestamp getLastMessageSentTimestamp()
       The last time a message was sent by this endpoint.
      .google.protobuf.Timestamp last_message_sent_timestamp = 9;
      Specified by:
      getLastMessageSentTimestamp in interface SocketDataOrBuilder
      Returns:
      The lastMessageSentTimestamp.

    • getLastMessageSentTimestampOrBuilder

      public com.google.protobuf.TimestampOrBuilder getLastMessageSentTimestampOrBuilder()
       The last time a message was sent by this endpoint.
      .google.protobuf.Timestamp last_message_sent_timestamp = 9;
      Specified by:
      getLastMessageSentTimestampOrBuilder in interface SocketDataOrBuilder

    • hasLastMessageReceivedTimestamp

      public boolean hasLastMessageReceivedTimestamp()
       The last time a message was received by this endpoint.
      .google.protobuf.Timestamp last_message_received_timestamp = 10;
      Specified by:
      hasLastMessageReceivedTimestamp in interface SocketDataOrBuilder
      Returns:
      Whether the lastMessageReceivedTimestamp field is set.

    • getLastMessageReceivedTimestamp

      public com.google.protobuf.Timestamp getLastMessageReceivedTimestamp()
       The last time a message was received by this endpoint.
      .google.protobuf.Timestamp last_message_received_timestamp = 10;
      Specified by:
      getLastMessageReceivedTimestamp in interface SocketDataOrBuilder
      Returns:
      The lastMessageReceivedTimestamp.

    • getLastMessageReceivedTimestampOrBuilder

      public com.google.protobuf.TimestampOrBuilder getLastMessageReceivedTimestampOrBuilder()
       The last time a message was received by this endpoint.
      .google.protobuf.Timestamp last_message_received_timestamp = 10;
      Specified by:
      getLastMessageReceivedTimestampOrBuilder in interface SocketDataOrBuilder

    • hasLocalFlowControlWindow

      public boolean hasLocalFlowControlWindow()
       The amount of window, granted to the local endpoint by the remote endpoint.
 This may be slightly out of date due to network latency.  This does NOT
 include stream level or TCP level flow control info.
      .google.protobuf.Int64Value local_flow_control_window = 11;
      Specified by:
      hasLocalFlowControlWindow in interface SocketDataOrBuilder
      Returns:
      Whether the localFlowControlWindow field is set.

    • getLocalFlowControlWindow

      public com.google.protobuf.Int64Value getLocalFlowControlWindow()
       The amount of window, granted to the local endpoint by the remote endpoint.
 This may be slightly out of date due to network latency.  This does NOT
 include stream level or TCP level flow control info.
      .google.protobuf.Int64Value local_flow_control_window = 11;
      Specified by:
      getLocalFlowControlWindow in interface SocketDataOrBuilder
      Returns:
      The localFlowControlWindow.

    • getLocalFlowControlWindowOrBuilder

      public com.google.protobuf.Int64ValueOrBuilder getLocalFlowControlWindowOrBuilder()
       The amount of window, granted to the local endpoint by the remote endpoint.
 This may be slightly out of date due to network latency.  This does NOT
 include stream level or TCP level flow control info.
      .google.protobuf.Int64Value local_flow_control_window = 11;
      Specified by:
      getLocalFlowControlWindowOrBuilder in interface SocketDataOrBuilder

    • hasRemoteFlowControlWindow

      public boolean hasRemoteFlowControlWindow()
       The amount of window, granted to the remote endpoint by the local endpoint.
 This may be slightly out of date due to network latency.  This does NOT
 include stream level or TCP level flow control info.
      .google.protobuf.Int64Value remote_flow_control_window = 12;
      Specified by:
      hasRemoteFlowControlWindow in interface SocketDataOrBuilder
      Returns:
      Whether the remoteFlowControlWindow field is set.

    • getRemoteFlowControlWindow

      public com.google.protobuf.Int64Value getRemoteFlowControlWindow()
       The amount of window, granted to the remote endpoint by the local endpoint.
 This may be slightly out of date due to network latency.  This does NOT
 include stream level or TCP level flow control info.
      .google.protobuf.Int64Value remote_flow_control_window = 12;
      Specified by:
      getRemoteFlowControlWindow in interface SocketDataOrBuilder
      Returns:
      The remoteFlowControlWindow.

    • getRemoteFlowControlWindowOrBuilder

      public com.google.protobuf.Int64ValueOrBuilder getRemoteFlowControlWindowOrBuilder()
       The amount of window, granted to the remote endpoint by the local endpoint.
 This may be slightly out of date due to network latency.  This does NOT
 include stream level or TCP level flow control info.
      .google.protobuf.Int64Value remote_flow_control_window = 12;
      Specified by:
      getRemoteFlowControlWindowOrBuilder in interface SocketDataOrBuilder

    • getOptionList

      public List<SocketOption> getOptionList()
       Socket options set on this socket.  May be absent if 'summary' is set
 on GetSocketRequest.
      repeated .grpc.channelz.v1.SocketOption option = 13;
      Specified by:
      getOptionList in interface SocketDataOrBuilder

    • getOptionOrBuilderList

      public List<? extends SocketOptionOrBuilder> getOptionOrBuilderList()
       Socket options set on this socket.  May be absent if 'summary' is set
 on GetSocketRequest.
      repeated .grpc.channelz.v1.SocketOption option = 13;
      Specified by:
      getOptionOrBuilderList in interface SocketDataOrBuilder

    • getOptionCount

      public int getOptionCount()
       Socket options set on this socket.  May be absent if 'summary' is set
 on GetSocketRequest.
      repeated .grpc.channelz.v1.SocketOption option = 13;
      Specified by:
      getOptionCount in interface SocketDataOrBuilder

    • getOption

      public SocketOption getOption(int index)
       Socket options set on this socket.  May be absent if 'summary' is set
 on GetSocketRequest.
      repeated .grpc.channelz.v1.SocketOption option = 13;
      Specified by:
      getOption in interface SocketDataOrBuilder

    • getOptionOrBuilder

      public SocketOptionOrBuilder getOptionOrBuilder(int index)
       Socket options set on this socket.  May be absent if 'summary' is set
 on GetSocketRequest.
      repeated .grpc.channelz.v1.SocketOption option = 13;
      Specified by:
      getOptionOrBuilder in interface SocketDataOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static SocketData parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static SocketData parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SocketData.Builder newBuilder()

    • newBuilder

      public static SocketData.Builder newBuilder(SocketData prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SocketData getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<SocketData> 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 SocketData getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder