smartbus.net module¶
面向对象样式的 NET 客户端 API 的 Python 封装
-
class
smartbus.net.
Client
(client_id, client_type, master_ip, master_port, slave_ip=None, slave_port=None, user=None, password=None, info=None, event_executor=None)¶ -
NET 客户端
注解
使用
create()
建立实例,不要直接使用构造函数!警告
实例一旦建立,无法释放!
参数: - client_id (int) – 本地 client id, >= 0 and <= 255
- client_type (int) – 本地 client type
- master_ip (str) – 主服务器IP地址
- master_port (int) – 主服务器端口
- slave_ip (str) – 从服务器IP地址。没有从地址的,填写0,或者”“
- slave_port (int) – 从服务器端口。没有从端口的,填写0xFFFF
- user (str) – 用户名
- password (int) – 密码
- info (str) – 附加信息
- event_executor (ThreadPoolExecutor) – 事件执行器。在此执行器中回调事件执行函数。默认执行器的线程池数量是 1
-
activate
()¶ 激活客户端
将建立连接。连接一旦建立,就可以接受/发送数据,
注意
该函数立即返回,无论连接成功与否。 如该函数没有直接返回失败,客户端会自动尝试连接 smartbus 服务器,并在连接断开/失败时自动尝试重连
-
client_id
¶
-
client_type
¶
-
classmethod
create
(*args, **kwargs)¶ 建立实例
参数见构造函数
-
classmethod
find
(client_id, default=None)¶ 查找并返回实例
参数: - client_id – 要查找的实例的
client_id
- default – 如果找不到,返回这个值
返回: 找到的实例
返回类型: - client_id – 要查找的实例的
-
info
¶
-
classmethod
initialize
(unit_id, global_connect_callback=None, lib_path='')¶ 初始化
参数: 警告
unit_id >= 16 ,且全局唯一,不得重复
全局节点客户端连接、断开事件,当smartbus上某个节点发生连接或者断开时触发。 其函数形如:
-
global_connect_callback
(unit_id, client_id, client_type, access_unit_id, status_code, info)¶ 参数:
-
-
launch_flow
(server_unit_id, process_index, project_id, flow_id, mode, timeout, params)¶ 调用流程
参数: - server_unit_id (int) – 目标 IPSC 服务器 smartbus 单元ID
- process_index (int) – IPSC 进程 ID ,同时也是该 IPSC 进程的 smartbus Client ID
- project_id (str) – 流程项目ID
- flow_id (str) – 流程ID
- mode (int) – 调用模式:0 有流程返回、1 无流程返回
- timeout (float) – 有流程返回时的等待超时值(秒)
- params (list) – 流程输入参数里表。简单数据类型JSON数组。 子流程开始节点的传人参数自动变换为list类型数据。 对应的字符串内容最大长度不超过32K字节。
返回: invoke_id,调用ID,用于流程结果返回匹配用途。
返回类型:
-
master_ip
¶
-
master_port
¶
-
notify
(server_unit_id, process_index, project_id, title, mode, expires, txt)¶ 发送通知消息
参数: 返回: 调用任务的ID。
返回类型: Except: API返回错误
-
on_connect
()¶ 连接成功
-
on_connect_fail
(error_code)¶ 连接失败
-
on_disconnect
()¶ 连接断开
-
on_flow_ack
(head, project_id, invoke_id, status_code, msg)¶ 流程启动确认
参数:
-
on_flow_error
(head, project_id, invoke_id, error_code)¶ 流程执行错误
参数:
-
on_flow_resp
(head, project_id, invoke_id, params)¶ 调用流程结果返回
参数:
-
on_flow_timeout
(head, project_id, invoke_id)¶ 流程执行超时
参数:
-
password
¶
-
ping
(dst_unit_id, dst_client_id, dst_client_type, data=None)¶ 发送PING命令
参数:
-
send_data
(cmd, cmd_type, dst_unit_id, dst_client_id, dst_client_type, data)¶ 发送数据
参数:
-
slave_ip
¶
-
slave_port
¶
-
unit_id
¶
-
user
¶