Application

#include <icy/application.h>

class Application

Defined in src/base/include/icy/application.h:39

Main icey application class.

This class exposes basic features required by most applications:

Running the event loop
Command line option parsing See also: OptionParser
Shutdown signal (Ctrl-C) handling
Garbage collection

Example

#include <icy/application.h>

int main()
{
    icy::Application app;
    app.waitForShutdown();
    return 0;
}

List of all members

Name	Kind	Owner
`loop`	`variable`	Declared here
`Application`	`function`	Declared here
`~Application`	`function`	Declared here
`run`	`function`	Declared here
`stop`	`function`	Declared here
`finalize`	`function`	Declared here
`waitForShutdown`	`function`	Declared here
`bindShutdownSignal`	`function`	Declared here
`getDefault`	`function`	Declared here
`Application`	`function`	Declared here
`operator=`	`function`	Declared here
`Application`	`function`	Declared here
`operator=`	`function`	Declared here

Public Attributes

Return	Name	Description
`uv::Loop *`	`loop`	Active event loop.

loop

uv::Loop * loop

Defined in src/base/include/icy/application.h:56

Active event loop.

The event loop may be assigned on construction, otherwise the default event loop will be used.

Public Methods

Return	Name	Description
	`Application`	Constructor.
	`~Application`	Destructor.
`void`	`run`	Run the application event loop.
`void`	`stop`	Stop the application event loop.
`void`	`finalize`	Finalize and free any remaining pointers still held by the application event loop.
`void`	`waitForShutdown`	Bind the shutdown signal and run the main event loop.
`void`	`bindShutdownSignal`	Bind the shutdown signal.

Application

Application(uv::Loop * loop = uv::defaultLoop())

Defined in src/base/include/icy/application.h:43

Constructor.

~Application

~Application()

Defined in src/base/include/icy/application.h:46

Destructor.

run

void run()

Defined in src/base/include/icy/application.h:63

Run the application event loop.

stop

void stop()

Defined in src/base/include/icy/application.h:66

Stop the application event loop.

finalize

void finalize()

Defined in src/base/include/icy/application.h:70

Finalize and free any remaining pointers still held by the application event loop.

waitForShutdown

void waitForShutdown(std::function< void(void *)> callback = nullptr, void * opaque = nullptr)

Defined in src/base/include/icy/application.h:77

Bind the shutdown signal and run the main event loop.

bindShutdownSignal

void bindShutdownSignal(std::function< void(void *)> callback = nullptr, void * opaque = nullptr)

Defined in src/base/include/icy/application.h:81

Bind the shutdown signal.

Public Static Methods

Return	Name	Description
`Application &`	`getDefault` `static`	Returns the default Application singleton, although Application instances may be initialized individually.

getDefault

static

static Application & getDefault()

Defined in src/base/include/icy/application.h:50

Returns the default Application singleton, although Application instances may be initialized individually.

Protected Methods

Return	Name	Description
	`Application`	Deleted constructor.
	`Application`	Deleted constructor.

Application

Application(const Application &) = delete

Defined in src/base/include/icy/application.h:85

Deleted constructor.

Application

Application(Application &&) = delete

Defined in src/base/include/icy/application.h:87

Deleted constructor.