server

Documentation

Index

• Variables
• func CheckTimeouts(timeouts *rpc.HTTPTimeouts)
• func NewHTTPHandlerStack(srv http.Handler, cors []string, vhosts []string) http.Handler
• func StartHTTPEndpoint(endpoint string, timeouts rpc.HTTPTimeouts, handler http.Handler) (*http.Server, net.Addr, error)
• type Server
  • func NewServer(db blockdb.Database) (Server, error)
• type StopError
  • func (e *StopError) Error() string

Variables

var (
	ErrDatadirUsed    = errors.New("datadir already used by another process")
	ErrNodeStopped    = errors.New("node not started")
	ErrNodeRunning    = errors.New("node already running")
	ErrServiceUnknown = errors.New("unknown service")
)

Functions

func CheckTimeouts

func CheckTimeouts(timeouts *rpc.HTTPTimeouts)

CheckTimeouts ensures that timeout values are meaningful

func NewHTTPHandlerStack

func NewHTTPHandlerStack(srv http.Handler, cors []string, vhosts []string) http.Handler

NewHTTPHandlerStack returns wrapped http-related handlers

func StartHTTPEndpoint

func StartHTTPEndpoint(endpoint string, timeouts rpc.HTTPTimeouts, handler http.Handler) (*http.Server, net.Addr, error)

StartHTTPEndpoint starts the HTTP RPC endpoint.

Types

type Server

type Server interface {
	Host() host.Host
	Proposer() proposer.Proposer
	Chain() chain.Blockchain
	Start()
	Stop() error
}

func NewServer

func NewServer(db blockdb.Database) (Server, error)

NewServer creates a server instance and initializes the ogen services.

type StopError

type StopError struct {
	Server   error
	Services map[reflect.Type]error
}

StopError is returned if a Node fails to stop either any of its registered services or itself.

func (*StopError) Error

func (e *StopError) Error() string

Error generates a textual representation of the stop error.