node

package
v0.14.1 Latest Latest
Warning

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

Go to latest
Published: Sep 12, 2026 License: MIT Imports: 31 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrVoterStateLost          = errors.New("voter state continuity cannot be established")
	ErrVoterEnrollmentRequired = errors.New("existing voter requires offline enrollment")
)

Functions

This section is empty.

Types

type Node

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

Node is the main runtime container.

func New

func New(config *types.ExecutionConfig) *Node

New creates a new Node.

func (*Node) API

func (n *Node) API() (*network.Server, error)

API returns the in-process Go API used by the HTTP adapter.

func (*Node) EnrollExistingVoter added in v0.13.0

func (n *Node) EnrollExistingVoter(ctx context.Context) error

EnrollExistingVoter registers a pre-registration WAL while all voters are offline. It neither restores missing voting state nor starts any listeners.

func (*Node) Handler

func (n *Node) Handler() (http.Handler, error)

Handler returns the optional HTTP server adapter after Open succeeds.

func (*Node) ObjectStoreStats

func (n *Node) ObjectStoreStats() (objectstore.Stats, bool)

func (*Node) Open

func (n *Node) Open(ctx context.Context) error

Open starts the embedded engine and its private peer transport without serving HTTP.

func (*Node) Ready added in v0.8.1

func (n *Node) Ready() bool

Ready reports whether local startup recovery and catch-up have completed. It does not prove current quorum availability.

func (*Node) Shutdown

func (n *Node) Shutdown() error

Shutdown gracefully shuts down the node.

func (*Node) Start

func (n *Node) Start(ctx context.Context) error

Start opens the embedded engine and serves the optional public HTTP adapter.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL