merged AI doc, some new pages
This commit is contained in:
@@ -1,9 +1,8 @@
|
||||
/*! \file pisingleapplication.h
|
||||
* \ingroup Application
|
||||
* \~\brief
|
||||
* \~english Single-instance application control
|
||||
* \~russian Контроль одного экземпляра приложения
|
||||
*/
|
||||
//! \~\file pisingleapplication.h
|
||||
//! \~\ingroup Application
|
||||
//! \~\brief
|
||||
//! \~english Single-instance application control
|
||||
//! \~russian Контроль одного экземпляра приложения
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
Single application
|
||||
@@ -30,35 +29,44 @@
|
||||
|
||||
class PISharedMemory;
|
||||
|
||||
//! \ingroup Application
|
||||
//! \~\ingroup Application
|
||||
//! \~\brief
|
||||
//! \~english Single-instance application control.
|
||||
//! \~russian Контроль одного экземпляра приложения.
|
||||
//! \~\details
|
||||
//! \~english The PISingleApplication class provides single-instance application control. It allows detecting if the current application
|
||||
//! instance is the first one launched and enables inter-process communication between multiple instances. Multiple instances with the same
|
||||
//! "app_name" can detect each other and communicate. The first instance becomes the server, receiving messages from subsequent instances.
|
||||
//! \~russian Класс PISingleApplication предоставляет контроль одного экземпляра приложения. Он позволяет определить, является ли текущий
|
||||
//! экземпляр первым запущенным, и обеспечивает межпроцессное взаимодействие между несколькими экземплярами. Несколько экземпляров с
|
||||
//! одинаковым "app_name" могут обнаруживать друг друга и обмениваться сообщениями. Первый экземпляр становится сервером, принимающим
|
||||
//! сообщения от последующих экземпляров.
|
||||
|
||||
class PIP_EXPORT PISingleApplication: public PIThread {
|
||||
PIOBJECT_SUBCLASS(PISingleApplication, PIThread);
|
||||
|
||||
public:
|
||||
//! \~english Construct %PISingleApplication with name "app_name"
|
||||
//! \~russian Создает %PISingleApplication с именем "app_name"
|
||||
//! \~english Constructs %PISingleApplication for application name "app_name".
|
||||
//! \~russian Создает %PISingleApplication для имени приложения "app_name".
|
||||
PISingleApplication(const PIString & app_name = PIString());
|
||||
|
||||
//! \~english Stops instance monitoring and releases shared resources.
|
||||
//! \~russian Останавливает мониторинг экземпляра и освобождает общие ресурсы.
|
||||
~PISingleApplication();
|
||||
|
||||
|
||||
//! \~english Returns if this application instance is launched first
|
||||
//! \~russian Возвращает первым ли был запущен этот экземпляр приложения
|
||||
//! \~english Returns whether this process is the first launched instance.
|
||||
//! \~russian Возвращает, является ли этот процесс первым запущенным экземпляром.
|
||||
bool isFirst() const;
|
||||
|
||||
EVENT_HANDLER1(void, sendMessage, const PIByteArray &, m);
|
||||
EVENT1(messageReceived, PIByteArray, m);
|
||||
|
||||
//! \handlers
|
||||
//! \{
|
||||
|
||||
//! \fn void sendMessage(const PIByteArray & m)
|
||||
//! \brief
|
||||
//! \~english Send message "m" to first launched application
|
||||
//! \~russian Посылает сообщение "m" первому запущеному приложению
|
||||
//! \~english Sends message "m" to the first launched application instance
|
||||
//! \~russian Посылает сообщение "m" первому запущенному экземпляру приложения
|
||||
EVENT_HANDLER1(void, sendMessage, const PIByteArray &, m);
|
||||
|
||||
//! \}
|
||||
//! \events
|
||||
@@ -66,8 +74,9 @@ public:
|
||||
|
||||
//! \fn void messageReceived(PIByteArray m)
|
||||
//! \brief
|
||||
//! \~english Raise on first launched application receive message from another
|
||||
//! \~russian Вызывается первым запущеным приложением по приему сообщения от других
|
||||
//! \~english Emitted by the first launched application when receiving a message from another instance
|
||||
//! \~russian Вызывается первым запущенным приложением при получении сообщения от другого экземпляра
|
||||
EVENT1(messageReceived, PIByteArray, m);
|
||||
|
||||
//! \}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user