PIP 5.5.3
Platform-Independent Primitives
Public Member Functions | List of all members
PISingleApplication Class Reference

Single-instance application control. More...

#include <pisingleapplication.h>

Inheritance diagram for PISingleApplication:
Inheritance graph
[legend]

Public Member Functions

 PISingleApplication (const PIString &app_name=PIString())
 Construct PISingleApplication with name "app_name".
 
bool isFirst () const
 Returns if this application instance is launched first.
 
- Public Member Functions inherited from PIThread
 PIThread (void *data, ThreadFunc func, bool startNow=false, PISystemTime loop_delay={})
 Contructs thread with custom data "data", external function "func" and main loop delay "loop_delay".
 
 PIThread (std::function< void()> func, bool startNow=false, PISystemTime loop_delay={})
 Contructs thread with external function "func" and main loop delay "loop_delay".
 
 PIThread (bool startNow=false, PISystemTime loop_delay={})
 Contructs thread with main loop delay "loop_delay".
 
bool start ()
 Start thread.
 
bool start (PISystemTime loop_delay)
 Start thread.
 
bool start (ThreadFunc func)
 Start thread.
 
bool start (ThreadFunc func, PISystemTime loop_delay)
 Start thread.
 
bool start (std::function< void()> func)
 Start thread.
 
bool start (std::function< void()> func, PISystemTime loop_delay)
 Start thread.
 
bool startOnce ()
 Start thread without internal loop. More...
 
bool startOnce (ThreadFunc func)
 Start thread without internal loop. More...
 
bool startOnce (std::function< void()> func)
 Start thread without internal loop.
 
bool stopAndWait (PISystemTime timeout={})
 Stop thread and wait for finish. Returns false if timeout expired.
 
void setData (void *d)
 Set common data passed to external function.
 
void setSlot (ThreadFunc func)
 Set external function that will be executed after every run()
 
void setSlot (std::function< void()> func)
 Set external function that will be executed after every run()
 
void setPriority (PIThread::Priority prior)
 Set thread priority.
 
void * data () const
 Returns common data passed to external function.
 
PIThread::Priority priority () const
 Return thread priority.
 
bool isRunning () const
 Return if thread is running.
 
bool isStopping () const
 Return if thread is stopping.
 
bool waitForStart (PISystemTime timeout={})
 Wait for thread start.
 
bool waitForStart (int timeout_msecs) DEPRECATEDM("use waitForStart(PISystemTime)")
 
bool waitForFinish (PISystemTime timeout={})
 Wait for thread finish. Returns false if timeout expired.
 
bool waitForFinish (int timeout_msecs) DEPRECATEDM("use waitForFinish(PISystemTime)")
 
void needLockRun (bool need)
 Set necessity of lock every run() with internal mutex.
 
PIMutexmutex () const
 Returns internal mutex.
 
llong tid () const
 Returns thread ID.
 
void stop ()
 Stop thread. More...
 
void terminate ()
 Strongly stop thread. More...
 
void lock () const
 Lock internal mutex.
 
void unlock () const
 Unlock internal mutex.
 
void started ()
 Raise on thread start.
 
void stopped ()
 Raise on thread stop.
 
- Public Member Functions inherited from PIObject
 PIObject (const PIString &name=PIString())
 Contructs PIObject with name "name".
 
PIString name () const
 Returns object name.
 
virtual const char * className () const
 Returns object class name.
 
virtual const char * parentClassName () const
 Returns parent class name.
 
bool debug () const
 Return if piCoutObj of this object is active.
 
void setName (const PIString &name)
 Set object name.
 
void setDebug (bool debug)
 Set object piCoutObj active.
 
PIVariant property (const char *name) const
 Returns property with name "name".
 
void setProperty (const char *name, const PIVariant &value)
 Set property with name "name" to "value". If there is no such property in object it will be added.
 
bool isPropertyExists (const char *name) const
 Returns if property with name "name" exists.
 
PIStringList scopeList () const
 Returns subclass scope of this object (including this class name)
 
void piDisconnect (const PIString &sig, PIObject *dest, void *ev_h)
 Disconnect object from all connections with event name "sig", connected to destination object "dest" and handler "ev_h".
 
