Maxine v0.1.0 API Reference

Modules

Functions for dealing with machines

Helper functions for use in callbacks. These get their own module because they really don’t belong with generate/2 and advance/3. The idea is that you

  import Maxine

when you’re controlling state machines, and you

  import Maxine.Callbacks

when you’re writing callback functions

The actual machine structure

Exceptions

For failures in the callback phase. For callbacks themselves, we don’t call this one directly. Use cause to wrap a more specific error

When a machine returns something other than a %Data{} or a %CallbackError

When applying the API to your machine yields unhandleable results; back to the drawing board. (It’s probably a type error of one kind or another.)

When a machine requests a non-existent callback function

On a non-existent event

When the event has no transition mapped for the present state