Skip to content

Latest commit

 

History

History
89 lines (63 loc) · 3.55 KB

CLIENT.md

File metadata and controls

89 lines (63 loc) · 3.55 KB

OPCUA Client 客户端

OPCUA ConnectionConfig - 连接配置对象

构造函数

提供默认的无参数的构造函数

成员变量

  • protocolVersion
    协议版本
  • sendBufferSize
    发送缓存大小
  • recvBufferSize
    接受缓存大小
  • maxMessageSize
    最大消息长度
  • maxChunkCount
    最大的数据快数量

OPCUA ClientConfig 客户端配置对象

构造函数

无默认构造函数

成员变量

N/A

成员函数

  • setTimeout(timeout: integer)
    设定连接超时时间(ms)
  • setSecureChannelLifeTime(life_time: integer)
    设定加密通道生命周期长度 (ms)
  • setProductURI(uri: string)
    设定产品URI
  • setApplicationURI(uri: string)
    设定应用URI （使用加密认证时需要保证URI跟证书内的URI地址一致)
  • setApplicationName(locale: string, name: string)
    设定应用名称

OPCUA Client 客户端对象

构造函数

  • new()
    初始化一个不使用安全连接的客户端
  • new(security_mode | enum, private_cert | string, private_key | string)
    初始化安全连接。private_cert和private_key为路径（可以是相对路径)。
    支持的模式包含：
    • 1 - None
    • 2 - Sign
    • 3 - SignAndEncrypt

成员变量

  • config
    ClientConfig 对象实例

成员函数

  • setStateCallback( callback | function )
    设定状态回调函数，原型为 function(client, state) end
  • getState()
    获取当前客户端状态。
  • reset()
    重置客户端
  • connect(endpoint_url | string )
    连接OPCUA服务器
  • connect_username(endpoint_url | string, username | string, password | string)
    使用用户名密码连接服务器
  • disconnect()
    断开连接
  • manuallyRenewSecureChannel()
    手动重新构建安全连接
  • getEndpoints(serverUrl | string, endpointDescriptionsSize | size_t *, endpointDescriptions | EndpointDescription)
    获取连接点信息列表
  • findServers(serverUrl | string, serverUrisSize | size_t, serverUris | String, localeIdsSize | size_t, localeIds | String *, registeredServersSize | size_t *, registeredServers | ApplicationDescription **)
    差超服务器列表
  • getNamespaceIndex(namespaceUri | string)
    获取名字空间的序号(ID)
  • getNodeMgr()
    获取节点管理器
  • getObjectsNode()
    获取Objects根节点
  • getTypesNode()
    获取Types根节点
  • getViewsNode()
    获取Views根节点
  • getServerNode()
    获取Server根节点
  • getRootNode()
    获取系统根节点
  • getNode(id | NodeId)
    获取节点对象
  • getNode(ns | integer, id | integer)
    获取节点对象（指定名字空间和整数的ID)
  • getNode(ns | integer, id | string)
    获取节点对象（指定名字空间和字符串的ID)
  • getNode(ns | integer, id | Guid)
    获取节点对象（指定名字空间和UUID的ID)
  • deleteNode(nodeId | NodeId, deleteReferences | boolean)
    删除节点，deleteReference为true时，删除节点的所有引用节点
  • deleteNode(node | Node, deleteReferences | boolean)
    删除节点，deleteReference为true时，删除节点的所有引用节点
  • createSubscription(callback | function)
    添加订阅，反馈订阅ID。 指定订阅节点数值变化的回调函数，原型为 function(mon_id | integer, value | DataValue, sub_id | integer, context | any)
  • subscribeNode(subid | UA_UInt32, nodeId | NodeId)
    订阅节点，subid是createSubscription返回的ID
  • run_iterate(ms | UA_UInt32)
    运行指定的时间长度

OPCUA ClientNodeMgr 客户端节点管理对象

TODO: