ecFlow学习笔记02.2.5 —— 理解客户端

该教程的最新版已发布在GitHub上，请访问ecflow-tutorial-cn

这是 ecFlow 教程的一部分，完整教程请参看《ecFlow学习笔记02 —— 教程》

• • *所有与 ecflow_server 的通讯都需要通过 ecflow_client。任何与服务器的通讯都需要知道服务器的地址和端口。同一台主机中可能运行多个服务，每个服务都有唯一的端口号。

本教程将会给出通过 shell 和在Python 脚本中使用客户端的例子。

客户端命令行接口

客户端命令的列表：

windroc@ubuntu:~/course/test$ ecflow_client --help
Client/server based work flow package:
Ecflow version(4.0.9) boost(1.53.0) compiler(gcc 4.9.2) protocol(TEXT_ARCHIVE) Compiled on Jan 12 2016 05:57:30
ecflow_client provides the command line interface, for interacting with the server:
Try:
   ecflow_client --help all       # List all commands, verbosely
   ecflow_client --help summary   # One line summary of all commands
   ecflow_client --help child     # One line summary of child commands
   ecflow_client --help user      # One line summary of user command
   ecflow_client --help <cmd>     # Detailed help on each command
Commands:
   abort                alter                begin                ch_add               ch_auto_add
   ch_drop              ch_drop_user         ch_register          ch_rem               ch_suites
   check                checkJobGenOnly      check_pt             complete             debug
   debug_server_off     debug_server_on      delete               edit_history         edit_script
   event                file                 force                force-dep-eval       free-dep
   get                  get_state            group                halt                 help
   host                 init                 job_gen              kill                 label
   load                 log                  meter                migrate              msg
   news                 order                ping                 plug                 port
   reloadwsfile         replace              requeue              restart              restore_from_checkpt
   resume               rid                  run                  server_load          server_version
   show                 shutdown             stats                stats_reset          status
   suites               suspend              sync                 sync_full            terminate
   version              wait                 why                  zombie_adopt         zombie_block
   zombie_fail          zombie_fob           zombie_get           zombie_kill          zombie_remove

上面提到过，使用 ecflow_client 与服务器通讯需要设置 host 和 port，如下方法确定：
默认主机和端口为：localhost:3141
默认值被 ECF_NODE 和 ECF_PORT 环境变量覆盖
环境变量被命令行参数 –port 和 –host 覆盖，并且可以用于 -help参数显示的任意shell层命令。
例如在命令行 ping 一个服务可以输入命令：

ecflow_client --ping --host=machineX --port=4141

windroc@ubuntu:~/course$ ecflow_client --ping --host=ubuntu --port=2500
			ping server(ubuntu:2500) succeeded in 00:00:00.437634  ~437 milliseconds

客户端 Python 接口

ecflow_client 提供的功能可以通过 Client Server API 实现。Python 接口使用相同的算法确定 host 和 port，允许显式设定 host 和 port。参看 ecflow.Client
下面给出 python 的示例

#!/usr/bin/env python2.7
import ecflow
try:
    # When no arguments specified uses ECF_NODE and/or ECF_PORT,
    # otherwise defaults to localhost:3141
    ci = ecflow.Client()
    ci.ping()
    # Explicitly set host and port using the same client
    # For alternative argument list see ecflow.Client.set_host_port()
    ci.set_host_port("machineX:4141")
    ci.ping()
    # Create a new client, Explicitly setting host and port.
    # For alternative argument list see ecflow.Client
    ci = ecflow.Client("oetzi:3444")
    ci.ping()
except RuntimeError as e:
    print "ping failed: " + str(e); 

需要做什么

如果你的 ecflow_server 是用 ecflow_start.sh 启动的，并且需要用到 shell 接口，那么请设置 ECF_NODE 和 ECF_PORT 环境变量。请注意，如果服务器通过 ecflow_start.sh 脚本 启动，那么默认的服务地址 “localhost:3141” 就不正确。
如果服务运行在本地主机上，可以使用 netstat 确定端口号。

netstat -lnptu

输出

windroc@ubuntu:~/course$ netstat -lnptu
(Not all processes could be identified, non-owned process info
 will not be shown, you would have to be root to see it all.)
Active Internet connections (only servers)
Proto Recv-Q Send-Q Local Address           Foreign Address         State       PID/Program name
…
tcp        0      0 0.0.0.0:2500            0.0.0.0:*               LISTEN      122783/ecflow_serve
…