SocketData (grpc-all 1.53.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - io.grpc.channelz.v1.SocketData

All Implemented Interfaces:: Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, SocketDataOrBuilder, Serializable

public final class SocketData
extends GeneratedMessageV3
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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SocketData.Builder
SocketData is data associated for a specific Socket.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  AbstractMessageLite.InternalOneOfEnum

Nested Classes
Modifier and Type	Class and Description
`static class`	`SocketData.Builder` SocketData is data associated for a specific Socket.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`KEEP_ALIVES_SENT_FIELD_NUMBER`
`static int`	`LAST_LOCAL_STREAM_CREATED_TIMESTAMP_FIELD_NUMBER`
`static int`	`LAST_MESSAGE_RECEIVED_TIMESTAMP_FIELD_NUMBER`
`static int`	`LAST_MESSAGE_SENT_TIMESTAMP_FIELD_NUMBER`
`static int`	`LAST_REMOTE_STREAM_CREATED_TIMESTAMP_FIELD_NUMBER`
`static int`	`LOCAL_FLOW_CONTROL_WINDOW_FIELD_NUMBER`
`static int`	`MESSAGES_RECEIVED_FIELD_NUMBER`
`static int`	`MESSAGES_SENT_FIELD_NUMBER`
`static int`	`OPTION_FIELD_NUMBER`
`static int`	`REMOTE_FLOW_CONTROL_WINDOW_FIELD_NUMBER`
`static int`	`STREAMS_FAILED_FIELD_NUMBER`
`static int`	`STREAMS_STARTED_FIELD_NUMBER`
`static int`	`STREAMS_SUCCEEDED_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`static SocketData`	`getDefaultInstance()`
`SocketData`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`long`	`getKeepAlivesSent()` The number of keep alives sent.
`Timestamp`	`getLastLocalStreamCreatedTimestamp()` The last time a stream was created by this endpoint.
`TimestampOrBuilder`	`getLastLocalStreamCreatedTimestampOrBuilder()` The last time a stream was created by this endpoint.
`Timestamp`	`getLastMessageReceivedTimestamp()` The last time a message was received by this endpoint.
`TimestampOrBuilder`	`getLastMessageReceivedTimestampOrBuilder()` The last time a message was received by this endpoint.
`Timestamp`	`getLastMessageSentTimestamp()` The last time a message was sent by this endpoint.
`TimestampOrBuilder`	`getLastMessageSentTimestampOrBuilder()` The last time a message was sent by this endpoint.
`Timestamp`	`getLastRemoteStreamCreatedTimestamp()` The last time a stream was created by the remote endpoint.
`TimestampOrBuilder`	`getLastRemoteStreamCreatedTimestampOrBuilder()` The last time a stream was created by the remote endpoint.
`Int64Value`	`getLocalFlowControlWindow()` The amount of window, granted to the local endpoint by the remote endpoint.
`Int64ValueOrBuilder`	`getLocalFlowControlWindowOrBuilder()` The amount of window, granted to the local endpoint by the remote endpoint.
`long`	`getMessagesReceived()` The number of grpc messages received on this socket.
`long`	`getMessagesSent()` The number of grpc messages successfully sent on this socket.
`SocketOption`	`getOption(int index)` Socket options set on this socket.
`int`	`getOptionCount()` Socket options set on this socket.
`List<SocketOption>`	`getOptionList()` Socket options set on this socket.
`SocketOptionOrBuilder`	`getOptionOrBuilder(int index)` Socket options set on this socket.
`List<? extends SocketOptionOrBuilder>`	`getOptionOrBuilderList()` Socket options set on this socket.
`Parser<SocketData>`	`getParserForType()`
`Int64Value`	`getRemoteFlowControlWindow()` The amount of window, granted to the remote endpoint by the local endpoint.
`Int64ValueOrBuilder`	`getRemoteFlowControlWindowOrBuilder()` The amount of window, granted to the remote endpoint by the local endpoint.
`int`	`getSerializedSize()`
`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.
`long`	`getStreamsStarted()` The number of streams that have been started.
`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.
`UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`boolean`	`hasLastLocalStreamCreatedTimestamp()` The last time a stream was created by this endpoint.
`boolean`	`hasLastMessageReceivedTimestamp()` The last time a message was received by this endpoint.
`boolean`	`hasLastMessageSentTimestamp()` The last time a message was sent by this endpoint.
`boolean`	`hasLastRemoteStreamCreatedTimestamp()` The last time a stream was created by the remote endpoint.
`boolean`	`hasLocalFlowControlWindow()` The amount of window, granted to the local endpoint by the remote endpoint.
`boolean`	`hasRemoteFlowControlWindow()` The amount of window, granted to the remote endpoint by the local endpoint.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static SocketData.Builder`	`newBuilder()`
`static SocketData.Builder`	`newBuilder(SocketData prototype)`
`SocketData.Builder`	`newBuilderForType()`
`protected SocketData.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)`
`static SocketData`	`parseDelimitedFrom(InputStream input)`
`static SocketData`	`parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static SocketData`	`parseFrom(byte[] data)`
`static SocketData`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static SocketData`	`parseFrom(ByteBuffer data)`
`static SocketData`	`parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static SocketData`	`parseFrom(ByteString data)`
`static SocketData`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static SocketData`	`parseFrom(CodedInputStream input)`
`static SocketData`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static SocketData`	`parseFrom(InputStream input)`
`static SocketData`	`parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<SocketData>`	`parser()`
`SocketData.Builder`	`toBuilder()`
`void`	`writeTo(CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- STREAMS_STARTED_FIELD_NUMBER
```
public static final int STREAMS_STARTED_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STREAMS_SUCCEEDED_FIELD_NUMBER
```
public static final int STREAMS_SUCCEEDED_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STREAMS_FAILED_FIELD_NUMBER
```
public static final int STREAMS_FAILED_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MESSAGES_SENT_FIELD_NUMBER
```
public static final int MESSAGES_SENT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MESSAGES_RECEIVED_FIELD_NUMBER
```
public static final int MESSAGES_RECEIVED_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- KEEP_ALIVES_SENT_FIELD_NUMBER
```
public static final int KEEP_ALIVES_SENT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LAST_LOCAL_STREAM_CREATED_TIMESTAMP_FIELD_NUMBER
```
public static final int LAST_LOCAL_STREAM_CREATED_TIMESTAMP_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LAST_REMOTE_STREAM_CREATED_TIMESTAMP_FIELD_NUMBER
```
public static final int LAST_REMOTE_STREAM_CREATED_TIMESTAMP_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LAST_MESSAGE_SENT_TIMESTAMP_FIELD_NUMBER
```
public static final int LAST_MESSAGE_SENT_TIMESTAMP_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LAST_MESSAGE_RECEIVED_TIMESTAMP_FIELD_NUMBER
```
public static final int LAST_MESSAGE_RECEIVED_TIMESTAMP_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LOCAL_FLOW_CONTROL_WINDOW_FIELD_NUMBER
```
public static final int LOCAL_FLOW_CONTROL_WINDOW_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REMOTE_FLOW_CONTROL_WINDOW_FIELD_NUMBER
```
public static final int REMOTE_FLOW_CONTROL_WINDOW_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OPTION_FIELD_NUMBER
```
public static final int OPTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class GeneratedMessageV3

getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

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 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 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 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 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 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 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 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 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 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 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 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 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