Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Service ¶
type Service interface {
// Start spawns any goroutines required by the service.
Start()
// Stop terminates all goroutines belonging to the service,
// blocking until they are all terminated.
Stop() error
// Returns error if the service is not considered healthy.
Status() error
}
Service is a struct that can be registered into a ServiceRegistry for easy dependency management.
type ServiceRegistry ¶
type ServiceRegistry struct {
// contains filtered or unexported fields
}
ServiceRegistry provides a useful pattern for managing services. It allows for ease of dependency management and ensures services dependent on others use the same references in memory.
func NewServiceRegistry ¶
func NewServiceRegistry() *ServiceRegistry
NewServiceRegistry starts a registry instance for convenience
func (*ServiceRegistry) FetchService ¶
func (s *ServiceRegistry) FetchService(service interface{}) error
FetchService takes in a struct pointer and sets the value of that pointer to a service currently stored in the service registry. This ensures the input argument is set to the right pointer that refers to the originally registered service.
func (*ServiceRegistry) RegisterService ¶
func (s *ServiceRegistry) RegisterService(service Service) error
RegisterService appends a service constructor function to the service registry.
func (*ServiceRegistry) StartAll ¶
func (s *ServiceRegistry) StartAll()
StartAll initialized each service in order of registration.
func (*ServiceRegistry) Statuses ¶
func (s *ServiceRegistry) Statuses() map[reflect.Type]error
Statuses returns a map of Service type -> error. The map will be populated with the results of each service.Status() method call.
func (*ServiceRegistry) StopAll ¶
func (s *ServiceRegistry) StopAll()
StopAll ends every service in reverse order of registration, logging a panic if any of them fail to stop.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package bls implements a go-wrapper around a C BLS library leveraging the BLS12-381 curve.
|
Package bls implements a go-wrapper around a C BLS library leveraging the BLS12-381 curve. |
|
Package bytesutil defines helper methods for converting integers to byte slices.
|
Package bytesutil defines helper methods for converting integers to byte slices. |
|
Package cmd defines the command line flags for the shared utlities.
|
Package cmd defines the command line flags for the shared utlities. |
|
Package debug defines useful profiling utils that came originally with go-ethereum.
|
Package debug defines useful profiling utils that came originally with go-ethereum. |
|
Package legacyutil exists to convert Ethereum Serenity types to go-ethereum or Ethereum 1.0 types.
|
Package legacyutil exists to convert Ethereum Serenity types to go-ethereum or Ethereum 1.0 types. |
|
Package mclockutil is a wrapper for a monotonic clock source
|
Package mclockutil is a wrapper for a monotonic clock source |
|
Package p2p handles peer-to-peer networking for Ethereum Serenity clients.
|
Package p2p handles peer-to-peer networking for Ethereum Serenity clients. |
|
adapter/metric
Package metric contain some prometheus collectors for p2p services.
|
Package metric contain some prometheus collectors for p2p services. |
|
mock
Package mock_p2p is a generated GoMock package.
|
Package mock_p2p is a generated GoMock package. |
|
Package params defines important constants that are essential to the Ethereum 2.0 services.
|
Package params defines important constants that are essential to the Ethereum 2.0 services. |
|
Package sliceutil implements set operations for specified data type Currently types which are tested and supported are: []uint32 []int32 []string []float32 []uint64 []int64 []string []float64 Intersection, Union, Not , IsIn are the operations which are supported on slices
|
Package sliceutil implements set operations for specified data type Currently types which are tested and supported are: []uint32 []int32 []string []float32 []uint64 []int64 []string []float64 Intersection, Union, Not , IsIn are the operations which are supported on slices |
|
Package ssz implements the Simple Serialize algorithm specified at https://github.com/ethereum/eth2.0-specs/blob/master/specs/simple-serialize.md Currently directly supported types: bool uint8 uint16 uint32 uint64 bytes slice struct Types that can be implicitly supported: address: use byte slice of length 20 instead hash: use byte slice of length 32 instead if the hash is 32 bytes long, for example
|
Package ssz implements the Simple Serialize algorithm specified at https://github.com/ethereum/eth2.0-specs/blob/master/specs/simple-serialize.md Currently directly supported types: bool uint8 uint16 uint32 uint64 bytes slice struct Types that can be implicitly supported: address: use byte slice of length 20 instead hash: use byte slice of length 32 instead if the hash is 32 bytes long, for example |
|
Package testutil defines the testing utils such as asserting logs.
|
Package testutil defines the testing utils such as asserting logs. |
|
Package trieutil contains definitions for building a Merkle trie for validator deposits as defined in the Ethereum Serenity specification, as well as utilities to generate and verify Merkle proofs.
|
Package trieutil contains definitions for building a Merkle trie for validator deposits as defined in the Ethereum Serenity specification, as well as utilities to generate and verify Merkle proofs. |
Click to show internal directories.
Click to hide internal directories.