package pubsub

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

Dependency Relation
	imports 29 packages, and imported by 0 packages

Involved Source Files

	    pubsub.go
	    topic.go
Package-Level Type Names (total 21)

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

		Fields (total 21)
			Addrs []multiaddr.Multiaddr
				Addrs is a list of addresses.

			HTime time.Time
				HTime is human time

			Length int
				Length is a general length used for logging

			ListFilters *ListFilters
			MTime am.Time
				MTime is machine time

			MachClocks MachClocks
			MachId string
				MachId is a state machine ID

			Msg []byte
				Msg is a raw msg.

			MsgBye *MsgBye
			MsgGossip *MsgGossip
			MsgInfo *MsgInfo
				MsgInfo happens when a peer introduces it's exposed state machines.

			MsgReqInfo *MsgReqInfo
			MsgReqUpdates *MsgReqUpdates
			MsgType string
			MsgUpdates *MsgUpdates
			Msgs []*pubsub.Message
				Msgs is a list of PubSub messages.

			NetMachs chan<- []*rpc.NetworkMachine
				NetMachs is a return channel for a list of [rpc.NetworkMachine]. It has to
				be buffered or the mutation will fail.

			Peer string
				PeerId is a peer ID

			PeerId string
			PeerIds []string
			PeersGossip PeerGossips
		As Outputs Of (at least one exported)
			func ParseArgs(args am.A) *A
		As Inputs Of (at least one exported)
			func Pass(args *A) am.A

	 type Gossips (map)
	 type Info (struct)
		Info is sent when a peer exposes state machines in the topic.

		Fields (total 6)
			Id string
			MTime am.Time
			Parent string
			Schema am.Schema
			States am.S
			Tags []string

	 type ListFilters (struct)
		TODO merge with REPL, add tag-based queries (to find workers)

		Fields (total 8)
			ChildrenMax int
			ChildrenMin int
			DepthLevel int
				Level to traverse towards the tree root.

			IdExact string
			IdPartial string
			IdRegexp *regexp.Regexp
			Parent string
			PeerId string

	 type MachClocks (map)
		Machine clocks indexed by a local peer index.

	 type MachInfo (map)
	 type Msg (struct)

		Fields (only one)
			Type MsgType

	 type MsgBye (struct)
		TODO implement

		Fields (total 3)
			Machs map[int]MsgByeMach
			Msg Msg
			Msg.Type MsgType

	 type MsgByeMach (struct)
		MsgByeMach is sent when a peer un-exposes state machines in the topic.

		Fields (total 3)
			Id string
			MTime am.Time
			PeerBye bool

	 type MsgGossip (struct)

		Fields (total 3)
			Msg Msg
			Msg.Type MsgType
			PeerGossips PeerGossips
				Number of workers from each peer


	 type MsgInfo (struct)

		Fields (total 4)
			Msg Msg
			Msg.Type MsgType
			PeerGossips PeerGossips
				Number of workers from each peer

			PeerInfo PeerInfo
				peer ID => mach idx => schema


	 type MsgReqInfo (struct)

		Fields (total 3)
			Msg Msg
			Msg.Type MsgType
			PeerIds []string
				TODO list specific mach indexes


	 type MsgReqUpdates (struct)

		Fields (total 3)
			Msg Msg
			Msg.Type MsgType
			PeerIds []string
				TODO list specific mach indexes


	 type MsgType string (basic type)

		As Types Of (total 6)
			const MsgTypeBye
			const MsgTypeGossip
			const MsgTypeInfo
			const MsgTypeReqInfo
			const MsgTypeReqUpdates
			const MsgTypeUpdates

	 type MsgUpdates (struct)

		Fields (total 3)
			Msg Msg
			Msg.Type MsgType
			PeerClocks PeerClocks

	 type PeerClocks (map)
		Machine clocks indexed by a local peer index.

	 type PeerGossips (map)
		PeerGossips is peer ID => machine time sum
		TODO check local time sum

	 type PeerInfo (map)
	 type Topic (struct)
		Topic is a single-topic PubSub based on lib2p-pubsub with manual discovery.
		Each peer can have many exposed state machines and broadcasts their clock
		changes on the channel, introduces them when joining and via private messages
		to newly joined peers.
		TODO optimizations:
		  - avoid txs which will get cancelled (CPU)
		  - rate limit the TOTAL amount of msgs in the network (CPU, network)
		  - hook into libp2p errors, eg queue full, and act accordingly

		Fields (total 22)
			Addrs atomic.Pointer[[]ma.Multiaddr]
				Addrs is a list of addresses for this peer.

			ConnAddrs []ma.Multiaddr
				ConnAddrs contains a list of addresses for initial
				connections to discovery nodes in the network.

			ConnectionsToReady int
			DbgNetMachs bool
				DbgNetMachs exposes local network machines via to am-dbg

			Debounce time.Time
				Debounce for clock broadcasts (separate per each exposed state machine).

			ExceptionHandler *am.ExceptionHandler
			ExposedMachs []*am.Machine
				List of exposed state machines, index => mach_id, indexes are used on the
				channel. Indexes should NOT change, as they are used for addressing. `nil`
				value means empty.

			GossipAmount int
				Number of gossips to send in SendGossipsState

			HeartbeatFreq time.Duration
				HeartbeatFreq broadcasts changed clocks of exposed machines.

			HostToPeer map[string]string
			ListenAddrs []ma.Multiaddr
				ListenAddrs contains the list of multiaddresses that this topic listens on.
				None will allocate one automatically.

			LogEnabled bool
			Mach *am.Machine
				Mach is a state machine for this PubSub.

			MachMetrics atomic.Pointer[am.Machine]
			MaxMsgsPerWin int
				Maximum msgs per minute sent to the network. Does not include MsgInfo,
				which are debounced.

			MaxQueueLen uint16
				Max allowed queue length to send MsgInfo to newly joned peers, as well as
				received msgs.

			Multiplayer int
				all amounts and delayes are multiplied by this factor

			Name string
				Name indicates the name of the channel or topic instance,
				typically associated with a given process.

			SendInfoDebounceMs int
			T *ps.Topic
				T represents the PubSub topic used for communication.

			TestSchema am.Schema
				Use this hardcoded schema instead of exchanging real ones. Limits all the
				workers to this one.
				TODO catalog of named schemas, exchange unknown ones

			TestStates am.S
		Methods (total 57)
			(*Topic) ConnCount() int
			(*Topic) ConnectingEnter(e *am.Event) bool
			(*Topic) ConnectingState(e *am.Event)
			(*Topic) Dispose() am.Result
			(*Topic) DoSendInfoEnter(e *am.Event) bool
			(*Topic) DoSendInfoState(e *am.Event)
			(*Topic) ExceptionEnter(e *am.Event) bool
			(*Topic) ExceptionState(e *am.Event)
			(*Topic) GetPeerAddrs() ([]ma.Multiaddr, error)
			(*Topic) HeartbeatState(e *am.Event)
			(*Topic) Join() am.Result
			(*Topic) JoinedEnd(e *am.Event)
			(*Topic) JoinedState(e *am.Event)
			(*Topic) JoiningState(e *am.Event)
			(*Topic) ListMachinesEnter(e *am.Event) bool
			(*Topic) ListMachinesState(e *am.Event)
			(*Topic) MissPeersByGossipEnter(e *am.Event) bool
			(*Topic) MissPeersByGossipExit(e *am.Event) bool
			(*Topic) MissPeersByGossipState(e *am.Event)
			(*Topic) MissPeersByUpdatesEnter(e *am.Event) bool
			(*Topic) MissPeersByUpdatesExit(e *am.Event) bool
			(*Topic) MissPeersByUpdatesState(e *am.Event)
			(*Topic) MissUpdatesByGossipEnter(e *am.Event) bool
			(*Topic) MissUpdatesByGossipExit(e *am.Event) bool
			(*Topic) MissUpdatesByGossipState(e *am.Event)
			(*Topic) MsgByeEnter(e *am.Event) bool
			(*Topic) MsgInfoEnter(e *am.Event) bool
			(*Topic) MsgInfoState(e *am.Event)
			(*Topic) MsgReceivedEnter(e *am.Event) bool
			(*Topic) MsgReqInfoEnter(e *am.Event) bool
			(*Topic) MsgReqInfoState(e *am.Event)
			(*Topic) MsgReqUpdatesEnter(e *am.Event) bool
			(*Topic) MsgReqUpdatesState(e *am.Event)
				TODO this is never fired

			(*Topic) MsgUpdatesEnter(e *am.Event) bool
			(*Topic) MsgUpdatesState(e *am.Event)
			(*Topic) PeerJoinedEnter(e *am.Event) bool
			(*Topic) PeerJoinedState(e *am.Event)
			(*Topic) PeerLeftEnter(e *am.Event) bool
			(*Topic) ProcessMsgsState(e *am.Event)
			(*Topic) ReadyEnter(e *am.Event) bool
				TODO exit

			(*Topic) ReqMissingPeersEnter(e *am.Event) bool
			(*Topic) ReqMissingPeersState(e *am.Event)
			(*Topic) ReqMissingUpdatesEnter(e *am.Event) bool
			(*Topic) ReqMissingUpdatesState(e *am.Event)
			(*Topic) SendGossipsEnter(e *am.Event) bool
			(*Topic) SendGossipsState(e *am.Event)
			(*Topic) SendInfoEnter(e *am.Event) bool
			(*Topic) SendInfoState(e *am.Event)
			(*Topic) SendMsgEnter(e *am.Event) bool
			(*Topic) SendMsgState(e *am.Event)
			(*Topic) SendUpdatesEnter(e *am.Event) bool
			(*Topic) SendUpdatesState(e *am.Event)
			(*Topic) Start() am.Result
			(*Topic) StartAndJoin(ctx context.Context) am.Result
			(*Topic) StartEnd(e *am.Event)
			(*Topic) StartEnter(e *am.Event) bool
			(*Topic) StartState(e *am.Event)
		As Outputs Of (at least one exported)
			func NewTopic(ctx context.Context, name, suffix string, exposedMachs []*am.Machine, opts *TopicOpts) (*Topic, error)

	 type TopicOpts (struct)

		Fields (only one)
			Parent am.Api
				Parent is a parent state machine for a new Topic state machine. See
				[am.Opts].

		As Inputs Of (at least one exported)
			func NewTopic(ctx context.Context, name, suffix string, exposedMachs []*am.Machine, opts *TopicOpts) (*Topic, error)

	 type Tracer (struct)

		Fields (only one)
			TracerNoOp *am.TracerNoOp
		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 AddErrJoining(event *am.Event, mach *am.Machine, err error, args am.A) error
		AddErrJoining wraps an error in the ErrJoining sentinel and adds to a
		machine.

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

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

	 func NewTopic(ctx context.Context, name, suffix string, exposedMachs []*am.Machine, opts *TopicOpts) (*Topic, 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.


Package-Level Variables (total 2)

	  var ErrJoining error
	  var ErrListening error
Package-Level Constants (total 9)

	const APrefix = "am_pubsub"
	const EnvAmPubsubDbg = "AM_PUBSUB_DBG"
		EnvAmPubsubDbg exposes PubSub workers over dbg telemetry.

	const EnvAmPubsubLog = "AM_PUBSUB_LOG"
		EnvAmPubsubLog enables machine logging for pubsub.

	const MsgTypeBye MsgType = "bye"
	const MsgTypeGossip MsgType = "gossip"
	const MsgTypeInfo MsgType = "info"
	const MsgTypeReqInfo MsgType = "reqinfo"
	const MsgTypeReqUpdates MsgType = "requpdates"
	const MsgTypeUpdates MsgType = "updates"

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.