api

package

v0.0.0-...-42befb5 Latest Latest Go to latest Published: Jun 4, 2018 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package api provides the local go-spacemesh API endpoints. e.g. json-http and grpc-http2

This section is empty.

This section is empty.

This section is empty.

type JSONHTTPServer struct {
	Port uint
	// contains filtered or unexported fields
}

JSONHTTPServer is a JSON http server providing the Spacemesh API. It is implemented using a grpc-gateway. See https://github.com/grpc-ecosystem/grpc-gateway.

func NewJSONHTTPServer() *JSONHTTPServer

NewJSONHTTPServer creates a new json http server.

func (s JSONHTTPServer) StartService(status chan bool)

StartService starts the json api server and listens for status (started, stopped).

func (s JSONHTTPServer) StopService()

StopService stops the server.

type SpaceMeshGrpcService struct {
	Server *grpc.Server
	Port   uint
}

SpaceMeshGrpcService is a grpc server providing the Spacemesh api

func NewGrpcService() *SpaceMeshGrpcService

NewGrpcService create a new grpc service using config data.

func (s SpaceMeshGrpcService) Echo(ctx context.Context, in *pb.SimpleMessage) (*pb.SimpleMessage, error)

Echo returns the response for an echo api request

func (s SpaceMeshGrpcService) StartService(status chan bool)

StartService starts the grpc service.

func (s SpaceMeshGrpcService) StopService()

StopService stops the grpc service.

Path	Synopsis
config
pb Package pb is a generated protocol buffer package.	Package pb is a generated protocol buffer package.