(C) Zeriph Enterprises
omni::application::run
NAME

omni::application::run

A function of omni::application

#include <omni/application.hpp>
int omni::application::run(const omni::sync::thread_start& start_func)

SYNOPSIS

Starts the main application thread loop.

top

DESCRIPTION

This function is part of the application framework that allows you to hook in to certain system level functionality, as well as have access to other long running application contexts. This function will pause the main application until one of either omni::application::exit or omni::application::stop are called, or an exception is thrown and not caught. Along with the other variants of the run function, you can simplify argument and main program loop handling for global and multi-threaded environments in a more simplified way.

top

RETURN VALUES

The exit code set by omni::application::set_return_code, or 0 if none is set.

top


PARAMETERS

start_func - An omni::sync::thread_start function object that will be called after the application context has been successfully created and started.

top


ERRORS

Since run need only be called once, if it is called again after being called at program start, it will throw an omni::exceptions::invalid_application_state as calling run more than once will cause the system to get into an undefined state.

top


CONSIDERATIONS

You cannot utilize the signal or application handlers unless this or one of its variants are called in the main function of your code or library initialization routine.

top


NOTES

If OMNI_NO_BASE_SETLOCALE is not defined, then the setlocale function is called with a category LC_ALL and an empty locale. If you wish to specify which category and locale to utilize, you can define OMNI_BASE_LOCALE_CATEGORY and OMNI_BASE_LOCALE

top


EXAMPLE

#include <omnilib>

void app_exit()
{
    std::cout << "app_exit!" << std::endl;
}

void app_run()
{
    std::cout << "In non-member function app_run" << std::endl;
    std::cout << "Leaving app_run and waiting for CTRL+C" << std::endl;
}

class app {
    public:
        app() : m_val(42) { std::cout << "app constructing value = " << this->m_val << std::endl; }
        ~app() { std::cout << "app deconstructing value = " << this->m_val << std::endl; }

        void run()
        {
            std::cout << "In member function app::run value = " << this->m_val << std::endl;
            ++this->m_val;
            std::cout << "Increased value by 1, leaving app::run and waiting for CTRL+C" << std::endl;
        }

        static void exit()
        {
            std::cout << "app::exit!" << std::endl;
        }

    private:
        int32_t m_val;
};

int main(int argc, const char* argv[])
{
    omni::application::exit_handler::attach(&app_exit);
    omni::application::exit_handler::attach(&app::exit);
    if (argc > 1) {
        app mainapp;
        // DEV_NOTE: you cant bind member functions to the exit handler in this way
        // you have to create a reference type that will be deconstructed in a static
        // handler, otherwise, the object can be deconstructed before the exit handler
        // is called, causing undefined behavior because of the reference after free.
        return omni::application::run(omni::sync::thread_start::bind<app, &app::run>(mainapp));
    }
    return omni::application::run(&app_run);
}
Visit the examples page for more.

top