package location.nearby.connections

Get desktop application:
View/edit binary Protocol Buffers messages

Nearby Connections authentication frame, contains the bytes format of a DeviceProvider's authentication message.

Used in: V1Frame

• optional bytes auth_message = 1

  An auth message generated by DeviceProvider. To be sent to the remote device for verification during connection setups.

Nearby Connections authentication result frame.

Used in: V1Frame

• optional int32 result = 1

  The authentication result. Non null if this frame is used to exchange authentication result.

Used in: V1Frame

• optional string endpoint_id = 1

• optional AutoReconnectFrame.EventType event_type = 2

• optional string last_endpoint_id = 3

Used in: AutoReconnectFrame

• UNKNOWN_EVENT_TYPE = 0

• CLIENT_INTRODUCTION = 1

• CLIENT_INTRODUCTION_ACK = 2

Used in: V1Frame

• optional AutoResumeFrame.EventType event_type = 1

• optional int64 pending_payload_id = 2

• optional int32 next_payload_chunk_index = 3

• optional int32 version = 4

Used in: AutoResumeFrame

• UNKNOWN_AUTO_RESUME_EVENT_TYPE = 0

• PAYLOAD_RESUME_TRANSFER_START = 1

• PAYLOAD_RESUME_TRANSFER_ACK = 2

Available channels on the local device.

Used in: MediumMetadata

• repeated int32 channels = 1

Used in: V1Frame

• optional BandwidthUpgradeNegotiationFrame.EventType event_type = 1

• optional BandwidthUpgradeNegotiationFrame.UpgradePathInfo upgrade_path_info = 2

  Exactly one of the following fields will be set.

• optional BandwidthUpgradeNegotiationFrame.ClientIntroduction client_introduction = 3

• optional BandwidthUpgradeNegotiationFrame.ClientIntroductionAck client_introduction_ack = 4

• optional BandwidthUpgradeNegotiationFrame.SafeToClosePriorChannel safe_to_close_prior_channel = 5

Accompanies CLIENT_INTRODUCTION events.

Used in: BandwidthUpgradeNegotiationFrame

• optional string endpoint_id = 1

• optional bool supports_disabling_encryption = 2

• optional string last_endpoint_id = 3

Accompanies CLIENT_INTRODUCTION_ACK events.

Used in: BandwidthUpgradeNegotiationFrame

(message has no fields)

Used in: BandwidthUpgradeNegotiationFrame

• UNKNOWN_EVENT_TYPE = 0

• UPGRADE_PATH_AVAILABLE = 1

• LAST_WRITE_TO_PRIOR_CHANNEL = 2

• SAFE_TO_CLOSE_PRIOR_CHANNEL = 3

• CLIENT_INTRODUCTION = 4

• UPGRADE_FAILURE = 5

• CLIENT_INTRODUCTION_ACK = 6

• UPGRADE_PATH_REQUEST = 7

  The event type that requires the remote device to send the available upgrade path.

Accompanies SAFE_TO_CLOSE_PRIOR_CHANNEL events.

Used in: BandwidthUpgradeNegotiationFrame

• optional int32 sta_frequency = 1

Accompanies UPGRADE_PATH_AVAILABLE and UPGRADE_FAILURE events.

Used in: BandwidthUpgradeNegotiationFrame

• optional UpgradePathInfo.Medium medium = 1

• optional UpgradePathInfo.WifiHotspotCredentials wifi_hotspot_credentials = 2

  Exactly one of the following fields will be set.

• optional UpgradePathInfo.WifiLanSocket wifi_lan_socket = 3

• optional UpgradePathInfo.BluetoothCredentials bluetooth_credentials = 4

• optional UpgradePathInfo.WifiAwareCredentials wifi_aware_credentials = 5

• optional UpgradePathInfo.WifiDirectCredentials wifi_direct_credentials = 6

• optional UpgradePathInfo.WebRtcCredentials web_rtc_credentials = 8

• optional UpgradePathInfo.AwdlCredentials awdl_credentials = 11

• optional bool supports_disabling_encryption = 7

  Disable Encryption for this upgrade medium to improve throughput.

• optional bool supports_client_introduction_ack = 9

  An ack will be sent after the CLIENT_INTRODUCTION frame.

• optional UpgradePathInfo.UpgradePathRequest upgrade_path_request = 10

Accompanies Medium.AWDL.

Used in: UpgradePathInfo

• optional string service_name = 1

• optional string service_type = 2

• optional string password = 3

