types/connection.proto

Table of Contents

• types/connection.proto

  • CommStatus
  • Connectivity

• Scalar Value Types

Top

types/connection.proto

CommStatus

Describes the state of communication between two entities. the CommStatus typically represents the application layer rather than any transport layer. For example TCP messages may be sent and ACKs received for them but if the application protocol response are never received then the CommStatus should not be COMM_SUCCESS.

Name	Number	Description
COMM_STATUS_UNSPECIFIED	0	the status of the line is unknown or unknowable
COMM_SUCCESS	1	The last time we attempted communication across it was successful.
COMM_FAILURE	2	Communication with the device is failing

Connectivity

Defines the connection state between two entities. This could be a TCP network connection or a HDMI connection. In cases where a connection is possible but the state of the connection can never be determined directly use NOT_APPLICABLE, for example a simple io connection has no concept of 'alive'.

The state of DISCONNECTED is not automatically an indication if issues in a system. A device may decide to disconnect to save resources.

Name	Number	Description
CONNECTIVITY_UNSPECIFIED	0	The connection state has not been provided.
NOT_APPLICABLE	1	The concept of a connection makes no sense for this device
DISCONNECTED	2	There is no active connection
CONNECTED	3	There is an open connection to the device

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)