From 840e658ec01829aed2cf47cdae216a03d9609300 Mon Sep 17 00:00:00 2001 From: Jacob Gadikian Date: Mon, 1 May 2017 22:53:51 +0700 Subject: [PATCH 1/3] Update grpc_server.go --- server/grpc_server.go | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/server/grpc_server.go b/server/grpc_server.go index 003a76611..37ef20a86 100644 --- a/server/grpc_server.go +++ b/server/grpc_server.go @@ -1,3 +1,13 @@ +/* +Package server is used to start a new ABCI server. + +It defines the struct for gRPC server settings, and functions for: + +* Starting a new gRPC server +* Stopping a gRPC server + +*/ + package server import ( @@ -12,6 +22,7 @@ import ( // var maxNumberConnections = 2 +//GRPCServer is used to set the protocol and address for gRPC. type GRPCServer struct { cmn.BaseService @@ -23,6 +34,7 @@ type GRPCServer struct { app types.ABCIApplicationServer } +//NewGRPCServer allows setting up a new gRPC ABCI server. func NewGRPCServer(protoAddr string, app types.ABCIApplicationServer) (cmn.Service, error) { parts := strings.SplitN(protoAddr, "://", 2) proto, addr := parts[0], parts[1] @@ -37,6 +49,7 @@ func NewGRPCServer(protoAddr string, app types.ABCIApplicationServer) (cmn.Servi return s, err } +//Onstart registers a new gRPC service and tells that service to listen on the port that is set in NewGRPCServer. func (s *GRPCServer) OnStart() error { s.BaseService.OnStart() ln, err := net.Listen(s.proto, s.addr) @@ -50,6 +63,7 @@ func (s *GRPCServer) OnStart() error { return nil } +//OnStop is called when a gRPC server is stopped. func (s *GRPCServer) OnStop() { s.BaseService.OnStop() s.server.Stop() From e43bcf3f2615770eb08a70d3c62569f7b823c935 Mon Sep 17 00:00:00 2001 From: Adrian Brink Date: Tue, 9 May 2017 12:40:18 +0200 Subject: [PATCH 2/3] Move package comment --- server/grpc_server.go | 16 +++------------- server/server.go | 9 +++++++++ 2 files changed, 12 insertions(+), 13 deletions(-) diff --git a/server/grpc_server.go b/server/grpc_server.go index 37ef20a86..1d8dd1ef3 100644 --- a/server/grpc_server.go +++ b/server/grpc_server.go @@ -1,13 +1,3 @@ -/* -Package server is used to start a new ABCI server. - -It defines the struct for gRPC server settings, and functions for: - -* Starting a new gRPC server -* Stopping a gRPC server - -*/ - package server import ( @@ -22,7 +12,7 @@ import ( // var maxNumberConnections = 2 -//GRPCServer is used to set the protocol and address for gRPC. +//GRPCServer is used to set the protocol and address for gRPC. type GRPCServer struct { cmn.BaseService @@ -49,7 +39,7 @@ func NewGRPCServer(protoAddr string, app types.ABCIApplicationServer) (cmn.Servi return s, err } -//Onstart registers a new gRPC service and tells that service to listen on the port that is set in NewGRPCServer. +//Onstart registers a new gRPC service and tells that service to listen on the port that is set in NewGRPCServer. func (s *GRPCServer) OnStart() error { s.BaseService.OnStart() ln, err := net.Listen(s.proto, s.addr) @@ -63,7 +53,7 @@ func (s *GRPCServer) OnStart() error { return nil } -//OnStop is called when a gRPC server is stopped. +//OnStop is called when a gRPC server is stopped. func (s *GRPCServer) OnStop() { s.BaseService.OnStop() s.server.Stop() diff --git a/server/server.go b/server/server.go index d18df820f..45d9ac1fa 100644 --- a/server/server.go +++ b/server/server.go @@ -1,3 +1,12 @@ +/* +Package server is used to start a new ABCI server. + +It contains two server implementation: + * gRPC server + * socket server + +*/ + package server import ( From ea2d83e513a99b90f96099a2e04fbc5b935c73a9 Mon Sep 17 00:00:00 2001 From: Adrian Brink Date: Sat, 13 May 2017 10:01:16 +0200 Subject: [PATCH 3/3] Clean up comments --- server/grpc_server.go | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/server/grpc_server.go b/server/grpc_server.go index 1d8dd1ef3..ae2a481d0 100644 --- a/server/grpc_server.go +++ b/server/grpc_server.go @@ -10,9 +10,6 @@ import ( cmn "github.com/tendermint/tmlibs/common" ) -// var maxNumberConnections = 2 - -//GRPCServer is used to set the protocol and address for gRPC. type GRPCServer struct { cmn.BaseService @@ -24,7 +21,7 @@ type GRPCServer struct { app types.ABCIApplicationServer } -//NewGRPCServer allows setting up a new gRPC ABCI server. +// NewGRPCServer returns a new gRPC ABCI server func NewGRPCServer(protoAddr string, app types.ABCIApplicationServer) (cmn.Service, error) { parts := strings.SplitN(protoAddr, "://", 2) proto, addr := parts[0], parts[1] @@ -39,7 +36,7 @@ func NewGRPCServer(protoAddr string, app types.ABCIApplicationServer) (cmn.Servi return s, err } -//Onstart registers a new gRPC service and tells that service to listen on the port that is set in NewGRPCServer. +// OnStart starts the gRPC service func (s *GRPCServer) OnStart() error { s.BaseService.OnStart() ln, err := net.Listen(s.proto, s.addr) @@ -53,7 +50,7 @@ func (s *GRPCServer) OnStart() error { return nil } -//OnStop is called when a gRPC server is stopped. +// OnStop stops the gRPC server func (s *GRPCServer) OnStop() { s.BaseService.OnStop() s.server.Stop()