graph

Documentation

Index

• Constants
• Variables
• func NewGraphStore(st storage.MeshStorage) graph.Store[string, MeshNode]
• type Graph
  • func NewGraph(st storage.MeshStorage) Graph
• type GraphStore
  • func (g *GraphStore) AddEdge(sourceNode, targetNode string, edge graph.Edge[string]) error
  • func (g *GraphStore) AddVertex(nodeID string, node MeshNode, props graph.VertexProperties) error
  • func (g *GraphStore) Edge(sourceNode, targetNode string) (graph.Edge[string], error)
  • func (g *GraphStore) ListEdges() ([]graph.Edge[string], error)
  • func (g *GraphStore) ListVertices() ([]string, error)
  • func (g *GraphStore) RemoveEdge(sourceNode, targetNode string) error
  • func (g *GraphStore) RemoveVertex(nodeID string) error
  • func (g *GraphStore) UpdateEdge(sourceNode, targetNode string, edge graph.Edge[string]) error
  • func (g *GraphStore) Vertex(nodeID string) (node MeshNode, props graph.VertexProperties, err error)
  • func (g *GraphStore) VertexCount() (int, error)
• type MeshNode
  • func (n *MeshNode) DNSPort() uint16
  • func (n *MeshNode) HasFeature(feature v1.Feature) bool
  • func (n *MeshNode) PortFor(feature v1.Feature) uint16
  • func (n *MeshNode) PrivateAddrV4() netip.Prefix
  • func (n *MeshNode) PrivateAddrV6() netip.Prefix
  • func (n *MeshNode) PrivateDNSAddrV4() netip.AddrPort
  • func (n *MeshNode) PrivateDNSAddrV6() netip.AddrPort
  • func (n *MeshNode) PrivateRPCAddrV4() netip.AddrPort
  • func (n *MeshNode) PrivateRPCAddrV6() netip.AddrPort
  • func (n *MeshNode) PrivateRaftAddrV4() netip.AddrPort
  • func (n *MeshNode) PrivateRaftAddrV6() netip.AddrPort
  • func (n *MeshNode) PrivateTURNAddrV4() netip.AddrPort
  • func (n *MeshNode) PrivateTURNAddrV6() netip.AddrPort
  • func (n *MeshNode) PublicDNSAddr() netip.AddrPort
  • func (n *MeshNode) PublicRPCAddr() netip.AddrPort
  • func (n *MeshNode) RPCPort() uint16
  • func (n *MeshNode) RaftPort() uint16
  • func (n *MeshNode) TURNPort() uint16
  • func (n *MeshNode) Unmarshal(data []byte) error

Constants

const EdgesPrefix = storage.RegistryPrefix + "edges"

EdgesPrefix is where edges are stored in the database. edges are indexed by their source and target node IDs in the format /registry/edges/<source>/<target>.

const NodesPrefix = storage.RegistryPrefix + "nodes"

NodesPrefix is where nodes are stored in the database. nodes are indexed by their ID in the format /registry/nodes/<id>.

Variables

var ErrEdgeNotFound = graph.ErrEdgeNotFound

ErrEdgeNotFound is returned when an edge is not found.

Functions

func NewGraphStore

func NewGraphStore(st storage.MeshStorage) graph.Store[string, MeshNode]

NewGraphStore creates a new GraphStore instance.

Types

type Graph

type Graph graph.Graph[string, MeshNode]

Graph is the graph.Graph implementation for the mesh network.

func NewGraph

func NewGraph(st storage.MeshStorage) Graph

NewGraph creates a new Graph instance.

type GraphStore

type GraphStore struct {
	storage.MeshStorage
	// contains filtered or unexported fields
}

GraphStore implements graph.Store[string, Node] where string is the node ID and Node is the node itself.

func (*GraphStore) AddEdge

func (g *GraphStore) AddEdge(sourceNode, targetNode string, edge graph.Edge[string]) error

AddEdge should add an edge between the vertices with the given source and target hashes.

If either vertex doesn't exit, ErrVertexNotFound should be returned for the respective vertex. If the edge already exists, ErrEdgeAlreadyExists should be returned.

func (*GraphStore) AddVertex

func (g *GraphStore) AddVertex(nodeID string, node MeshNode, props graph.VertexProperties) error

AddVertex should add the given vertex with the given hash value and vertex properties to the graph. If the vertex already exists, it is up to you whether ErrVertexAlreadyExists or no error should be returned.

func (*GraphStore) Edge

func (g *GraphStore) Edge(sourceNode, targetNode string) (graph.Edge[string], error)

Edge should return the edge joining the vertices with the given hash values. It should exclusively look for an edge between the source and the target vertex, not vice versa. The graph implementation does this for undirected graphs itself.

Note that unlike Graph.Edge, this function is supposed to return an Edge[K], i.e. an edge that only contains the vertex hashes instead of the vertices themselves.

If the edge doesn't exist, ErrEdgeNotFound should be returned.

func (*GraphStore) ListEdges

func (g *GraphStore) ListEdges() ([]graph.Edge[string], error)

ListEdges should return all edges in the graph in a slice.

func (*GraphStore) ListVertices

func (g *GraphStore) ListVertices() ([]string, error)

ListVertices should return all vertices in the graph in a slice.

func (*GraphStore) RemoveEdge

func (g *GraphStore) RemoveEdge(sourceNode, targetNode string) error

