SingleApplication/CHANGELOG.md

Changelog

3.5.1

• Bug Fix: Maximum QNativeIpcKey key size on macOS. - Jonas Kvinge

3.5.0

• Switch to the new QNativeIpcKey based QSharedMemory constructor with Qt 6.6 and higher. - Jonas Kvinge

3.4.1

• Improved Windows advapi32 link library dependency. - Frederik Seiffert

3.4.0

• Provide API for blocking sendMessage. - Christoph Cullmann
• New documentation generation using Doxygen
• Improved Windows basic widget example
• Updated Project License

3.3.4

• Fix compilation under Qt 6.2+ and stricter Qt compile settings. - Christoph Cullmann

3.3.3

• Support for Qt 6.3+ - Fixed deprecated QCryptographicHash::addData() that will only support QByteArrayView going further. - Moody Liu

3.3.2

• Fixed crash caused by sending a writeAck on a removed connection. - Nicolas Werner

3.3.1

• Added support for AppImage dynamic executable paths. - Michael Klein

3.3.0

• Fixed message fragmentation issue causing crashes and incorrectly / inconsistently received messages. - Nils Jeisecke

3.2.0

• Added support for Qt 6 - Jonas Kvinge
• Fixed warning in Qt 5.9 with min/max functions on Windows - Nick Korotysh
• Fix return value of connectToPrimary() when connect is successful - Jonas Kvinge
• Fix build issue with MinGW GCC pedantic mode - Iakov Kirilenko
• Fixed conversion from int to quint32 and Clang Tidy warnings - Hennadii Chernyshchyk

3.1.5

• Improved library stability in edge cases and very rapid process initialisation
• Fixed Bug where the shared memory block may have been modified without a lock
• Fixed Bug causing instanceStarted() to not get emitted when a second instance has been started before the primary has initiated it's QLocalServer.

3.1.4

• Officially supporting and build-testing against Qt 5.15

• Fixed an MSVC C4996 warning that suggests using strncpy_s.

  Hennadii Chernyshchyk

3.1.3.1

• CMake build system improvements

• Fixed Clang Tidy warnings

  Hennadii Chernyshchyk

3.1.3

• Improved CMakeLists.txt

  Hennadii Chernyshchyk

3.1.2

• Fix a crash when exiting an application on Android and iOS

  Emeric Grange

3.1.1a

• Added currentUser() method that returns the user the current instance is running as.

  Leander Schulten

3.1.0a

• Added primaryUser() method that returns the user the primary instance is running as.

3.0.19

• Fixed code warning for depricated functions in Qt 5.10 related to QTime and qrand().

  Hennadii Chernyshchyk
  Anton Filimonov
  Jonas Kvinge

3.0.18

• Fallback to standard QApplication class on iOS and Android systems where the library is not supported.

• Added Build CI tests to verify the library builds successfully on Linux, Windows and MacOS across multiple Qt versions.

  Anton Filimonov

3.0.17

• Fixed compilation warning/error caused by geteuid() on unix based systems.

  Iakov Kirilenko

• Added CMake support

  Hennadii Chernyshchyk

3.0.16

• Use geteuid and getpwuid to get username on Unix, fallback to environment variable.

  Jonas Kvinge

3.0.15

• Bug Fix: sendMessage() might return false even though data was actually written.

  Jonas Kvinge

3.0.14

• Fixed uninitialised variables in the SingleApplicationPrivate constructor.

3.0.13a

• Process socket events asynchronously

• Fix undefined variable error on Windows

  Francis Giraldeau

3.0.12a

• Removed signal handling.

3.0.11a

• Fixed bug where the message sent by the second process was not received correctly when the message is sent immediately following a connection.

  Francis Giraldeau

• Refactored code and implemented shared memory block consistency checks via qChecksum() (CRC-16).

• Explicit qWarning and qCritical when the library is unable to initialise correctly.

3.0.10

