intercom

package

v0.0.0-...-dde4a86 Latest Latest Go to latest Published: Jun 14, 2022 License: MPL-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	StatusNetworkOff string = "Networking disabled"
)

Message constants

This section is empty.

func RunServer(metaDir string)

RunServer starts the intercom server on a socket stored in the specified meta directory

type EmptyMessage struct{}

EmptyMessage with no data

type ListNodesResponse struct {
	Nodes []raft.Node
}

ListNodesResponse with all Nodes

type Server struct{}

Server listens on a Unix socket to respond to questions asked by external applications.

func (s *Server) ConfirmUp(req *EmptyMessage, resp *EmptyMessage) error

ConfirmUp is simple method that paranoid-cli uses to ping PFSD

func (s *Server) ListNodes(req *EmptyMessage, resp *ListNodesResponse) error

ListNodes that pfsd is connected to

func (s *Server) Status(req *EmptyMessage, resp *StatusResponse) error

Status provides health data for the current node.

type StatusResponse struct {
	Uptime    time.Duration
	Status    string
	TLSActive bool
	Port      int
}

StatusResponse with data about the status of pfsd