Causality

The queue used by the default bus for thread-safety. Also the default queue used for all buses (unless specified on initialization).

A default/global bus

Subscriptions can have the following statuses:

Subscription identifier used by subscribers to be able to unsubscribe. Callers should make no assumptions about the underlying type of a Subscription. (i.e. it may change to a struct, class, or protocol at some point)

A Bus for events to go from publishers to subscribers

Underlying type for EventIds (do not rely on this always being a UUID)

A type-erased form of an Event. Callers usally do not need to worry about this.

Declare events to be used as endpoints for publish or subscribe calls.

Example:

static let SomeEvent = Causality.Event<Int>(label: "Some Event")

This declares SomeEvent as an event that will require an Int on publish and will pass the same Int to the subscription handler.

Undocumented

DynamicEvent can be used if you need to uniquely identify states by paramter. To properly declare your DynamicEvent, ensure you define your CodingKeys and override encode() to conform to Encodable. All keys that you want to be included in the unique identification should be specified in encode().

Subscription handler for Events. Used to unsubscribe() or determine the bus or state that triggered an update.

Subscription handler for States. Used to unsubscribe() or determine the bus or state that triggered an update.

Custom types used as messages should conform to Message

A convenience message that can be included for events that have no associated data

Type-erased StateValue

Custom type for State info

Base class that State<Causality.StateValue> and DynamicState<Causality.StateValue> conform to.

Declare states with typed values as labels to be used for set() and subscribe() calls.

Example:

static let SomeState = Causality.State<Int>(label: "Some State")

This declares SomeState as an state that will pass an Int to subscribers whenever the value changes.

DynamicState can be used if you need to uniquely identify states by paramter. To properly declare your DynamicState, ensure you define your CodingKeys and override encode() to conform to Encodable. All keys that you want to be included in the unique identification should be specified in encode().