void piDisconnect (const PIString &sig, PIObject *dest)
 Disconnect object from all connections with event name "sig", connected to destination object "dest".
 
void piDisconnect (const PIString &sig)
 Disconnect object from all connections with event name "sig".
 
bool isPIObject () const
 Returns if this is valid PIObject (check signature)
 
template<typename T >
bool isTypeOf () const
 Returns if this is valid PIObject subclass "T" (check signature and classname)
 
template<typename T >
T * cast () const
 Returns cast to T if this is valid subclass "T" (check by isTypeOf()) or "nullptr".
 
void callQueuedEvents ()
 Execute all posted events from CONNECTU_QUEUED connections.
 
bool maybeCallQueuedEvents ()
 Check if any CONNECTU_QUEUED connections to this object and execute them. More...
 
void deleteLater ()
 Mark object to delete. More...
 
void deleted (PIObject *o)
 Raise before object delete. More...
 

Handlers

void sendMessage (const PIByteArray &m)
 Send message "m" to first launched application.
 

Events

void messageReceived (PIByteArray m)
 Raise on first launched application receive message from another.
 

Additional Inherited Members

- Public Types inherited from PIThread
enum  Priority {
  piLowerst , piLow , piNormal , piHigh ,
  piHighest
}
 Priority of thread. More...
 
- Static Public Member Functions inherited from PIThread
static void runOnce (PIObject *object, const char *handler, const PIString &name=PIString())
 Call event handler "handler" of object "object" in separate thread. More...
 
static void runOnce (std::function< void()> func, const PIString &name=PIString())
 Call lambda expression "func" in separate thread. More...
 
- Static Public Member Functions inherited from PIObject
static void piDisconnect (PIObject *src, const PIString &sig, PIObject *dest, void *ev_h)
 Disconnect object "src" from all connections with event name "sig", connected to destination object "dest" and handler "ev_h".
 
static void piDisconnect (PIObject *src, const PIString &sig, PIObject *dest)
 Disconnect object "src" from all connections with event name "sig", connected to destination object "dest".
 
static void piDisconnect (PIObject *src, const PIString &sig)
 Disconnect object "src" from all connections with event name "sig".
 
static PIObjectfindByName (const PIString &name)
 Returns PIObject* with name "name" or 0, if there is no object found.
 
static bool isPIObject (const PIObject *o)
 Returns if "o" is valid PIObject (check signature)
 
template<typename T >
static bool isTypeOf (const PIObject *o)
 Returns if "o" is valid PIObject subclass "T" (check signature and classname)
 
- Protected Member Functions inherited from PIThread
virtual void begin ()
 Function executed once at the start of thread.
 
virtual void run ()
 Function executed at every "loop_delay" msecs until thread was stopped.
 
virtual void end ()
 Function executed once at the end of thread.
 
- Protected Member Functions inherited from PIObject
PIObjectemitter () const
 Returns PIObject* which has raised an event. This value is correct only in definition of some event handler.
 
virtual void propertyChanged (const char *name)
 Virtual function executes after property with name "name" has been changed.
 

Detailed Description

Single-instance application control.

int main(int argc, char * argv[]) {
PISingleApplication sapp("myapp");
if (sapp.isFirst()) {
piCout << "I`m first, wait for another";
piCout << "Msg from another:" << PIString(msg);
});
} else {
piCout << "I`m not first, send and exit";
sapp.sendMessage(PIString("Hello!").toByteArray());
return 0;
}
return 0;
}
The PIByteArray class provides an array of bytes.
Definition: pibytearray.h:42
#define CONNECTL(src, event, functor)
Connect event "event" from object "src" to lambda-expression "functor".
Definition: piobject_macros.h:218
Single-instance application control.
Definition: pisingleapplication.h:37
void messageReceived(PIByteArray m)
Raise on first launched application receive message from another.
String class.
Definition: pistring.h:42
PIByteArray toByteArray() const
Same as toUTF8().
Definition: pistring.h:1109
#define WAIT_FOREVER
Macro used for infinite wait.
Definition: pibase_macros.h:415
#define piCout
Macro used for conditional (piDebug) output to PICout(StdOut)
Definition: picout.h:35