github.com/yinchengtsinghua/golang-Eos-dpos-Ethereum@v0.0.0-20190121132951-92cc4225ed8e/rpc/doc.go (about)

     1  
     2  //此源码被清华学神尹成大魔王专业翻译分析并修改
     3  //尹成QQ77025077
     4  //尹成微信18510341407
     5  //尹成所在QQ群721929980
     6  //尹成邮箱 yinc13@mails.tsinghua.edu.cn
     7  //尹成毕业于清华大学,微软区块链领域全球最有价值专家
     8  //https://mvp.microsoft.com/zh-cn/PublicProfile/4033620
     9  //版权所有2015 Go Ethereum作者
    10  //此文件是Go以太坊库的一部分。
    11  //
    12  //Go-Ethereum库是免费软件：您可以重新分发它和/或修改
    13  //根据GNU发布的较低通用公共许可证的条款
    14  //自由软件基金会，或者许可证的第3版，或者
    15  //（由您选择）任何更高版本。
    16  //
    17  //Go以太坊图书馆的发行目的是希望它会有用，
    18  //但没有任何保证；甚至没有
    19  //适销性或特定用途的适用性。见
    20  //GNU较低的通用公共许可证，了解更多详细信息。
    21  //
    22  //你应该收到一份GNU较低级别的公共许可证副本
    23  //以及Go以太坊图书馆。如果没有，请参见<http://www.gnu.org/licenses/>。
    24  
    25  /*
    26  包RPC提供通过网络访问对象的导出方法的权限
    27  或其他I/O连接。创建服务器实例后，可以注册对象，
    28  使其从外部可见。遵循特定的导出方法
    29  可以远程调用约定。它还支持发布/订阅
    30  模式。
    31  
    32  满足以下条件的方法可用于远程访问：
    33   -必须导出对象
    34   -必须导出方法
    35   -方法返回0、1（响应或错误）或2（响应和错误）值
    36   —方法参数必须导出或内置类型
    37   -方法返回值必须导出或内置类型
    38  
    39  示例方法：
    40   func（s*calcservice）add（a，b int）（int，error）
    41  
    42  当返回的错误不是nil时，将忽略返回的整数，错误为
    43  发送回客户端。否则，返回的整数将发送回客户机。
    44  
    45  接受指针值作为参数支持可选参数。例如。
    46  如果我们想在一个可选的有限域中做加法，我们可以接受一个mod
    47  参数作为指针值。
    48  
    49   func（s*calservice）add（a，b int，mod*int）（int，错误）
    50  
    51  可以使用2个整数和一个空值作为第三个参数调用此rpc方法。
    52  在这种情况下，mod参数将为零。或者可以用3个整数来调用，
    53  在这种情况下，mod将指向给定的第三个参数。因为可选
    54  参数是rpc包还将接受2个整数作为
    55  争论。它将把mod参数作为nil传递给rpc方法。
    56  
    57  服务器提供了接受ServerCodec实例的servedec方法。它将
    58  从编解码器读取请求，处理请求并将响应发送回
    59  使用编解码器的客户端。服务器可以同时执行请求。响应
    60  可以按顺序发送回客户端。
    61  
    62  使用JSON编解码器的示例服务器：
    63   类型计算器服务结构
    64  
    65   func（s*计算器服务）添加（a，b int）int
    66   返回A+B
    67   }
    68  
    69   func（s*calculatorservice）div（a，b int）（int，error）
    70   如果B=＝0 {
    71    返回0，errors.new（“被零除”）。
    72   }
    73   返回A/B，NIL
    74   }
    75  
    76   计算器：=新建（CalculatorService）
    77   服务器：=newserver（）
    78   server.registername（“计算器”，计算器）
    79  
    80   l，：=net.listenunix（“unix”，&net.unixaddr net:“unix”，name:“/tmp/calculator.sock”）
    81   对于{
    82   c，：=l.acceptUnix（）。
    83   编解码器：=v2.newjsoncodec（c）
    84   go server.servedec（编解码器）
    85   }
    86  
    87  包还通过使用订阅支持发布订阅模式。
    88  被视为符合通知条件的方法必须满足以下条件：
    89   -必须导出对象
    90   -必须导出方法
    91   -第一个方法参数类型必须是Context.Context
    92   —方法参数必须导出或内置类型
    93   -方法必须返回元组订阅，错误
    94  
    95  示例方法：
    96   func（s*blockchainservice）newblock（ctx context.context）（订阅，错误）
    97    …
    98   }
    99  
   100  订阅在以下情况下被删除：
   101   -用户发送取消订阅请求
   102   -用于创建订阅的连接已关闭。这可以启动
   103     通过客户端和服务器。服务器将在发生写入错误或
   104     缓冲通知队列太大。
   105  **/
   106  
   107  package rpc