Page MenuHomePhabricator (Chris)

No OneTemporary

Authored By
Unknown
Size
2 KB
Referenced Files
None
Subscribers
None
diff --git a/README.md b/README.md
index 5f80878..392813f 100644
--- a/README.md
+++ b/README.md
@@ -1,37 +1,44 @@
SingleApplication
=================
This is a replacement of the QSingleApplication for ```Qt5```.
Keeps the Primary Instance of your Application and kills each subsequent instance.
Usage
-----
The ```SingleApplication``` class inherits from ```QApplication```. Use it as if you are using the ```QApplication``` class.
The library uses your ```Organization Name``` and ```Application Name``` to set up a Local Socket. The first instance of your Application would start a ```QLocalServer``` and then listen for connections on the socket. Every subsequent instance of your application would attempt to connect to that socket. If successful it will be terminated, while in the Primary Instance, ```SingleApplication``` would emmit the ```showUp()``` signal.
The library uses ```stdlib``` to terminate the program with the ```exit()``` function.
Here is an example usage of the library:
```cpp
#include "singleapplication.h"
int main(int argc, char *argv[])
{
QApplication::setApplicationName("{Your App Name}");
QApplication::setOrganizationName("{Your Organization Name}");
SingleApplication app(argc, argv);
return app.exec();
}
```
The ```Show Up``` signal
------------------------
The SingleApplication class implements a ```showUp()``` signal. You can bind to that signal to raise your application's window when a new instance had been started.
+Known bugs
+----------
+The ```SingleApplication``` class works really well for the scenario
+when a
+user starts your application twice, but the implementation it uses does not garantee it will work if two processes are started simultaniously (with a millisecond delay, which is only done programatically), in which case two instances might coexist on some platforms.
+_The issue is a work in proggress and should be fixed soon._
+
License
-------
This library and it's supporting documentation are released under ```The MIT License (MIT)```.

File Metadata

Mime Type
text/x-diff
Expires
Tue, Jun 16, 1:00 AM (2 w, 1 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
72620
Default Alt Text
(2 KB)

Event Timeline