Mir
Public Member Functions | List of all members
miral::MirRunner Class Reference

Runner for applying initialization options to Mir. More...

#include <runner.h>

Public Member Functions

 MirRunner (int argc, char const *argv[])
 
 MirRunner (int argc, char const *argv[], char const *config_file)
 
 ~MirRunner ()
 
void add_start_callback (std::function< void()> const &start_callback)
 Add a callback to be invoked when the server has started, If multiple callbacks are added they will be invoked in the sequence added. More...
 
void add_stop_callback (std::function< void()> const &stop_callback)
 Add a callback to be invoked when the server is about to stop, If multiple callbacks are added they will be invoked in the reverse sequence added. More...
 
void set_exception_handler (std::function< void()> const &handler)
 Set a handler for exceptions caught in run_with(). run_with() invokes handler() in catch (...) blocks before returning EXIT_FAILURE. Hence the exception can be re-thrown to retrieve type information. The default action is to call mir::report_exception(std::cerr) More...
 
auto run_with (std::initializer_list< std::function< void(::mir::Server &)>> options) -> int
 Apply the supplied initialization options and run the Mir server. More...
 
void stop ()
 Tell the Mir server to exit. More...
 

Detailed Description

Runner for applying initialization options to Mir.

Constructor & Destructor Documentation

◆ MirRunner() [1/2]

miral::MirRunner::MirRunner ( int  argc,
char const *  argv[] 
)

◆ MirRunner() [2/2]

miral::MirRunner::MirRunner ( int  argc,
char const *  argv[],
char const *  config_file 
)

◆ ~MirRunner()

miral::MirRunner::~MirRunner ( )

Member Function Documentation

◆ add_start_callback()

void miral::MirRunner::add_start_callback ( std::function< void()> const &  start_callback)

Add a callback to be invoked when the server has started, If multiple callbacks are added they will be invoked in the sequence added.

◆ add_stop_callback()

void miral::MirRunner::add_stop_callback ( std::function< void()> const &  stop_callback)

Add a callback to be invoked when the server is about to stop, If multiple callbacks are added they will be invoked in the reverse sequence added.

◆ run_with()

auto miral::MirRunner::run_with ( std::initializer_list< std::function< void(::mir::Server &)>>  options) -> int

Apply the supplied initialization options and run the Mir server.

Returns
EXIT_SUCCESS or EXIT_FAILURE according to whether the server ran successfully
Note
blocks until the Mir server exits

◆ set_exception_handler()

void miral::MirRunner::set_exception_handler ( std::function< void()> const &  handler)

Set a handler for exceptions caught in run_with(). run_with() invokes handler() in catch (...) blocks before returning EXIT_FAILURE. Hence the exception can be re-thrown to retrieve type information. The default action is to call mir::report_exception(std::cerr)

◆ stop()

void miral::MirRunner::stop ( )

Tell the Mir server to exit.


The documentation for this class was generated from the following file:

Copyright © 2012-2018 Canonical Ltd.
Generated on Thu 12 Jul 10:49:10 UTC 2018