Embedding Felix

Important Objects

flx::run::flx_config

A helper object used to gather configuration data to pass to flx_world. Defined in flx_embed.fdoc, flx_world_config.[ch]pp. Creator lends pointer to flx_world. Used only by flx_world::setup method.

See [Configuration Object](Configuration Object)

flx::run::flx_world

Top level control object. Owned by embedder. Not collected.

Constructs and owns

• allocator
• collector
• collector profile
• primary user code library object
• primary instance of library
• async scheduler

Provides embedder access to:

• thread frame object
• synchronous scheduler
• asynchronous scheduler
• demux event handler initiator
• function to spawn new fibre
• function to perform multi-write to suspended Felix system
• functions to indicate suspension and restarting of main thread

and

• initialisation API
• teardown API