fpsdk::common::app::SigIntHelper Class Reference

Helper to catch SIGINT (CTRL-c) More...

#include <app.hpp>

Public Member Functions
bool	ShouldAbort ()
	Check if signal was raised and we should abort.
bool	WaitAbort (const uint32_t millis=0)
	Wait (block) until signal is raised and we should abort.

Detailed Description

Helper to catch SIGINT (CTRL-c)

On construction this installs a handler for SIGINT. On destruction it sets the handler back to its previous state. Note that signal handlers are global and therefore you can only use one SigIntHelper in a app.

Example:

SigIntHelper sigint;
while (!sigint.ShouldAbort()) {
   // do stuff..
}
 
if (sigint.ShouldAbort()) {
   INFO("We've been asked to stop");
}

Definition at line 56 of file app.hpp.

Member Function Documentation

ShouldAbort()

bool fpsdk::common::app::SigIntHelper::ShouldAbort

(

)

Check if signal was raised and we should abort.

Returns

true if signal was raised and we should abort, false otherwise

WaitAbort()

bool fpsdk::common::app::SigIntHelper::WaitAbort

(

const uint32_t

millis = 0

)

Wait (block) until signal is raised and we should abort.

Parameters

[in]

millis

Wait at most this long [ms], 0 = forever

Returns

true if the signal was raised, fals if timeout expired

---

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

• fpsdk_common/include/fpsdk_common/app.hpp