About Boost.MetaStateMachine
Please check out the library's documentation to learn more.
Quick Start
You are viewing the master version of this library.
The master and develop pages are shown here to provide access to the newest in-development in-progress documentation. See the "Documentation" link on this page.
Other aspects of the page will reflect the previous official version, or not be available until the next release.
Meta State Machine (MSM)
MSM is a Boost library that uses C++ metaprogramming for creating high-performance UML2 finite state machines.
It separates state machine modeling (front-end) from execution (back-end), allowing each to be chosen independently.
The classic back back-end supports C++03, the backmp11 back-end requires C++17.
The full documentation is available on Boost (latest release, develop).
Features
Front-end:
- State transitions (external, internal, completion) with actions and guards
- State entry & exit actions
- Deferred events — via state property and transition action
- Kleene (any) events — match any event in a transition
- Event hierarchies — use inheritance to match events in a transition
- Hierarchical state machines (composite states)
- Orthogonal regions
- History
- Pseudostates — entry, exit, fork, terminate
- State flags
Back-end (backmp11):
- Shared context in state machine hierarchies — data and root machine reference accessible across all submachines
- Observer — hook into state machine activities for logging and monitoring
- State visitor — traverse through active or all states
- Serialization — built-in support for Boost.Serialization, Boost.JSON, and nlohmann/json
- Compile-time trade-offs — choose between optimizing for runtime speed or compile time
- Heapless execution — configurable to avoid dynamic memory allocations
- Virtual dispatch support — encapsulate implementation details and swap implementations at runtime
Usage
This example models a connection to a host. It uses the functor front-end and the backmp11 back-end. More examples are available in the documentation.
#include <iostream>
#include <boost/msm/backmp11/state_machine.hpp>
#include <boost/msm/front/functor_row.hpp>
#include <boost/msm/front/state_machine_def.hpp>
namespace mp11 = boost::mp11;
namespace back = boost::msm::backmp11;
namespace front = boost::msm::front;
// Events
struct Connect
{
std::string host;
};
struct Disconnect {};
// Guards
struct IsValidHost
{
template <typename Fsm>
bool operator()(const Connect& event, Fsm&)
{
return !event.host.empty();
}
};
// Actions
struct LogConnection
{
template <typename Fsm>
void operator()(const Connect& event, Fsm& fsm)
{
std::cout << "Connected to " << event.host
<< " (connection #" << ++fsm.connection_count << ")"
<< std::endl;
}
};
// States
struct Disconnected : front::state<> {};
struct Connected : front::state<> {};
// State machine
struct Connection_ : front::state_machine_def<Connection_>
{
using initial_state = Disconnected;
using transition_table = mp11::mp_list<
// Source Event Target Action Guard
front::Row<Disconnected, Connect, Connected , LogConnection, IsValidHost>,
front::Row<Connected , Disconnect, Disconnected>
>;
size_t connection_count = 0;
};
using Connection = back::state_machine<Connection_>;
int main()
{
Connection sm;
sm.start();
sm.process_event(Connect{""}); // rejected by IsValidHost
sm.process_event(Connect{"localhost"}); // prints "Connected to localhost (connection #1)"
sm.process_event(Disconnect{});
}
<h1>Meta State Machine (MSM)</h1> <p>MSM is a Boost library that uses C++ metaprogramming for creating high-performance UML2 finite state machines. It separates state machine modeling (front-end) from execution (back-end), allowing each to be chosen independently. The classic <code>back</code> back-end supports C++03, the <code>backmp11</code> back-end requires C++17.</p> <p>The full documentation is available on Boost (<a href="https://www.boost.org/doc/libs/latest/doc/antora/msm/index.html">latest release</a>, <a href="https://www.boost.org/doc/libs/develop/doc/antora/msm/index.html">develop</a>).</p> <h1>Features</h1> <p>Front-end:</p> <ul> <li>State transitions (external, internal, completion) with actions and guards</li> <li>State entry & exit actions</li> <li>Deferred events — via state property and transition action</li> <li>Kleene (any) events — match any event in a transition</li> <li>Event hierarchies — use inheritance to match events in a transition</li> <li>Hierarchical state machines (composite states)</li> <li>Orthogonal regions</li> <li>History</li> <li>Pseudostates — entry, exit, fork, terminate</li> <li>State flags</li> </ul> <p>Back-end (<code>backmp11</code>):</p> <ul> <li>Shared context in state machine hierarchies — data and root machine reference accessible across all submachines</li> <li>Observer — hook into state machine activities for logging and monitoring</li> <li>State visitor — traverse through active or all states</li> <li>Serialization — built-in support for Boost.Serialization, Boost.JSON, and nlohmann/json</li> <li>Compile-time trade-offs — choose between optimizing for runtime speed or compile time</li> <li>Heapless execution — configurable to avoid dynamic memory allocations</li> <li>Virtual dispatch support — encapsulate implementation details and swap implementations at runtime</li> </ul> <h1>Usage</h1> <p>This example models a connection to a host. It uses the functor front-end and the <code>backmp11</code> back-end. More examples are available in the documentation.</p> <pre class="highlightjs highlight"><code class="language-cpp hljs">#include <iostream> #include <boost/msm/backmp11/state_machine.hpp> #include <boost/msm/front/functor_row.hpp> #include <boost/msm/front/state_machine_def.hpp> namespace mp11 = boost::mp11; namespace back = boost::msm::backmp11; namespace front = boost::msm::front; // Events struct Connect { std::string host; }; struct Disconnect {}; // Guards struct IsValidHost { template <typename Fsm> bool operator()(const Connect& event, Fsm&) { return !event.host.empty(); } }; // Actions struct LogConnection { template <typename Fsm> void operator()(const Connect& event, Fsm& fsm) { std::cout << "Connected to " << event.host << " (connection #" << ++fsm.connection_count << ")" << std::endl; } }; // States struct Disconnected : front::state<> {}; struct Connected : front::state<> {}; // State machine struct Connection_ : front::state_machine_def<Connection_> { using initial_state = Disconnected; using transition_table = mp11::mp_list< // Source Event Target Action Guard front::Row<Disconnected, Connect, Connected , LogConnection, IsValidHost>, front::Row<Connected , Disconnect, Disconnected> >; size_t connection_count = 0; }; using Connection = back::state_machine<Connection_>; int main() { Connection sm; sm.start(); sm.process_event(Connect{""}); // rejected by IsValidHost sm.process_event(Connect{"localhost"}); // prints "Connected to localhost (connection #1)" sm.process_event(Disconnect{}); } </code></pre>
-
Code Commits Commits authored to any Boost repository. With 1 contribution, you will earn the bronze badge for Code Commits.
-
Documentation Doc contributions using standardised Boost tooling (Antora / BoostLook). With 1 contribution, you will earn the bronze badge for Documentation.
-
Library Authoring Authored an original Boost library accepted into the collection. With 1 contribution, you will earn the bronze badge for Library Authoring.
-
Library Maintenance Number of libraries actively maintained. With 1 contribution, you will earn the bronze badge for Library Maintenance.
-
Library Review Formal review submissions on Boost proposals. With 1 contribution, you will earn the bronze badge for Library Review.
-
Library Versioning Authored new versions / releases of Boost libraries. With 10 contributions, you will earn the bronze badge for Library Versioning.
-
Mailing List Participation Participation on the Boost developers mailing list. With 1 contribution, you will earn the bronze badge for Mailing List Participation.
-
News Posts Published Articles / news posts published on Boost.org. With 1 contribution, you will earn the bronze badge for News Posts Published.
<h1>Meta State Machine (MSM)</h1> <p>MSM is a Boost library that uses C++ metaprogramming for creating high-performance UML2 finite state machines. It separates state machine modeling (front-end) from execution (back-end), allowing each to be chosen independently. The classic <code>back</code> back-end supports C++03, the <code>backmp11</code> back-end requires C++17.</p> <p>The full documentation is available on Boost (<a href="https://www.boost.org/doc/libs/latest/doc/antora/msm/index.html">latest release</a>, <a href="https://www.boost.org/doc/libs/develop/doc/antora/msm/index.html">develop</a>).</p> <h1>Features</h1> <p>Front-end:</p> <ul> <li>State transitions (external, internal, completion) with actions and guards</li> <li>State entry & exit actions</li> <li>Deferred events — via state property and transition action</li> <li>Kleene (any) events — match any event in a transition</li> <li>Event hierarchies — use inheritance to match events in a transition</li> <li>Hierarchical state machines (composite states)</li> <li>Orthogonal regions</li> <li>History</li> <li>Pseudostates — entry, exit, fork, terminate</li> <li>State flags</li> </ul> <p>Back-end (<code>backmp11</code>):</p> <ul> <li>Shared context in state machine hierarchies — data and root machine reference accessible across all submachines</li> <li>Observer — hook into state machine activities for logging and monitoring</li> <li>State visitor — traverse through active or all states</li> <li>Serialization — built-in support for Boost.Serialization, Boost.JSON, and nlohmann/json</li> <li>Compile-time trade-offs — choose between optimizing for runtime speed or compile time</li> <li>Heapless execution — configurable to avoid dynamic memory allocations</li> <li>Virtual dispatch support — encapsulate implementation details and swap implementations at runtime</li> </ul> <h1>Usage</h1> <p>This example models a connection to a host. It uses the functor front-end and the <code>backmp11</code> back-end. More examples are available in the documentation.</p> <pre class="highlightjs highlight"><code class="language-cpp hljs">#include <iostream> #include <boost/msm/backmp11/state_machine.hpp> #include <boost/msm/front/functor_row.hpp> #include <boost/msm/front/state_machine_def.hpp> namespace mp11 = boost::mp11; namespace back = boost::msm::backmp11; namespace front = boost::msm::front; // Events struct Connect { std::string host; }; struct Disconnect {}; // Guards struct IsValidHost { template <typename Fsm> bool operator()(const Connect& event, Fsm&) { return !event.host.empty(); } }; // Actions struct LogConnection { template <typename Fsm> void operator()(const Connect& event, Fsm& fsm) { std::cout << "Connected to " << event.host << " (connection #" << ++fsm.connection_count << ")" << std::endl; } }; // States struct Disconnected : front::state<> {}; struct Connected : front::state<> {}; // State machine struct Connection_ : front::state_machine_def<Connection_> { using initial_state = Disconnected; using transition_table = mp11::mp_list< // Source Event Target Action Guard front::Row<Disconnected, Connect, Connected , LogConnection, IsValidHost>, front::Row<Connected , Disconnect, Disconnected> >; size_t connection_count = 0; }; using Connection = back::state_machine<Connection_>; int main() { Connection sm; sm.start(); sm.process_event(Connect{""}); // rejected by IsValidHost sm.process_event(Connect{"localhost"}); // prints "Connected to localhost (connection #1)" sm.process_event(Disconnect{}); } </code></pre>
-
Achievement-based Reflects the depth of your contributions. Accumulate achievements to unlock five tiers; Bronze, Silver, Gold, Platinum and Diamond.
-
Tenure-based Awarded in recognition of your time on the platform. The longer you've been part of the Boost community, the higher the tier you unlock.
-
Boost day celebration A celebration of the day you joined Boost. Awarded annually to mark another year as part of the community.
