SingleInstance.h

Go to the documentation of this file.

// The MIT License (MIT)
//
// Copyright (c) Itay Grudev 2015 - 2018
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
 
#pragma once
 
#include <QCoreApplication>
#include <QtCore/QtGlobal>
#include <QtNetwork/QLocalSocket>
 
class SingleInstancePrivate;
 
class SingleInstance : public QObject
{
    Q_OBJECT
 
  public:
    enum Mode
    {
      User = 1 << 0,
      System = 1 << 1,
      SecondaryNotification = 1 << 2,
      ExcludeAppVersion = 1 << 3,
      ExcludeAppPath = 1 << 4
    };
    Q_DECLARE_FLAGS(Options, Mode)
 
    
    explicit SingleInstance(QObject* parent = nullptr);
    explicit SingleInstance(bool allowSecondary, Options options = Mode::User, int timeout = 1000, const QString& userData = {}, QObject* parent = nullptr);
 
    ~SingleInstance() override;
 
    void initialize(bool allowSecondary = false, Options options = Mode::User, int timeout = 1000, const QString& userData = {});
 
    [[nodiscard]] bool isPrimary() const;
 
    [[nodiscard]] bool isSecondary() const;
 
    [[nodiscard]] quint32 instanceId() const;
 
    [[nodiscard]] qint64 primaryPid() const;
 
    [[nodiscard]] QString primaryUser() const;
 
    [[nodiscard]] QString currentUser() const;
 
    bool sendMessage(const QByteArray& message, int timeout = 100);
 
    [[nodiscard]] QStringList userData() const;
 
  Q_SIGNALS:
 
    void instanceStarted();
 
    void receivedMessage(quint32 instanceId, QByteArray message);
 
  private:
    SingleInstancePrivate* d_ptr;
 
    Q_DECLARE_PRIVATE(SingleInstance)
 
    void abortSafely();
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS(SingleInstance::Options)