eixx - Erlang C++ 接口库技术文档

1. 安装指南

依赖项

• Boost库：eixx 依赖于 Boost 库，请确保系统中已安装 Boost。
• erl_interface：eixx 依赖于 Erlang 的 erl_interface 库，该库是 Erlang 发行版的一部分。

下载

可以通过 Git 克隆项目仓库：

$ git clone [e-mail]:saleyn/eixx.git

构建

1. 自定义构建配置： 如果需要自定义 Boost 的位置或安装前缀，可以创建一个名为 .cmake-args.${HOSTNAME} 的文件。例如：

   $ cat > .cmake-args.${HOSTNAME}
   DIR:BUILD=/tmp/@PROJECT@/build
   DIR:INSTALL=/opt/pkt/@PROJECT@/@VERSION@
   ENV:BOOST_ROOT=/opt/pkg/boost/current
   ENV:BOOST_LIBRARYDIR=/opt/pkg/boost/current/gcc/lib
   PKG_ROOT_DIR=/opt/pkg
   

2. 运行构建命令：

   $ make bootstrap [toolchain=gcc|clang]  [build=Debug|Release] \
                    [generator=make|ninja] [prefix=/usr/local] [verbose=true]
   $ make [verbose=true]
   $ make install      # 默认安装路径为 /usr/local
   

3. 构建调试版本： 如果需要构建调试版本，可以按照以下步骤操作：

   $ make bootstrap build=debug
   $ make src/libeixx_d.so
   $ make rebootstrap build=release
   $ make
   $ make install
   

4. 清理与重新构建： 如果需要清理当前构建并重新运行 bootstrap，可以使用以下命令：

   $ make distclean
   $ make rebootstrap [toolchain=gcc|clang]  [build=Debug|Release]
   

2. 项目使用说明

术语封送处理

eixx 库提供了方便的 Erlang 术语封送处理功能，支持以下特性：

• 编码/解码嵌套术语：通过单个函数调用实现（eterm::encode() 和 eterm::eterm() 构造函数）。
• 全局原子表：用于快速操作原子。
• 自定义内存分配器：允许用户提供自定义的内存分配器。
• 引用计数智能指针：用于复杂术语，简单术语（如整数、双精度、布尔值、原子）则按值复制。

分布式节点连接

连接库实现了比 erl_interface 更丰富的功能，完全支持进程链接和监控。该库是完全异步的，允许在一个操作系统线程中处理多个连接和邮箱。

示例代码

以下是一个简单的示例，展示了如何操作 Erlang 术语：

eterm i = 10;
eterm s = "abc";
eterm a = atom("ok");
eterm t = {20.0, i, s, a};  // 构造一个元组
eterm e = list{};           // 构造一个空列表
eterm l = list{i, 100.0, s, {a, 30}, list{}};   // 构造一个列表

3. 项目 API 使用文档

术语操作 API

• eterm::encode()：用于编码 Erlang 术语。
• eterm::eterm()：用于解码 Erlang 术语。
• eterm::format()：实现表达式解析器，用于格式化术语。

分布式连接 API

• otp_mailbox：用于处理邮箱中的消息。
• otp_connection：用于连接到 Erlang 节点。
• otp_node：用于管理节点连接和邮箱。

4. 项目安装方式

安装步骤

1. 克隆仓库：

   $ git clone [e-mail]:saleyn/eixx.git
   

2. 构建与安装：

   $ make bootstrap
   $ make
   $ make install
   

3. 安装调试版本： 如果需要安装调试版本，请按照以下步骤操作：

   $ make bootstrap build=debug
   $ make src/libeixx_d.so
   $ make rebootstrap build=release
   $ make
   $ make install
   

通过以上步骤，您可以成功安装并使用 eixx 库，进行 Erlang 术语的封送处理和分布式节点连接。