Accompanies Medium.BLUETOOTH.

Used in: UpgradePathInfo

• optional string service_name = 1

• optional string mac_address = 2

Should always match cs/symbol:location.nearby.proto.connections.Medium

Used in: UpgradePathInfo, UpgradePathRequest

• UNKNOWN_MEDIUM = 0

• MDNS = 1

• BLUETOOTH = 2

• WIFI_HOTSPOT = 3

• BLE = 4

• WIFI_LAN = 5

• WIFI_AWARE = 6

• NFC = 7

• WIFI_DIRECT = 8

• WEB_RTC = 9

• USB = 11

  10 is reserved.

• WEB_RTC_NON_CELLULAR = 12

• AWDL = 13

Used in: UpgradePathInfo

• repeated Medium mediums = 1

  Supported mediums on the advertiser device.

• optional MediumMetadata medium_meta_data = 2

Accompanies Medium.WEB_RTC

Used in: UpgradePathInfo

• optional string peer_id = 1

• optional LocationHint location_hint = 2

Accompanies Medium.WIFI_AWARE.

Used in: UpgradePathInfo

• optional string service_id = 1

• optional bytes service_info = 2

• optional string password = 3

Accompanies Medium.WIFI_DIRECT.

Used in: UpgradePathInfo

• optional string ssid = 1

• optional string password = 2

• optional int32 port = 3

• optional int32 frequency = 4

• optional string gateway = 5

• optional bytes ip_v6_address = 6

  IPv6 link-local address, network order (128bits). The GO should listen on both IPv4 and IPv6 addresses. https://en.wikipedia.org/wiki/Link-local_address#IPv6

• optional string service_name = 7

  Windows only supports WifiDirect with Service Discovey. Its credentials is the service_name/pin.

• optional string pin = 8

  WifiDirect spec requires that pin is exactly 8 digits. The first 7 digits are the PIN. The last 1 digit is a checksum calculated using a specific algorithm (CRC-8). However, the Windows WinRT WiFiDirectServiceAdvertiser::ConnectAsync() that we use does NOT enforce the CRC-8 checksum for a WPS PIN because: 1. The ConnectAsync PIN is NOT necessarily a WPS PIN. 2. WPS PIN validation is performed by the Wi-Fi driver/firmware. 3. WFDS connections often bypass or replace WPS PIN authentication pin is exchanged in the connection handshake stage, but we create and save it before starting GO, so we can send it to GC side for authentication.

Accompanies Medium.WIFI_HOTSPOT.

Used in: UpgradePathInfo

• optional string ssid = 1

• optional string password = 2

• optional int32 port = 3

• optional string gateway = 4

• optional int32 frequency = 5

  This field can be a band or frequency

• repeated ServiceAddress address_candidates = 6

  This replaces gateway and port fields for new clients. The addresses list is ordered and should contain IPv6 addresses followed by IPv4 addresses. Link local addresses are acceptable here. Receivers should scope these addresses to the network interface used to connect to the hotspot. Senders should continue to set gateway and port fields to the same value as the last item in the list. Receivers should ignore gateway and port fields if this field is set. Receivers should attempt to connect to each of the address candidates in order until a connection can be established.

Accompanies Medium.WIFI_LAN.

Used in: UpgradePathInfo

• optional bytes ip_address = 1

• optional int32 wifi_port = 2

• repeated ServiceAddress address_candidates = 3

  This replaces ip_address and wifi_port fields for new clients. The addresses list is ordered and should contain IPv6 addresses followed by IPv4 addresses. Link local addresses cannot be used here. Senders should continue to set ip_address and wifi_port fields to the same value as the last item in the list. Receivers should ignore ip_address and wifi_port fields if this field is set. Receivers should attempt to connect to each of the address candidates in order until a connection can be established.

Used in: V1Frame

• repeated BandwidthUpgradeRetryFrame.Medium supported_medium = 1

  The mediums this device supports upgrading to. This list should be filtered by both the strategy and this device's individual limitations.

• optional bool is_request = 2

  If true, expect the remote endpoint to send back the latest supported_medium.

Should always match cs/symbol:location.nearby.proto.connections.Medium LINT.IfChange

Used in: BandwidthUpgradeRetryFrame

• UNKNOWN_MEDIUM = 0

• BLUETOOTH = 2

  1 is reserved.

• WIFI_HOTSPOT = 3

• BLE = 4

• WIFI_LAN = 5

• WIFI_AWARE = 6

• NFC = 7

• WIFI_DIRECT = 8

