package
4.0.2-stable+incompatible
Repository: https://github.com/algorand/go-algorand.git
Documentation: pkg.go.dev
# Functions
MakeKMDController initializes a KMDController.
MakeNodeController creates a NodeController representing a specific data directory (and an associated binary directory).
NewLaggedStdIo creates a new instance of the LaggedStdIo.
# Constants
DefaultKMDDataDir is exported so tests can initialize it with config info.
DefaultKMDDataDirPerms is exported so tests can initialize the default kmd data dir.
StdErrFilename is the name of the file in <datadir> where stderr will be captured if not redirected to host.
StdOutFilename is the name of the file in <datadir> where stdout will be captured if not redirected to host.
# Structs
AlgodStartArgs are the possible arguments for starting algod.
KMDController wraps directories and processes involved in running kmd.
KMDStartArgs are the possible arguments for starting kmd.
LaggedStdIo is an indirect wrapper around os.Stdin/os.Stdout/os.Stderr that prevents direct dependency which could be an issue when a caller panics, leaving the child processes alive and blocks for EOF.
MissingDataDirError thrown when StopAlgod is called but requested directory does not exist.
NodeController provides an object for controlling a specific algod node instance.
NodeKilledError thrown when StopAlgod is called but the node was killed by SIGKILL instead of a clean shutdown with SIGTERM.
NodeNotRunningError thrown when StopAlgod is called but there is no running algod in requested directory.
NodeStartArgs represents the possible arguments for starting the node processes.
# Type aliases
AlgodExitErrorCallback is the callback function from the node controller that reports upstream in case there was a change with the algod running state.