github.com/linapex/ethereum-dpos-chinese@v0.0.0-20190316121959-b78b3a4a1ece/rpc/doc.go (about)

     1  
     2  //<developer>
     3  //    <name>linapex 曹一峰</name>
     4  //    <email>linapex@163.com</email>
     5  //    <wx>superexc</wx>
     6  //    <qqgroup>128148617</qqgroup>
     7  //    <url>https://jsq.ink</url>
     8  //    <role>pku engineer</role>
     9  //    <date>2019-03-16 12:09:45</date>
    10  //</624342664057196544>
    11  
    12  
    13  /*
    14  包RPC提供通过网络访问对象的导出方法的权限
    15  或其他I/O连接。创建服务器实例后，可以注册对象，
    16  使其从外部可见。遵循特定的导出方法
    17  可以远程调用约定。它还支持发布/订阅
    18  模式。
    19  
    20  满足以下条件的方法可用于远程访问：
    21   -必须导出对象
    22   -必须导出方法
    23   -方法返回0、1（响应或错误）或2（响应和错误）值
    24   —方法参数必须导出或内置类型
    25   -方法返回值必须导出或内置类型
    26  
    27  示例方法：
    28   func（s*calcservice）add（a，b int）（int，error）
    29  
    30  当返回的错误不是nil时，将忽略返回的整数，错误为
    31  发送回客户端。否则，返回的整数将发送回客户机。
    32  
    33  接受指针值作为参数支持可选参数。例如。
    34  如果我们想在一个可选的有限域中做加法，我们可以接受一个mod
    35  参数作为指针值。
    36  
    37   func（s*calservice）add（a，b int，mod*int）（int，错误）
    38  
    39  可以使用2个整数和一个空值作为第三个参数调用此rpc方法。
    40  在这种情况下，mod参数将为零。或者可以用3个整数来调用，
    41  在这种情况下，mod将指向给定的第三个参数。因为可选
    42  参数是rpc包还将接受2个整数作为
    43  争论。它将把mod参数作为nil传递给rpc方法。
    44  
    45  服务器提供了接受ServerCodec实例的servedec方法。它将
    46  从编解码器读取请求，处理请求并将响应发送回
    47  使用编解码器的客户端。服务器可以同时执行请求。响应
    48  可以按顺序发送回客户端。
    49  
    50  使用JSON编解码器的示例服务器：
    51   类型计算器服务结构
    52  
    53   func（s*计算器服务）添加（a，b int）int
    54   返回A+B
    55   }
    56  
    57   func（s*calculatorservice）div（a，b int）（int，error）
    58   如果B=＝0 {
    59    返回0，errors.new（“被零除”）。
    60   }
    61   返回A/B，NIL
    62   }
    63  
    64   计算器：=新建（CalculatorService）
    65   服务器：=newserver（）
    66   server.registername（“计算器”，计算器）
    67  
    68   l，：=net.listenunix（“unix”，&net.unixaddr net:“unix”，name:“/tmp/calculator.sock”）
    69   对于{
    70   c，：=l.acceptUnix（）。
    71   编解码器：=v2.newjsoncodec（c）
    72   go server.servedec（编解码器）
    73   }
    74  
    75  包还通过使用订阅支持发布订阅模式。
    76  被视为符合通知条件的方法必须满足以下条件：
    77   -必须导出对象
    78   -必须导出方法
    79   -第一个方法参数类型必须是Context.Context
    80   —方法参数必须导出或内置类型
    81   -方法必须返回元组订阅，错误
    82  
    83  示例方法：
    84   func（s*blockchainservice）newblock（ctx context.context）（订阅，错误）
    85    …
    86   }
    87  
    88  订阅在以下情况下被删除：
    89   -用户发送取消订阅请求
    90   -用于创建订阅的连接已关闭。这可以启动
    91     通过客户端和服务器。服务器将在发生写入错误或
    92     缓冲通知队列太大。
    93  **/
    94  
    95  package rpc
    96