• Removed C style casts and eliminated all clang warnings. Fixed instanceId reading from only one byte in the message deserialization. Cleaned up serialization code using QDataStream. Changed connection type to use quint8 enum rather than char.

• Renamed SingleAppConnectionType to ConnectionType. Added initialization values to all ConnectionType enum cases.

  Jedidiah Buck McCready

3.0.9

• Added SingleApplicationPrivate::primaryPid() as a solution to allow bringing the primary window of an application to the foreground on Windows.

  Eelco van Dam from Peacs BV

3.0.8

• Bug fix - changed QApplication::instance() to QCoreApplication::instance()

  Evgeniy Bazhenov

3.0.7a

• Fixed compilation error with Mingw32 in MXE thanks to Vitaly Tonkacheyev.
• Removed QMutex used for thread safe behaviour. The implementation now uses QCoreApplication::instance() to get an instance to SingleApplication for memory deallocation.

3.0.6a

• Reverted GetUserName API usage on Windows. Fixed bug with missing library.

• Fixed bug in the Calculator example, preventing it's window to be raised on Windows.

  Special thanks to Charles Gunawan.

3.0.5a

• Fixed a memory leak in the SingleApplicationPrivate destructor.

  Sergei Moiseev

3.0.4a

• Fixed shadow and uninitialised variable warnings.

  Paul Walmsley

3.0.3a

• Removed Microsoft Windows specific code for getting username due to multiple problems and compiler differences on Windows platforms. On Windows the shared memory block in User mode now includes the user's home path (which contains the user's username).

• Explicitly getting absolute path of the user's home directory as on Unix a relative path (~) may be returned.

3.0.2a

• Fixed bug on Windows when username containing wide characters causes the library to crash.

  Le Liu

3.0.1a

• Allows the application path and version to be excluded from the server name hash. The following flags were added for this purpose:

  • SingleApplication::Mode::ExcludeAppVersion
  • SingleApplication::Mode::ExcludeAppPath

• Allow a non elevated process to connect to a local server created by an elevated process run by the same user on Windows

• Fixes a problem with upper case letters in paths on Windows

  Le Liu

v3.0a

• Deprecated secondary instances count.
• Added a sendMessage() method to send a message to the primary instance.
• Added a receivedMessage() signal, emitted when a message is received from a secondary instance.
• The SingleApplication constructor's third parameter is now a bool specifying if the current instance should be allowed to run as a secondary instance if there is already a primary instance.
• The SingleApplication constructor accept a fourth parameter specifying if the SingleApplication block should be User-wide or System-wide.
• SingleApplication no longer relies on applicationName and organizationName to be set. It instead concatenates all of the following data and computes a SHA256 hash which is used as the key of the QSharedMemory block and the QLocalServer. Since at least applicationFilePath is always present there is no need to explicitly set any of the following prior to initialising SingleApplication.
  • QCoreApplication::applicationName
  • QCoreApplication::applicationVersion
  • QCoreApplication::applicationFilePath
  • QCoreApplication::organizationName
  • QCoreApplication::organizationDomain
  • User name or home directory path if in User mode
• The primary instance is no longer notified when a secondary instance had been started by default. A Mode flag for this feature exists.
• Added instanceNumber() which represents a unique identifier for each secondary instance started. When called from the primary instance will return 0.

v2.4

• Stability improvements
• Support for secondary instances.
• The library now recovers safely after the primary process has crashed and the shared memory had not been deleted.

v2.3

• Improved pimpl design and inheritance safety.

  Vladislav Pyatnichenko

v2.2

• The QAPPLICATION_CLASS macro can now be defined in the file including the Single Application header or with a DEFINES+= statement in the project file.

v2.1

• A race condition can no longer occur when starting two processes nearly simultaneously.

  Fix issue #3

v2.0

• SingleApplication is now being passed a reference to argc instead of a copy.

  Fix issue #1

• Improved documentation.