• WEB_RTC = 9

• BLE_L2CAP = 10

• USB = 11

• WEB_RTC_NON_CELLULAR = 12

• AWDL = 13

Used in: V1Frame

• optional string endpoint_id = 1

• optional string endpoint_name = 2

• optional bytes handshake_data = 3

• optional int32 nonce = 4

  A random number generated for each outgoing connection that is presently used to act as a tiebreaker when 2 devices connect to each other simultaneously; this can also be used for other initialization-scoped things in the future.

• repeated ConnectionRequestFrame.Medium mediums = 5

  The mediums this device supports upgrading to. This list should be filtered by both the strategy and this device's individual limitations.

• optional bytes endpoint_info = 6

• optional MediumMetadata medium_metadata = 7

• optional int32 keep_alive_interval_millis = 8

• optional int32 keep_alive_timeout_millis = 9

• optional int32 device_type = 10

  The type of {@link Device} object.

• optional bytes device_info = 11

  The bytes of serialized {@link Device} object.

• oneof Device

  Represents the {@link Device} that invokes the request.

  • ConnectionsDevice connections_device = 12

  • PresenceDevice presence_device = 13

• optional ConnectionRequestFrame.ConnectionMode connection_mode = 14

• optional LocationHint location_hint = 15

LINT.IfChange

Used in: ConnectionRequestFrame

• LEGACY = 0

• INSTANT = 1

Should always match cs/symbol:location.nearby.proto.connections.Medium LINT.IfChange

Used in: ConnectionRequestFrame, PresenceDevice

• UNKNOWN_MEDIUM = 0

• MDNS = 1

• BLUETOOTH = 2

• WIFI_HOTSPOT = 3

• BLE = 4

• WIFI_LAN = 5

• WIFI_AWARE = 6

• NFC = 7

• WIFI_DIRECT = 8

• WEB_RTC = 9

• BLE_L2CAP = 10

• USB = 11

• WEB_RTC_NON_CELLULAR = 12

• AWDL = 13

This doesn't need to send back endpoint_id and endpoint_name (like the ConnectionRequestFrame does) because those have already been transmitted out-of-band, at the time this endpoint was discovered.

Used in: V1Frame

• optional int32 status = 1

  One of: - ConnectionsStatusCodes.STATUS_OK - ConnectionsStatusCodes.STATUS_CONNECTION_REJECTED.

• optional bytes handshake_data = 2

• optional ConnectionResponseFrame.ResponseStatus response = 3

• optional OsInfo os_info = 4

• optional int32 multiplex_socket_bitmask = 5

  A bitmask value to indicate which medium supports Multiplex transmission feature. Each supporting medium could utilize one bit starting from the least significant bit in this field. eq. BT utilizes the LSB bit which 0x01 means bt supports multiplex while 0x00 means not. Refer to ClientProxy.java for the bit usages.

• optional int32 nearby_connections_version = 6

• optional int32 safe_to_disconnect_version = 7

• optional LocationHint location_hint = 8

• optional int32 keep_alive_timeout_millis = 9

Used to replace the status integer parameter with a meaningful enum item. Map ConnectionsStatusCodes.STATUS_OK to ACCEPT and ConnectionsStatusCodes.STATUS_CONNECTION_REJECTED to REJECT. Flag: connection_replace_status_with_response_connectionResponseFrame

Used in: ConnectionResponseFrame

• UNKNOWN_RESPONSE_STATUS = 0

• ACCEPT = 1

• REJECT = 2

Used in: ConnectionRequestFrame

• optional string endpoint_id = 1

• optional EndpointType endpoint_type = 2

• optional bytes connectivity_info_list = 3

  Data Elements.

• optional bytes endpoint_info = 4

Informs the remote side to immediately severe the socket connection. Used in bandwidth upgrades to get around a race condition, but may be used in other situations to trigger a faster disconnection event than waiting for socket closed on the remote side.

Used in: V1Frame

• optional bool request_safe_to_disconnect = 1

  Apply safe-to-disconnect protocol if true.

• optional bool ack_safe_to_disconnect = 2

  Ack of receiving Disconnection frame will be sent to the sender frame.

Used in: ConnectionsDevice, PresenceDevice

• UNKNOWN_ENDPOINT = 0

• CONNECTIONS_ENDPOINT = 1

• PRESENCE_ENDPOINT = 2

Used in: V1Frame

• optional bool ack = 1

  And ack will be sent after receiving KEEP_ALIVE frame.

• optional uint32 seq_num = 2

  The sequence number

LocationHint is used to specify a location as well as format.

Used in: BandwidthUpgradeNegotiationFrame.UpgradePathInfo.WebRtcCredentials, ConnectionRequestFrame, ConnectionResponseFrame

• optional string location = 1

  Location is the location, provided in the format specified by format.

• optional LocationStandard.Format format = 2

  the format of location.

(message has no fields)

Used in: LocationHint

• UNKNOWN = 0

• E164_CALLING = 1

  E164 country codes: https://en.wikipedia.org/wiki/List_of_country_calling_codes e.g. +1 for USA

• ISO_3166_1_ALPHA_2 = 2

  ISO 3166-1 alpha-2 country codes: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

Used in: BandwidthUpgradeNegotiationFrame.UpgradePathInfo.UpgradePathRequest, ConnectionRequestFrame

• optional bool supports_5_ghz = 1

  True if local device supports 5GHz.

• optional string bssid = 2

  WiFi LAN BSSID, in the form of a six-byte MAC address: XX:XX:XX:XX:XX:XX

• optional bytes ip_address = 3

  IP address, in network byte order: the highest order byte of the address is in byte[0].

• optional bool supports_6_ghz = 4

  True if local device supports 6GHz.

• optional bool mobile_radio = 5

  True if local device has mobile radio.

• optional int32 ap_frequency = 6

  The frequency of the WiFi LAN AP(in MHz). Or -1 is not associated with an AP over WiFi, -2 represents the active network uses an Ethernet transport.

• optional AvailableChannels available_channels = 7

  Available channels on the local device.

• optional WifiDirectCliUsableChannels wifi_direct_cli_usable_channels = 8

  Usable WiFi Direct client channels on the local device.

• optional WifiLanUsableChannels wifi_lan_usable_channels = 9

  Usable WiFi LAN channels on the local device.

• optional WifiAwareUsableChannels wifi_aware_usable_channels = 10

  Usable WiFi Aware channels on the local device.

• optional WifiHotspotStaUsableChannels wifi_hotspot_sta_usable_channels = 11

  Usable WiFi Hotspot STA channels on the local device.

• optional MediumRole medium_role = 12

  The supported medium roles.

• repeated MediumMetadata.WifiDirectAuthType supported_wifi_direct_auth_types = 13

  The supported WifiDirect auth types.

Should always match cs/symbol:location.nearby.proto.connections.WifiDirectAuthType LINT.IfChange

Used in: MediumMetadata

• WIFI_DIRECT_TYPE_UNKNOWN = 0

• WIFI_DIRECT_WITH_PASSWORD = 1

  WifiDirect type that uses ssid/password for authentication. Android supports this type, but Windows does not.

• WIFI_DIRECT_WITH_PIN = 2

  WifiDirect type that uses service_name/pin for authentication. Android and Windows both support this type.

The medium roles.

Used in: MediumMetadata

• optional bool support_wifi_direct_group_owner = 1

• optional bool support_wifi_direct_group_client = 2

• optional bool support_wifi_hotspot_host = 3

• optional bool support_wifi_hotspot_client = 4

• optional bool support_wifi_aware_publisher = 5

• optional bool support_wifi_aware_subscriber = 6

• optional bool support_awdl_publisher = 7

• optional bool support_awdl_subscriber = 8

• optional OfflineFrame.Version version = 1

• optional V1Frame v1 = 2

  Right now there's only 1 version, but if there are more, exactly one of the following fields will be set.

Used in: OfflineFrame

• UNKNOWN_VERSION = 0

• V1 = 1

Device capability for OS information.

Used in: ConnectionResponseFrame

• optional OsInfo.OsType type = 1

Used in: OsInfo

• UNKNOWN_OS_TYPE = 0

• ANDROID = 1

• CHROME_OS = 2

• WINDOWS = 3

• APPLE = 4

• LINUX = 100

  g3 test environment

A paired key encryption packet sent between devices, contains signed data.

Used in: V1Frame

• optional bytes signed_data = 1

  The encrypted data (raw authentication token for the established connection) in byte array format.

Used in: V1Frame

• optional PayloadTransferFrame.PacketType packet_type = 1

• optional PayloadTransferFrame.PayloadHeader payload_header = 2

• optional PayloadTransferFrame.PayloadChunk payload_chunk = 3

  Exactly one of the following fields will be set, depending on the type.

• optional PayloadTransferFrame.ControlMessage control_message = 4

Accompanies CONTROL packets.

