Categorygithub.com/stellarproject/element
modulepackage
0.0.0-20190619150558-a80106ab4a16
Repository: https://github.com/stellarproject/element.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
13
Dependents
0
Files
435 SLOC

# README

Element

Element handles simplified clustering among nodes. It handles peer management (joins, expiry, etc) as well as exposing GRPC services and publishing the GRPC endpoint address for each node throughout the group. This enables services to be built using element and allow simple publishing of the GRPC endpoints to other nodes for accessing the services.

# Functions

NewAgent returns a new node agent.

# Constants

LAN is a local area network connection intended for high speed, low latency networks.
Local is a local connection intended for high speed local development links.
NodeJoin is the event fired upon a node joining the cluster.
NodeLeave is the event fired upon a node leaving the cluster.
NodeUpdate is the event fired upon a node updating in the cluster.
WAN is a wide area connection intended for long distance remote links.

# Variables

No description provided by the author

# Structs

Agent represents the node agent.
Config is the agent config.
NodeEvent stores the event type and node information.
No description provided by the author
No description provided by the author

# Type aliases

ConnectionType defines the type of connection for the agent to use (wan, lan, local).
NodeEventType is the type of node event.