RemoveEdge should remove the edge between the vertices with the given source and target hashes.

If either vertex doesn't exist, it is up to you whether ErrVertexNotFound or no error should be returned. If the edge doesn't exist, it is up to you whether ErrEdgeNotFound or no error should be returned.

func (*GraphStore) RemoveVertex

func (g *GraphStore) RemoveVertex(nodeID string) error

RemoveVertex should remove the vertex with the given hash value. If the vertex doesn't exist, ErrVertexNotFound should be returned. If the vertex has edges to other vertices, ErrVertexHasEdges should be returned.

func (*GraphStore) UpdateEdge

func (g *GraphStore) UpdateEdge(sourceNode, targetNode string, edge graph.Edge[string]) error

UpdateEdge should update the edge between the given vertices with the data of the given Edge instance. If the edge doesn't exist, ErrEdgeNotFound should be returned.

func (*GraphStore) Vertex

func (g *GraphStore) Vertex(nodeID string) (node MeshNode, props graph.VertexProperties, err error)

Vertex should return the vertex and vertex properties with the given hash value. If the vertex doesn't exist, ErrVertexNotFound should be returned.

func (*GraphStore) VertexCount

func (g *GraphStore) VertexCount() (int, error)

VertexCount should return the number of vertices in the graph. This should be equal to the length of the slice returned by ListVertices.

type MeshNode

type MeshNode struct{ *v1.MeshNode }

func (*MeshNode) DNSPort

func (n *MeshNode) DNSPort() uint16

DNSPort returns the node's DNS port.

func (*MeshNode) HasFeature

func (n *MeshNode) HasFeature(feature v1.Feature) bool

HasFeature returns true if the node has the given feature.

func (*MeshNode) PortFor

func (n *MeshNode) PortFor(feature v1.Feature) uint16

PortFor returns the port for the given feature, or 0 if the feature is not available on this node.

func (*MeshNode) PrivateAddrV4

func (n *MeshNode) PrivateAddrV4() netip.Prefix

PrivateAddrV4 returns the node's private IPv4 address. Be sure to check if the returned Addr IsValid.

func (*MeshNode) PrivateAddrV6

func (n *MeshNode) PrivateAddrV6() netip.Prefix

PrivateAddrV6 returns the node's private IPv6 address. Be sure to check if the returned Addr IsValid.

func (*MeshNode) PrivateDNSAddrV4

func (n *MeshNode) PrivateDNSAddrV4() netip.AddrPort

PrivateDNSAddrV4 returns the private IPv4 address for the node's DNS server. Be sure to check if the returned AddrPort IsValid.

func (*MeshNode) PrivateDNSAddrV6

func (n *MeshNode) PrivateDNSAddrV6() netip.AddrPort

PrivateDNSAddrV6 returns the private IPv6 address for the node's DNS server. Be sure to check if the returned AddrPort IsValid.

func (*MeshNode) PrivateRPCAddrV4

func (n *MeshNode) PrivateRPCAddrV4() netip.AddrPort

PrivateRPCAddrV4 returns the private IPv4 address for the node's RPC server. Be sure to check if the returned AddrPort IsValid.

func (*MeshNode) PrivateRPCAddrV6

func (n *MeshNode) PrivateRPCAddrV6() netip.AddrPort

PrivateRPCAddrV6 returns the private IPv6 address for the node's RPC server. Be sure to check if the returned AddrPort IsValid.

func (*MeshNode) PrivateRaftAddrV4

func (n *MeshNode) PrivateRaftAddrV4() netip.AddrPort

PrivateRaftAddrV4 returns the private IPv4 address for the node's raft listener. Be sure to check if the returned AddrPort IsValid.

func (*MeshNode) PrivateRaftAddrV6

func (n *MeshNode) PrivateRaftAddrV6() netip.AddrPort

PrivateRaftAddrV6 returns the private IPv6 address for the node's raft listener. Be sure to check if the returned AddrPort IsValid.

func (*MeshNode) PrivateTURNAddrV4

func (n *MeshNode) PrivateTURNAddrV4() netip.AddrPort

PrivateTURNAddrV4 returns the private IPv4 address for the node's TURN server. Be sure to check if the returned AddrPort IsValid.

func (*MeshNode) PrivateTURNAddrV6

func (n *MeshNode) PrivateTURNAddrV6() netip.AddrPort

PrivateTURNAddrV6 returns the private IPv6 address for the node's TURN server. Be sure to check if the returned AddrPort IsValid.

func (*MeshNode) PublicDNSAddr

func (n *MeshNode) PublicDNSAddr() netip.AddrPort

PublicDNSAddr returns the public address for the node's DNS server. Be sure to check if the returned AddrPort IsValid.

func (*MeshNode) PublicRPCAddr

func (n *MeshNode) PublicRPCAddr() netip.AddrPort

PublicRPCAddr returns the public address for the node's RPC server. Be sure to check if the returned AddrPort IsValid.

func (*MeshNode) RPCPort

func (n *MeshNode) RPCPort() uint16

RPCPort returns the node's RPC port.

func (*MeshNode) RaftPort

func (n *MeshNode) RaftPort() uint16

RaftPort returns the node's Raft port.

func (*MeshNode) TURNPort

func (n *MeshNode) TURNPort() uint16

TURNPort returns the node's TURN port.

func (*MeshNode) Unmarshal

func (n *MeshNode) Unmarshal(data []byte) error