github.com/yinchengtsinghua/golang-Eos-dpos-Ethereum@v0.0.0-20190121132951-92cc4225ed8e/rpc/endpoints.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  //版权所有2018 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  package rpc
    26  
    27  import (
    28  	"net"
    29  
    30  	"github.com/ethereum/go-ethereum/log"
    31  )
    32  
    33  //starthttpendpoint启动用cors/vhosts/modules配置的HTTP RPC终结点
    34  func StartHTTPEndpoint(endpoint string, apis []API, modules []string, cors []string, vhosts []string, timeouts HTTPTimeouts) (net.Listener, *Server, error) {
    35  //根据允许的模块生成白名单
    36  	whitelist := make(map[string]bool)
    37  	for _, module := range modules {
    38  		whitelist[module] = true
    39  	}
    40  //注册服务公开的所有API
    41  	handler := NewServer()
    42  	for _, api := range apis {
    43  		if whitelist[api.Namespace] || (len(whitelist) == 0 && api.Public) {
    44  			if err := handler.RegisterName(api.Namespace, api.Service); err != nil {
    45  				return nil, nil, err
    46  			}
    47  			log.Debug("HTTP registered", "namespace", api.Namespace)
    48  		}
    49  	}
    50  //所有已注册的API,启动HTTP侦听器
    51  	var (
    52  		listener net.Listener
    53  		err      error
    54  	)
    55  	if listener, err = net.Listen("tcp", endpoint); err != nil {
    56  		return nil, nil, err
    57  	}
    58  	go NewHTTPServer(cors, vhosts, timeouts, handler).Serve(listener)
    59  	return listener, handler, err
    60  }
    61  
    62  //startwsendpoint启动WebSocket终结点
    63  func StartWSEndpoint(endpoint string, apis []API, modules []string, wsOrigins []string, exposeAll bool) (net.Listener, *Server, error) {
    64  
    65  //根据允许的模块生成白名单
    66  	whitelist := make(map[string]bool)
    67  	for _, module := range modules {
    68  		whitelist[module] = true
    69  	}
    70  //注册服务公开的所有API
    71  	handler := NewServer()
    72  	for _, api := range apis {
    73  		if exposeAll || whitelist[api.Namespace] || (len(whitelist) == 0 && api.Public) {
    74  			if err := handler.RegisterName(api.Namespace, api.Service); err != nil {
    75  				return nil, nil, err
    76  			}
    77  			log.Debug("WebSocket registered", "service", api.Service, "namespace", api.Namespace)
    78  		}
    79  	}
    80  //所有已注册的API,启动HTTP侦听器
    81  	var (
    82  		listener net.Listener
    83  		err      error
    84  	)
    85  	if listener, err = net.Listen("tcp", endpoint); err != nil {
    86  		return nil, nil, err
    87  	}
    88  	go NewWSServer(wsOrigins, handler).Serve(listener)
    89  	return listener, handler, err
    90  
    91  }
    92  
    93  //StartIPCendPoint启动IPC终结点。
    94  func StartIPCEndpoint(ipcEndpoint string, apis []API) (net.Listener, *Server, error) {
    95  //注册服务公开的所有API。
    96  	handler := NewServer()
    97  	for _, api := range apis {
    98  		if err := handler.RegisterName(api.Namespace, api.Service); err != nil {
    99  			return nil, nil, err
   100  		}
   101  		log.Debug("IPC registered", "namespace", api.Namespace)
   102  	}
   103  //所有已注册的API,启动IPC侦听器。
   104  	listener, err := ipcListen(ipcEndpoint)
   105  	if err != nil {
   106  		return nil, nil, err
   107  	}
   108  	go handler.ServeListener(listener)
   109  	return listener, handler, nil
   110  }