实现同步 C++ FIDL 客户端

前提条件

本教程基于 FIDL 服务器教程构建。如需查看完整的 FIDL 教程，请参阅概览。

概览

本教程实现了 FIDL 协议的客户端，并针对在前一个教程中创建的服务器运行该客户端。本教程中的客户端是同步客户端。我们提供了针对异步客户端的备用教程。

客户端示例的结构

本教程附带的示例代码位于您的 Fuchsia 结算点：//examples/fidl/cpp/client_sync。它由客户端组件及其包含的软件包组成。如需详细了解如何构建组件，请参阅构建组件。

为使客户端组件正常运行，请在 //examples/fidl/cpp/client_sync/BUILD.gn 中定义三个目标：

1. 客户端的原始可执行文件。这会生成一个具有指定输出名称的二进制文件，该名称可在 Fuchsia 上运行：

   executable("bin") {
     output_name = "fidl_echo_cpp_client_sync"
     sources = [ "main.cc" ]
   
     deps = [
       "//examples/fidl/fuchsia.examples:fuchsia.examples_cpp",
   
       # This library is used to log messages.
       "//sdk/lib/syslog/cpp",
   
       # This library is used to consume capabilities, e.g. protocols,
       # from the component's incoming directory.
       "//sdk/lib/component/incoming/cpp",
     ]
   }
   
   

2. 一种组件，用于运行客户端可执行文件。 组件是 Fuchsia 上的软件执行单元。组件由其清单文件描述。在本例中，meta/client.cml 将 echo-client 配置为可执行组件，该组件在 :bin 中运行 fidl_echo_cpp_client_sync。

   fuchsia_component("echo-client") {
     component_name = "echo_client"
     manifest = "meta/client.cml"
     deps = [ ":bin" ]
   }
   
   

   服务器组件清单位于 //examples/fidl/cpp/client_sync/meta/client.cml。清单中的二进制文件名称必须与 BUILD.gn 中定义的 executable 的输出名称一致。

   {
       include: [ "syslog/client.shard.cml" ],
   
       // Information about the program to run.
       program: {
           // Use the built-in ELF runner.
           runner: "elf",
   
           // The binary to run for this component.
           binary: "bin/fidl_echo_cpp_client_sync",
       },
   
       // Capabilities used by this component.
       use: [
           { protocol: "fuchsia.examples.Echo" },
       ],
   }
   
   

3. 然后，将该组件放入软件包中，该软件包是 Fuchsia 上的软件分发单元。

   # C++ sync client and server example package
   fuchsia_package("echo-cpp-client-sync") {
     deps = [
       ":echo-client",
       "//examples/fidl/cpp/server:echo-server",
       "//examples/fidl/echo-realm:echo_realm",
     ]
   }
   
   

构建客户端

1. 将客户端添加到您的 build 配置中。此操作只需执行一次：

   fx set core.x64 --with //examples/fidl/cpp/client_sync
   

2. 构建客户端：

   fx build examples/fidl/cpp/client_sync
   

连接到协议

fuchsia.examples/Echo

