tconsole

package
v0.0.0-...-8fcbe07 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 22, 2025 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config 

type Config struct {
	Terminal    Terminal
	LogTree     *logtree.LogTree
	Network     event.Value[*node.NetStatus]
	Roles       event.Value[*cpb.NodeRoles]
	CuratorConn event.Value[*roleserve.CuratorConnection]
}

type Console 

type Console struct {
	// Quit will be closed when the user press CTRL-C. A new channel will be created
	// on each New call.
	Quit chan struct{}
	// contains filtered or unexported fields
}

Console is a Terminal Console (TConsole), a user-interactive informational display visible on the TTY of a running Metropolis instance.

func New 

func New(config Config, ttyPath string) (*Console, error)

New creates a new Console, taking over the TTY at the given path. The given Terminal type selects between a Linux terminal (VTY) and a generic terminal for testing.

network, roles, curatorConn point to various Metropolis subsystems that are used to populate the console data.

func (*Console) Cleanup 

func (c *Console) Cleanup()

Cleanup should be called when the console exits. This is only used in testing, the Metropolis console always runs.

func (*Console) Run 

func (c *Console) Run(ctx context.Context) error

Run blocks while displaying the Console to the user.

type Terminal 

type Terminal string

Terminal is a supported terminal kind. This is a simplistic alternative to terminfo. 

const (
	// TerminalLinux is a linux VTY console.
	TerminalLinux Terminal = "linux"
	// TerminalGeneric is any other terminal that is supported by tcell.
	TerminalGeneric Terminal = "generic"
)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.