aardio 文档

process.rpc.jsonServer 库模块帮助文档

process.rpc 成员列表

process.rpc.jsonServer

基于进程管道实现的 JSON-RPC 2.0 服务端,
对应的客户端实现为 process.rpc.jsonClient 。

规则如下:
1、客户端不应当向服务端发送任何不符合 JSON-RPC 规范的内容。
2、客户端应当仅将包含 jsonrpc 字段的对象解析为 JSON-RPC 响应对象。
在批量调用时,应当仅将包含上述对象的非空数组解析为 JSON-RPC 响应对象。
客户端应当允许服务端进程的存在其他输出或错误输出。
3、服务端在发送每个 JSON-RPC 响应对象不会包含换行且在尾部添加换行符'
'。

关于JSON-RPC 2.0

process.rpc.jsonServer()

创建 JSON-RPC 2.0 服务端
可选在构造参数中指定监听客户端调用的监听器对象
如果不指定参数,保用对象自身监听客户端调用

返回对象:processRpcJsonServerObject

processRpcJsonServerObject 成员列表

processRpcJsonServerObject.?

客户端可以调用的远程对象名或远程方法名字,
客户端传过来的params参数必须是数组
服务端会展开此数组作为函数的调用参数
函数第一个返回值指定为客户端获取的result返回值
函数的第二个返回值指定为客户端error错误对象
错误对象可以是数值,字符串、或符合JSON-RPC2.0协议的表对象,

返回对象:webRpcJsonClientObject

processRpcJsonServerObject.rpc 成员列表

processRpcJsonServerObject.rpc.aasdl

指定自定义的aasdl
如果不指定,服务端会根据external自动生成aasdl
如果客户端请求的方法名为"?"时,返回此属性,
关于aasdl

processRpcJsonServerObject.rpc.afterJsonStringify

processRpcJsonServerObject.rpc.afterJsonStringify = function(jsonData){
    /*可以在这里加密服务端JSON,返回null中止本次调用*/
    return jsonData;
}

processRpcJsonServerObject.rpc.beforeJsonParse

processRpcJsonServerObject.rpc.beforeJsonParse = function(jsonData){
    /*可以在这里解密客户端数据,返回null中止本次调用*/
    return jsonData;
}

processRpcJsonServerObject.rpc.external

指定包含客户端可以调用的远程函数的表对象,可嵌套子表,
如果创建服务端对象的构造参数中没有指定表,
这个对象默认指向对象自身
可在调用run函数之前更改此对象

processRpcJsonServerObject.rpc.onError

processRpcJsonServerObject.rpc.onError = function(err,requestData){
    /*服务器内部错误时触发此事件  
err为抛出的异常对象,一般为错误信息  
requestData为客户端发送的请求数据*/
}

processRpcJsonServerObject.rpc.run()

运行JSON-RPC服务端响应用户请求

自动完成常量

_JSONRPC_INTERNAL_ERROR=-32603
_JSONRPC_INVALID_PARAMS=-32602
_JSONRPC_INVALID_REQUEST=-32600
_JSONRPC_METHOD_NOTFOUND=-32601
_JSONRPC_PARSE_ERROR=-32700

Markdown 格式