PROTOCOLS
ServiceConsumer
Defined in fuchsia.overnet/overnet.fidl
Interfaces applicable to consuming services from other devices
ListPeers
Returns a list of all peers that are connected to this Overnet. If this list has not been updated since the last call to this method, it waits until new data is available. Concurrent calls to ListPeers will result in channel closure.
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
peers |
vector<Peer>
|
ConnectToService
Connect chan to some external service on node with name service_name.
Request
| Name | Type |
|---|---|
node |
fuchsia.overnet.protocol/NodeId
|
service_name |
string[255]
|
chan |
handle<channel>
|
ServicePublisher
Defined in fuchsia.overnet/overnet.fidl
Interfaces applicable to sharing services with ServiceConsumer's
PublishService
Register a new service to be exported by Overnet.
If an existing service has the same service_name, it's replaced by this service.
Request
| Name | Type |
|---|---|
service_name |
string[255]
|
provider |
ServiceProvider
|
MeshController
Defined in fuchsia.overnet/overnet.fidl
Interfaces applicable to controlling an Overnet mesh
AttachSocketLink
Attach a socket as a new link. Bad socket options will result in the channel being closed.
Request
| Name | Type |
|---|---|
socket |
handle<socket>
|
options |
SocketLinkOptions
|
Overnet
Defined in fuchsia.overnet/overnet.fidl
Legacy Overnet interface for applications that did not distinguish between ServiceConsumer and ServicePublisher
ListPeers
Returns a list of all peers that are connected to this Overnet. If this list has not been updated since the last call to this method, it waits until new data is available. Concurrent calls to ListPeers will result in channel closure.
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
peers |
vector<Peer>
|
ConnectToService
Connect chan to some external service on node with name service_name.
Request
| Name | Type |
|---|---|
node |
fuchsia.overnet.protocol/NodeId
|
service_name |
string[255]
|
chan |
handle<channel>
|
PublishService
Register a new service to be exported by Overnet.
If an existing service has the same service_name, it's replaced by this service.
Request
| Name | Type |
|---|---|
service_name |
string[255]
|
provider |
ServiceProvider
|
ServiceProvider
Defined in fuchsia.overnet/overnet.fidl
A ServiceProvider is a factory for one service.
ConnectToService
Connect chan to the service (called in response to Overnet.ConnectToService).
info provides additional data about the connection request.
Request
| Name | Type |
|---|---|
chan |
handle<channel>
|
info |
ConnectionInfo
|
STRUCTS
Peer
Defined in fuchsia.overnet/overnet.fidl
A Peer describes one device on the Overnet mesh.
| Name | Type | Description | Default |
|---|---|---|---|
id |
fuchsia.overnet.protocol/NodeId
|
The address of the peer on the Overnet mesh. |
No default |
is_self |
bool
|
A special peer is returned for this device, and is marked with |
No default |
description |
fuchsia.overnet.protocol/PeerDescription
|
A description of the peer (includes, for example, a service list). |
No default |
TABLES
SocketLinkOptions
Defined in fuchsia.overnet/overnet.fidl
Extra arguments for attaching a socket link to an Overnet mesh.
| Ordinal | Name | Type | Description |
|---|---|---|---|
| 1 | connection_label |
string[32]
|
A label that might be used for debugging purposes. |
| 2 | bytes_per_second |
uint32
|
How many bytes per second are transferable on this link (used to tune error recovery). If unset, error recovery will be disabled. If set, must not be 0, or else the receiving MeshController service will close the channel (as discussed in that protocol's documentation). |
ConnectionInfo
Defined in fuchsia.overnet/overnet.fidl
Information provided to a ServiceProvider about an incoming connection.
| Ordinal | Name | Type | Description |
|---|---|---|---|
| 1 | peer |
fuchsia.overnet.protocol/NodeId
|
The peer address initiating this connection. |