service

Documentation

Index

• Variables
• type Manager
  • func NewManager() *Manager
  • func (m *Manager) GetServices() []Service
  • func (m *Manager) Register(t Type, service Service)
  • func (m *Manager) StartServices() (err error)
  • func (m *Manager) StopServices() error
• type NodeConfig
• type Service
• type Type
  • func (t Type) String() string

Variables

var (
	GroupIDShards       = map[nodeconfig.ShardID]nodeconfig.GroupID{}
	GroupIDShardClients = map[nodeconfig.ShardID]nodeconfig.GroupID{}
)

GroupIDShards is a map of ShardGroupID ID key is the shard ID value is the corresponding group ID

Types

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

Manager stores all services for service manager.

func NewManager

func NewManager() *Manager

NewManager creates a new manager

func (*Manager) GetServices

func (m *Manager) GetServices() []Service

GetServices returns all registered services.

func (*Manager) Register

func (m *Manager) Register(t Type, service Service)

Register registers new service to service store.

func (*Manager) StartServices

func (m *Manager) StartServices() (err error)

StartServices run all registered services. If net of the starting service returns an error, closing all started services.

func (*Manager) StopServices

func (m *Manager) StopServices() error

StopServices stops all services in the reverse order.

type NodeConfig

type NodeConfig struct {
	// The three groupID design, please refer to https://github.com/nordicenergy/nordicenergy-core/blob/master/node/node.md#libp2p-integration
	Beacon       nodeconfig.GroupID                           // the beacon group ID
	ShardGroupID nodeconfig.GroupID                           // the group ID of the shard
	Client       nodeconfig.GroupID                           // the client group ID of the shard
	IsBeacon     bool                                         // whether this node is a beacon node or not
	ShardID      uint32                                       // shardID of this node
	Actions      map[nodeconfig.GroupID]nodeconfig.ActionType // actions on the groups
}

NodeConfig defines a structure of node configuration that can be used in services. This is to pass node configuration to services and prvent cyclic imports

type Service

type Service interface {
	Start() error
	Stop() error
	APIs() []rpc.API // the list of RPC descriptors the service provides
}

Service is the collection of functions any service needs to implement.

type Type

type Type byte

Type is service type.

const (
	UnknownService Type = iota
	ClientSupport
	SupportExplorer
	Consensus
	BlockProposal
	NetworkInfo
	Prometheus
)

Constants for Type.

func (Type) String

func (t Type) String() string