main doc
This commit is contained in:
@@ -30,11 +30,43 @@
|
||||
|
||||
# include "pithread.h"
|
||||
|
||||
|
||||
//! \class PIProcess
|
||||
//! \ingroup System
|
||||
//! \~\brief
|
||||
//! \~english External process.
|
||||
//! \~russian Внешний процесс.
|
||||
//! \~english
|
||||
//! \brief Class for managing external processes
|
||||
//! \details
|
||||
//! The PIProcess class provides functionality to create, control and interact with external processes.
|
||||
//! It allows both attached execution (with full control over input/output streams) and detached execution.
|
||||
//!
|
||||
//! Key features:
|
||||
//! - Start processes with arguments and environment variables
|
||||
//! - Monitor process state (running/finished)
|
||||
//! - Read from stdout/stderr streams
|
||||
//! - Write to stdin stream
|
||||
//! - Set custom working directory
|
||||
//! - Modify environment variables
|
||||
//! - Wait for process completion
|
||||
//! - Terminate processes
|
||||
//! - Retrieve exit codes and process IDs
|
||||
//!
|
||||
//! This class inherits from PIThread and provides event-based notifications for process lifecycle events.
|
||||
//! \~russian
|
||||
//! \brief Класс для управления внешними процессами
|
||||
//! \details
|
||||
//! Класс PIProcess предоставляет функциональность для создания, управления и взаимодействия с внешними процессами.
|
||||
//! Поддерживает как присоединенное выполнение (с полным контролем потоков ввода/вывода), так и независимое выполнение.
|
||||
//!
|
||||
//! Основные возможности:
|
||||
//! - Запуск процессов с аргументами и переменными окружения
|
||||
//! - Мониторинг состояния процесса (запущен/завершен)
|
||||
//! - Чтение из потоков stdout/stderr
|
||||
//! - Запись в поток stdin
|
||||
//! - Установка рабочей директории
|
||||
//! - Изменение переменных окружения
|
||||
//! - Ожидание завершения процесса
|
||||
//! - Завершение процессов
|
||||
//! - Получение кодов завершения и идентификаторов процессов
|
||||
//!
|
||||
class PIP_EXPORT PIProcess: public PIThread {
|
||||
PIOBJECT_SUBCLASS(PIProcess, PIThread);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user