package graph

Import Path
	/pkg/graph (on go.dev)

Dependency Relation
	imports 14 packages, and imported by 3 packages

Involved Source Files

	  d graph.go
		Package graph provides a graph or interconnected state-machines and their
		states, based on the dbg telemetry protocol.
Package-Level Type Names (total 10)

	/* sort by: alphabet | popularity */
	 type Client (struct)
		Client represents a single state machine withing the network graph.

		Fields (total 6)
			ConnId string
			Id string
			LatestMTime am.Time
			LatestMsgTx *dbg.DbgMsgTx
			LatestTimeSum uint64
			MsgSchema *dbg.DbgMsgStruct
				TODO version schemas

		As Outputs Of (at least one exported)
			func github.com/pancsta/asyncmachine-go/tools/visualizer.(*Visualizer).Clients() map[string]Client

	 type Connection (struct)

		Fields (total 3)
			Edge *EdgeData
			Source *Vertex
			Target *Vertex
		As Outputs Of (at least one exported)
			func (*Graph).Connection(source, target string) (*Connection, error)

	 type Edge = (struct)
	 type EdgeData (struct)

		Fields (total 5)
			MachChildOf bool
				machine is a child of another machine

			MachConnectedTo bool
				machine has an RPC connection to another machine

			MachHas *MachineHas
				machine has a state

			MachPipesTo []*MachPipeTo
				machine has pipes going to another machine

			StateRelation []*StateRelation
				state has relations with other states


	 type Graph (struct)

		Fields (total 4)
			Clients map[string]*Client
			G graph.Graph[string, *Vertex]
				G is a directed graph of machines and states with metadata.

			Map graph.Graph[string, *Vertex]
				Map is a unidirectional mirror of g, without metadata.

			Server *am.Machine
		Methods (total 8)
			(*Graph) AddClient(msg *dbg.DbgMsgStruct) error
			(*Graph) Clear()
			(*Graph) Clone() (*Graph, error)
				Clone returns a deep clone of the graph.

			(*Graph) Connection(source, target string) (*Connection, error)
				Connection returns a Connection for the given source-target.

			(*Graph) DumpGv(path string) error
				DumpGv will create a dot-format *.gv file of the graph. To create an SVG:
				
					dot -Tsvg -O path

			(*Graph) Inspect() (map[string]*MachInspect, error)
			(*Graph) ParseMsg(id string, msgTx *dbg.DbgMsgTx)
			(*Graph) RemoveClient(id string) error
		As Outputs Of (at least 2)
			func New(server *am.Machine) (*Graph, error)
			func (*Graph).Clone() (*Graph, error)
		As Inputs Of (at least one exported)
			func github.com/pancsta/asyncmachine-go/tools/visualizer.NewRenderer(graph *Graph, logger func(msg string, args ...any)) *visualizer.Renderer

	 type MachineHas (struct)

		Fields (total 3)
			Auto bool
			Inherited string
			Multi bool

	 type MachInspect (struct)

		Fields (total 8)
			Child string
			Conns []string
			MTime am.Time
			Pipes map[string][]string
			Schema am.Schema
			States []string
			Tags []string
			Time uint64
		As Outputs Of (at least one exported)
			func (*Graph).Inspect() (map[string]*MachInspect, error)
		As Inputs Of (at least 2)
			func Markdown(inspect map[string]*MachInspect) string
			func Markup(inspect map[string]*MachInspect) string

	 type MachPipeTo (struct)
		TODO use am.Pipe

		Fields (total 3)
			FromState string
			MutType am.MutationType
			ToState string

	 type StateRelation (struct)

		Fields (only one)
			RelType am.Relation

	 type Vertex (struct)

		Fields (total 2)
			MachId string
			StateName string


Package-Level Functions (total 4)

	 func AddErrGraph(event *am.Event, mach *am.Machine, err error, args ...am.A) am.Result
		AddErrGraph adds [ErrGraph].

	 func Markdown(inspect map[string]*MachInspect) string
		Markdown returns a Markdown format of the network graph, with state lists,
		with a flat hierarchy. It's useful for debugging.

	 func Markup(inspect map[string]*MachInspect) string
		Markup returns an XML format of the network graph, including full schemas,
		with a nested hierarchy. It's useful for CSS/XPath queries.

	 func New(server *am.Machine) (*Graph, error)
Package-Level Variables (only one)

	  var ErrGraph error

The pages are generated with Golds v0.8.4. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.