int main(int argc, const char** argv) {
  // Connect to the |fuchsia.examples/Echo| protocol inside the component's
  // namespace. This can fail so it's wrapped in a |zx::result| and it must be
  // checked for errors.
  zx::result client_end = component::Connect<fuchsia_examples::Echo>();
  if (!client_end.is_ok()) {
    FX_LOGS(ERROR) << "Synchronous error when connecting to the |Echo| protocol: "
                   << client_end.status_string();
    return -1;
  }

  // ...

同时，组件管理器会将请求路由到服务器组件。系统将使用服务器端点调用服务器教程中实现的服务器处理程序，并将该通道绑定到服务器实现。

此处需要注意的要点是，此代码假定组件的命名空间已包含 Echo 协议的实例。

初始化客户端

要向服务器发出 Echo 请求，请使用上一步中的客户端端点初始化客户端。

fidl::SyncClient client{std::move(*client_end)};

进行 FIDL 调用

进行 FIDL 调用的方法通过解引用运算符提供，使 FIDL 调用看起来像 client->EchoString(...)。

双向调用（例如 EchoString）会接受请求对象，并返回指示成功或失败的结果对象：

fidl::Result result = client->EchoString({"hello"});
// Check if the FIDL call succeeded or not.
if (!result.is_ok()) {
  // If the call failed, log the error, and quit the program.
  // Production code should do more graceful error handling depending
  // on the situation.
  FX_LOGS(ERROR) << "EchoString failed: " << result.error_value();
  return -1;
}
const std::string& reply_string = result->response();
FX_LOGS(INFO) << "Got response: " << reply_string;

您还可以使用自然结构体和表支持的指定初始化样式双大括号语法：

fidl::Result result = client->EchoString({{.value = "hello"}});

单向 SendString 通话没有回复。返回的结果表示发送请求时发生的任何错误。

fit::result<fidl::Error> result = client->SendString({"hi"});
if (!result.is_ok()) {
  FX_LOGS(ERROR) << "SendString failed: " << result.error_value();
  return -1;
}

处理事件

定义一个事件处理脚本：

// Define the event handler implementation for the client.
//
// The event handler should be an object that implements
// |fidl::SyncEventHandler<Echo>|, and override all pure virtual methods
// in that class corresponding to the events offered by the protocol.
class EventHandler : public fidl::SyncEventHandler<fuchsia_examples::Echo> {
 public:
  EventHandler() = default;

  void OnString(fidl::Event<fuchsia_examples::Echo::OnString>& event) override {
    const std::string& reply_string = event.response();
    FX_LOGS(INFO) << "Got event: " << reply_string;
  }
};

在收到事件之前，调用 client.HandleOneEvent 可进行屏蔽。如果事件被识别并成功解码，则 HandleOneEvent 会返回 fidl::Status::Ok()。否则，将返回相应的错误。如果服务器以 epitaph 结束连接，则返回 epitaph 中包含的状态。

// Block to receive exactly one event from the server, which is handled using
// the event handler defined above.
EventHandler event_handler;
fidl::Status status = client.HandleOneEvent(event_handler);
if (!status.ok()) {
  FX_LOGS(ERROR) << "HandleOneEvent failed: " << status.error();
  return -1;
}

使用电汇网域对象拨打电话

上述教程使用自然网域对象进行客户端调用：每次调用都将使用由自然网域对象表示的请求消息，并同样在自然网域对象中返回回复。在针对性能和堆分配进行优化时，可以使用有线域对象进行调用。为此，请在进行调用时使用的解引用运算符之前插入 .wire()，即 client.wire()->EchoString(...)。

使用有线类型进行 EchoString 双向通话：

fidl::WireResult result = client.wire()->EchoString("hello");
if (!result.ok()) {
  FX_LOGS(ERROR) << "EchoString failed: " << result.error();
  return -1;
}
FX_LOGS(INFO) << "Got response: " << result->response.get();

使用有线类型发起 SendString 单向调用：

fidl::Status wire_result = client.wire()->SendString("hi");
if (!wire_result.ok()) {
  FX_LOGS(ERROR) << "SendString failed: " << wire_result.error();
  return -1;
}

传输客户端调用中使用的相关类和函数的形状与自然客户端调用中使用的类和函数相似。当调用其他类或函数时，对应的导线通常以 Wire 为前缀。指针与引用以及参数结构之间也存在差异：

• 接受自然网域对象的 EchoString 方法接受一个参数，即请求网域对象：

  fidl::Result result = client->EchoString({{.value = "hello"}});
  

  当请求载荷是结构体时，获取传输网域对象的 EchoString 方法会将请求正文中的结构体字段列表展平为单独的参数（此处为单个 fidl::StringView 参数）：

  fidl::WireResult result = client.wire()->EchoString("hello");
  

• 这两种自然调用会返回 fidl::Result<Method>：

  fidl::Result result = client->EchoString({{.value = "hello"}});
  if (!result.is_ok()) {
    FX_LOGS(ERROR) << "EchoString failed: " << result.error_value();
    return -1;
  }
  const std::string& reply_string = result->response();
  FX_LOGS(INFO) << "Got response: " << reply_string;
  

  • 如需检查是成功还是错误，请使用 is_ok() 或 is_error() 方法。
  • 如需之后访问响应载荷，请使用 value() 或 ->。
  • 您可以移出结果或载荷，因为这些类型都实现了分层对象所有权。

  双向有线调用会返回 fidl::WireResult<Method>：

  fidl::WireResult result = client.wire()->EchoString("hello");
  if (!result.ok()) {
    FX_LOGS(ERROR) << "EchoString failed: " << result.error();
    return -1;
  }
  FX_LOGS(INFO) << "Got response: " << result->response.get();
  

  • 如需检查是否成功，请使用 ok() 方法。
  • 如需之后访问响应载荷，请使用 value() 或 ->。
  • 您无法移动结果对象。

• 在自然情况下，单向调用还会接受整个请求域对象，并且在线上用例中，请求结构字段将展平为单独的参数：

  // Make a SendString call using natural types.
  fit::result<fidl::Error> result = client->SendString({"hi"});
  
  // Make a SendString call using wire types.
  fidl::Status wire_result = client.wire()->SendString("hi");
  

运行客户端

为了让客户端和服务器使用 Echo 协议进行通信，组件框架必须将 fuchsia.examples.Echo 功能从服务器路由到客户端。

1. 配置 build 以添加所提供的包含 echo 领域、服务器和客户端的软件包：

   fx set core.x64 --with //examples/fidl/cpp/client_sync
   

2. 构建 Fuchsia 映像：

   fx build
   

3. 运行 echo_realm 组件。这会创建客户端和服务器组件实例并路由功能：

   ffx component run /core/ffx-laboratory:echo-client fuchsia-pkg://fuchsia.com/echo-cpp-client-sync#meta/echo_realm.cm
   

4. 启动 echo_client 实例：

   ffx component start /core/ffx-laboratory:echo_realm/echo_client
   

服务器组件在客户端尝试连接到 Echo 协议时启动。您应该会在设备日志 (ffx log) 中看到类似于以下内容的输出：

[echo_server][][I] Running echo server
[echo_client][I] Got response: hello
[echo_client][I] Got event: hi
[echo_client][I] Got response: hello
[echo_server][I] Client disconnected

终止领域组件以停止执行并清理组件实例：

ffx component destroy /core/ffx-laboratory:echo_realm

仅限 Wire 网域对象客户端

fidl::SyncClient 支持使用自然网域对象和有线网域对象进行调用。如果您只需要使用线路网域对象，可以创建一个 WireSyncClient，它会将等效的方法调用接口公开为对 fidl::SyncClient 调用 client.wire() 所获取的子集。

WireSyncClient 的创建方式与 SyncClient 相同：

fidl::WireSyncClient client(std::move(*client_end));

fidl::SyncClient 始终以自然网域对象的形式向用户公开接收到的事件。另一方面，fidl::WireSyncClient 将以线路域对象的形式公开收到的事件。为此，传递给 WireSyncClient 的事件处理程序需要实现 fidl::WireSyncEventHandler<Protocol>。

• 实现自然事件处理脚本：

  // Define the event handler implementation for the client.
  //
  // The event handler should be an object that implements
  // |fidl::SyncEventHandler<Echo>|, and override all pure virtual methods
  // in that class corresponding to the events offered by the protocol.
  class EventHandler : public fidl::SyncEventHandler<fuchsia_examples::Echo> {
   public:
    EventHandler() = default;
  
    void OnString(fidl::Event<fuchsia_examples::Echo::OnString>& event) override {
      const std::string& reply_string = event.response();
      FX_LOGS(INFO) << "Got event: " << reply_string;
    }
  };
  

• 实现电汇事件处理脚本：

  // Define the event handler implementation for the client.
  //
  // The event handler should be an object that implements
  // |fidl::WireSyncEventHandler<Echo>|, and override all pure virtual methods
  // in that class corresponding to the events offered by the protocol.
  class EventHandler : public fidl::WireSyncEventHandler<fuchsia_examples::Echo> {
   public:
    EventHandler() = default;
  
    void OnString(fidl::WireEvent<fuchsia_examples::Echo::OnString>* event) override {
      FX_LOGS(INFO) << "Got event: " << event->response.get();
    }
  };
  

使用有线客户端的完整示例代码位于 Fuchsia 结账流程的 //examples/fidl/cpp/client_sync/wire 中。