package
1.5.0
Repository: https://github.com/m3db/m3.git
Documentation: pkg.go.dev

# Functions

New returns a new ServiceNode.
NewConcurrentExecutor returns a new concurrent executor.
NewHeartbeatOptions returns the default HeartbeatOptions.
NewHeartbeatRouter returns a new heartbeat router.
NewListener creates a new listener.
NewMockOptions creates a new mock instance.
NewMockServiceNode creates a new mock instance.
NewOptions returns a new Options construct.

# Constants

RemoteProcessStderr refers to the remote process stderr.
RemoteProcessStdout refers to the remote process stdout.
StatusError is the state of a node which is in an Error state.
StatusRunning is the state of a node which has been Start()-ed.
StatusSetup is the state of a node which has been Setup().
StatusUninitialized refers to the state of an un-initialized node.

# Structs

Configuration is a YAML wrapper around Options.
HeartbeatConfiguration is a YAML compatible wrapper around HeartbeatOptions.
MockOptions is a mock of Options interface.
MockOptionsMockRecorder is the mock recorder for MockOptions.
MockServiceNode is a mock of ServiceNode interface.
MockServiceNodeMockRecorder is the mock recorder for MockServiceNode.

# Interfaces

ConcurrentExecutor executes functions on a collection of service nodes concurrently.
HeartbeatOptions are the knobs to control heartbeating behavior.
HeartbeatRouter routes heartbeats based on registered servers.
Listener provides callbacks invoked upon remote process state transitions.
Options are the various knobs to control Node behavior.
ServiceNode represents an executable service node.

# Type aliases

ListenerID is a unique identifier for a registered listener.
OperatorClientFn returns a function able to construct connections to remote Operators.
RemoteOutputType describes the various outputs available on the remote agents.
ServiceNodeFn performs an operation on a given ServiceNode.
ServiceNodes is a collection of ServiceNode(s).
Status indicates the different states a ServiceNode can be in.