Updated copyright year.
[MUtilities.git] / include / MUtils / IPCChannel.h
blobb3b12fbc7a4667475ac175825f827834e96625b7
1 ///////////////////////////////////////////////////////////////////////////////
2 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2019 LoRd_MuldeR <MuldeR2@GMX.de>
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 // http://www.gnu.org/licenses/lgpl-2.1.txt
20 //////////////////////////////////////////////////////////////////////////////////
22 #pragma once
24 //MUtils
25 #include <MUtils/Global.h>
27 //Qt
28 #include <QtGlobal>
29 #include <QStringList>
31 namespace MUtils
33 class MUTILS_API IPCChannel_Private;
35 class MUTILS_API IPCChannel
37 public:
38 static const quint32 MAX_PARAM_LEN = 4096;
39 static const quint32 MAX_PARAM_CNT = 4;
41 typedef enum
43 RET_SUCCESS_MASTER = 0,
44 RET_SUCCESS_SLAVE = 1,
45 RET_ALREADY_INITIALIZED = 2,
46 RET_FAILURE = 3
48 ipc_result_t;
50 IPCChannel(const QString &applicationId, const quint32 &versionNo, const QString &channelId);
51 ~IPCChannel(void);
53 int initialize(void);
55 bool send(const quint32 &command, const quint32 &flags, const QStringList &params = QStringList());
56 bool read(quint32 &command, quint32 &flags, QStringList &params);
58 private:
59 IPCChannel(const IPCChannel&) : p(NULL), m_appVersionNo(-1) { throw "Constructor is disabled!"; }
60 IPCChannel &operator=(const IPCChannel&) { throw "Assignment operator is disabled!"; return *this; }
62 const QString m_applicationId;
63 const QString m_channelId;
64 const unsigned int m_appVersionNo;
65 const QByteArray m_headerStr;
67 IPCChannel_Private *const p;