omni::application
NAME

omni::application

A namespace of omni

SYNOPSIS

The application namespace contains functionality that can be used application wide, to include signal handling or application run contexts.

omni::application::exit_handler
omni::application::shutdown_handler
omni::application::signal_handler
omni::application::startup_handler
omni::application::terminate_handler
omni::application::argparser& omni::application::args()
inline unsigned int omni::application::bit_width()
void omni::application::exit(int exit_status)
int omni::application::last_signal()
int omni::application::run()
void omni::application::set_args(const int& argc, const char** argv)
void omni::application::set_return_code(int return_code)
void omni::application::stop()


top

DESCRIPTION

The application namespace can be utilized to block the main thread to avoid early program termination, attach and detach signal handlers as well as startup and shutdown handlers. The namespace contains functionality that applies to an application wide context, such as the bit size (32/64 bit), arguments passed in or the last signal received on the application.

top

RETURN VALUES

No return value.

top

ERRORS

No errors specific to this context.

top

CONSIDERATIONS

Some functions within the namespace will only work if you have explicitly called one of the omni::application::run functions to block the main thread until program completion.

top

PLATFORM SPECIFIC

Certain functions within the application namespace make use of different platform specific API's; make sure to take note of any details in this section when targeting specific platforms if things are not as expected.

top

NOTES

No additional notes.

top

EXAMPLE
Currently no examples.
Visit the examples page for more.

top