Used in: PayloadTransferFrame

• optional ControlMessage.EventType event = 1

• optional int64 offset = 2

Used in: ControlMessage

• UNKNOWN_EVENT_TYPE = 0

• PAYLOAD_ERROR = 1

• PAYLOAD_CANCELED = 2

• PAYLOAD_RECEIVED_ACK = 3

  Use PacketType.PAYLOAD_ACK instead

Used in: PayloadTransferFrame

• UNKNOWN_PACKET_TYPE = 0

• DATA = 1

• CONTROL = 2

• PAYLOAD_ACK = 3

Accompanies DATA packets.

Used in: PayloadTransferFrame

• optional int32 flags = 1

• optional int64 offset = 2

• optional bytes body = 3

• optional int32 index = 4

• LAST_CHUNK = 1

Used in: PayloadTransferFrame

• optional int64 id = 1

• optional PayloadHeader.PayloadType type = 2

• optional int64 total_size = 3

• optional bool is_sensitive = 4

• optional string file_name = 5

• optional string parent_folder = 6

• optional int64 last_modified_timestamp_millis = 7

  Time since the epoch in milliseconds.

Used in: PayloadHeader

• UNKNOWN_PAYLOAD_TYPE = 0

• BYTES = 1

• FILE = 2

• STREAM = 3

Used in: ConnectionRequestFrame

• optional string endpoint_id = 1

• optional EndpointType endpoint_type = 2

• optional bytes connectivity_info_list = 3

  Data Elements.

• optional int64 device_id = 4

• optional string device_name = 5

• optional PresenceDevice.DeviceType device_type = 6

• optional string device_image_url = 7

• repeated ConnectionRequestFrame.Medium discovery_medium = 8

• repeated int32 actions = 9

• repeated int64 identity_type = 10

Used in: PresenceDevice

• UNKNOWN = 0

• PHONE = 1

• TABLET = 2

• DISPLAY = 3

• LAPTOP = 4

• TV = 5

• WATCH = 6

Represents the network tuple a service can be reached at.

Used in: BandwidthUpgradeNegotiationFrame.UpgradePathInfo.WifiHotspotCredentials, BandwidthUpgradeNegotiationFrame.UpgradePathInfo.WifiLanSocket

• optional bytes ip_address = 1

  This can be either IPv4 or IPv6 address. IPv4 address are 4 bytes long, and IPv6 addresses are 16 bytes long. Field with anything other than 4 or 16 bytes is invalid. Addresses are represented in MSB-first order.

• optional int32 port = 2

Used in: OfflineFrame

• optional V1Frame.FrameType type = 1

• optional ConnectionRequestFrame connection_request = 2

  Exactly one of the following fields will be set.

• optional ConnectionResponseFrame connection_response = 3

• optional PayloadTransferFrame payload_transfer = 4

• optional BandwidthUpgradeNegotiationFrame bandwidth_upgrade_negotiation = 5

• optional KeepAliveFrame keep_alive = 6

• optional DisconnectionFrame disconnection = 7

• optional PairedKeyEncryptionFrame paired_key_encryption = 8

• optional AuthenticationMessageFrame authentication_message = 9

• optional AuthenticationResultFrame authentication_result = 10

• optional AutoResumeFrame auto_resume = 11

• optional AutoReconnectFrame auto_reconnect = 12

• optional BandwidthUpgradeRetryFrame bandwidth_upgrade_retry = 13

Used in: V1Frame

• UNKNOWN_FRAME_TYPE = 0

• CONNECTION_REQUEST = 1

• CONNECTION_RESPONSE = 2

• PAYLOAD_TRANSFER = 3

• BANDWIDTH_UPGRADE_NEGOTIATION = 4

• KEEP_ALIVE = 5

• DISCONNECTION = 6

• PAIRED_KEY_ENCRYPTION = 7

• AUTHENTICATION_MESSAGE = 8

• AUTHENTICATION_RESULT = 9

• AUTO_RESUME = 10

• AUTO_RECONNECT = 11

• BANDWIDTH_UPGRADE_RETRY = 12

Usable WiFi Aware channels on the local device.

Used in: MediumMetadata

• repeated int32 channels = 1

Usable WiFi Direct client channels on the local device.

Used in: MediumMetadata

• repeated int32 channels = 1

Usable WiFi Hotspot STA channels on the local device.

Used in: MediumMetadata

• repeated int32 channels = 1

Usable WiFi LAN channels on the local device.

Used in: MediumMetadata

• repeated int32 channels = 1