This tutorial assumes that you are familiar with writing and running a Fuchsia component and with implementing a FIDL server, which are both covered in the FIDL server tutorial. For the full set of FIDL tutorials, refer to the overview.
This tutorial implements a client for a FIDL protocol and runs it against the server created in the previous tutorial. The client in this tutorial is synchronous. There is an alternate tutorial for asynchronous clients.
If you want to write the code yourself, delete the following directories:
rm -r examples/fidl/rust/client_sync/*
Create a new component project at examples/fidl/rust/client_sync
:
Add a main()
function to examples/fidl/rust/client_sync/src/main.rs
:
fn main() { println!("Hello, world!"); }
Declare a target for the client in examples/fidl/rust/client_sync/BUILD.gn
:
{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/rust/client_sync/BUILD.gn" region_tag="imports" %} # Declare an executable for the client. rustc_binary("bin") { name = "fidl_echo_rust_client_sync" edition = "2021" sources = [ "src/main.rs" ] } {% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/rust/client_sync/BUILD.gn" region_tag="rest" %}
Add a component manifest in examples/fidl/rust/client_sync/meta/client.cml
:
Note: The binary name in the manifest must match the output name of the executable
defined in the previous step.
{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/rust/client_sync/meta/client.cml" region_tag="example_snippet" %}
Once you have created your component, ensure that you can add it to the build configuration:
fx set core.x64 --with //examples/fidl/rust/client_sync:echo-client
Build the Fuchsia image:
fx build
Add the following dependencies to the rustc_binary
:
{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/rust/client_sync/BUILD.gn" region_tag="deps" %}
Then, import them in main.rs
:
{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/rust/client_sync/src/main.rs" region_tag="imports" %}
These dependencies are explained in the server tutorial.
The one new dependency is fuchsia-zircon
, which is a crate containing type safe bindings for making Zircon kernel syscalls. In this example, the crate is used to create a channel.
The steps in this section explain how to add code to the main()
function that connects the client to the server and makes requests to it.
{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/rust/client_sync/src/main.rs" region_tag="main" highlight="2,3" %}
This channel will be used to communicate between the client and server.
{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/rust/client_sync/src/main.rs" region_tag="main" highlight="4,5,6,7,8" %}
connect_channel_to_service
will bind the provided channel end to the specified service. Under the hood, this call triggers a sequence of events that starts on the client and traces through the server code from the previous tutorial:
SERVICE_NAME
of EchoMarker
template argument, similarly to how the service path is determined on the server end.connect_to_protocol
.In the background, the request to the component framework gets routed to the server:
async::Executor
executor and tells it that the ServiceFs
task can now make progress and should be run.ServiceFs
wakes up, sees the request available on the startup handle of the process, and looks up the name of the requested service in the list of (service_name, service_startup_func)
provided through calls to add_service
, add_fidl_service
, etc. If a matching service_name
exists, it calls service_startup_func
with the provided channel to connect to the new service.IncomingService::Echo
is called with a RequestStream
(typed-channel) of the Echo
FIDL protocol that is registered with add_fidl_service
. The incoming request channel is stored in IncomingService::Echo
and is added to the stream of incoming requests. for_each_concurrent
consumes the ServiceFs
into a Stream
of type IncomingService
. A handler is run for each entry in the stream, which matches over the incoming requests and dispatches to the run_echo_server
. The resulting futures from each call to run_echo_server
are run concurrently when the ServiceFs
stream is await
ed.Echo
service is becomes readable, which wakes up the asynchronous code in the body of run_echo_server
.Note: If any requests are sent before the server end of the channel is bound to the server, these requests are buffered by the kernel. The server then reads these requests as soon as the server is initialized.
The code makes two requests to the server:
EchoString
requestSendString
request{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/rust/client_sync/src/main.rs" region_tag="main" highlight="10,11,12,13,14,15" %}
The call to echo_string
will block until a response is received from the server, and therefore it takes a timeout argument as the last parameter.
On the other hand, the call to send_string
does not have a timeout parameter since SendString
does not have a response. With the current server implementation, an OnString
event will be sent to the client after this request is received. However, the synchronous Rust bindings do not have support for handling events.
The bindings reference describes how these methods are generated, and the Fuchsia rustdoc includes documentation for the generated FIDL crates.
In order for the client and server to communicate using the Echo
protocol, component framework must route the fuchsia.examples.Echo
capability from the server to the client. For this tutorial, a realm component is provided to declare the appropriate capabilities and routes.
Note: You can explore the full source for the realm component at //examples/fidl/echo-realm
Configure your build to include the provided package that includes the echo realm, server, and client:
fx set core.x64 --with //examples/fidl/rust:echo-rust-client-sync
Build the Fuchsia image:
fx build
Run the echo_realm
component. This creates the client and server component instances and routes the capabilities:
ffx component run /core/ffx-laboratory:echo_realm fuchsia-pkg://fuchsia.com/echo-rust-client-sync#meta/echo_realm.cm
Start the echo_client
instance:
ffx component start /core/ffx-laboratory:echo_realm/echo_client
The server component starts when the client attempts to connect to the Echo
protocol. You should see output similar to the following in the device logs (ffx log
):
[echo_server][][I] Listening for incoming connections... [echo_server][][I] Received EchoString request for string "hello" [echo_server][][I] Response sent successfully [echo_client][][I] response: "hello" [echo_server][][I] Received SendString request for string "hi" [echo_server][][I] Event sent successfully [echo_client][][I] Received OnString event for string "hi"
Terminate the realm component to stop execution and clean up the component instances:
ffx component destroy /core/ffx-laboratory:echo_realm