package main

Import Path
	github.com/pancsta/asyncmachine-go/examples/mach_template (on go.dev)

Dependency Relation
	imports 13 packages, and imported by 0 packages

Involved Source Files

	m   mach_template.go
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type A (struct)
		A is a struct for node arguments. It's a typesafe alternative to [am.A].

		Fields (total 3)
			Addr string
			Id string
			ReturnCh chan<- []string
		As Outputs Of (at least one exported)
			func ParseArgs(args am.A) *A
		As Inputs Of (at least 2)
			func Pass(args *A) am.A
			func PassRpc(args *A) am.A

	 type ARpc (struct)
		ARpc is a subset of A, that can be passed over RPC.

		Fields (total 2)
			Addr string
			Id string

	 type S = am.S ([])
	 type TemplateHandlers (struct)

		Fields (total 2)
			ExceptionHandler *am.ExceptionHandler
			Mach *am.Machine
		Methods (total 7)
			(*TemplateHandlers) BarExit(e *am.Event) bool
			(*TemplateHandlers) BazDoneState(e *am.Event)
			(*TemplateHandlers) BazState(e *am.Event)
			(*TemplateHandlers) ChannelEnter(e *am.Event) bool
			(*TemplateHandlers) ChannelState(e *am.Event)
			( TemplateHandlers) ExceptionState(e *machine.Event)
				ExceptionState is a final entry handler for the StateException state.
				Args:
				- err error: The error that caused the StateException state.
				- panic *ExceptionArgsPanic: Optional details about the panic.

			(*TemplateHandlers) FooState(e *am.Event)

	 type Tracer (struct)

		Fields (only one)
			NoOpTracer *am.NoOpTracer
		Methods (total 13)
			( Tracer) HandlerEnd(transition *machine.Transition, emitter string, handler string)
			( Tracer) HandlerStart(transition *machine.Transition, emitter string, handler string)
			( Tracer) Inheritable() bool
			( Tracer) MachineDispose(machID string)
			( Tracer) MachineInit(machine machine.Api) context.Context
			( Tracer) MutationQueued(machine machine.Api, mutation *machine.Mutation)
			( Tracer) NewSubmachine(parent, machine machine.Api)
			( Tracer) QueueEnd(machine machine.Api)
			( Tracer) SchemaChange(machine machine.Api, old machine.Schema)
			(*Tracer) TransitionEnd(transition *am.Transition)
				TransitionEnd sends a message when a transition ends

			( Tracer) TransitionInit(transition *machine.Transition)
			( Tracer) TransitionStart(transition *machine.Transition)
			( Tracer) VerifyStates(machine machine.Api)
		Implements (at least one exported)
			*Tracer : github.com/pancsta/asyncmachine-go/pkg/machine.Tracer


Package-Level Functions (total 6)

	 func AddErrExample(event *am.Event, mach *am.Machine, err error, args am.A) error
		AddErrExample wraps an error in the ErrJoining sentinel and adds to a
		machine.

	 func LogArgs(args am.A) map[string]string
		LogArgs is an args logger for A.

	 func NewTemplate(ctx context.Context, num int) (*am.Machine, error)
	 func ParseArgs(args am.A) *A
		ParseArgs extracts A from [am.Event.Args][APrefix].

	 func Pass(args *A) am.A
		Pass prepares [am.A] from A to pass to further mutations.

	 func PassRpc(args *A) am.A
		PassRpc prepares [am.A] from A to pass over RPC.


Package-Level Variables (only one)

	  var ErrExample error
Package-Level Constants (only one)

	const APrefix = "am_node"

The pages are generated with Golds v0.8.2. (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.