mirror of
https://github.com/Vateron-Media/XC_VM.git
synced 2026-10-26 19:03:17 +01:00
Structure:
- Split development/ (20 files) into development/ (framework reference) and guides/ (how-to)
- Moved 13 how-to files into new guides/ category (auth, cli, error-handling, etc.)
- Moved navbar-rendering.md from system/ into development/
- Deleted empty system/README.md files
- Deleted documentation_gaps.md (all gaps resolved) and redundant info/update.md
Sidebar / navbar:
- Removed all emojis from _sidebar.md (EN + RU) — fixes tree hierarchy rendering
- Removed flag emojis from _navbar.md language switcher
- Removed duplicate entries from the old "System Documentation" section
- Renamed section headers: "Development" -> "Framework Reference" + "Developer Guides"
Content fixes (modules.md EN + RU):
- Updated "Class naming" section: now documents XcVm\Module\{Pascal} namespaces
(was "global PHP namespace — Until PHP namespaces are introduced")
- Updated main module class example to use namespace declaration + use statements
- Updated class naming in ModuleLoader description to FQN
- Replaced installCrontab() manual crontab instruction with getCronEntries() API
- Updated enable/disable section: added ModuleState enum table, updated config examples
- Fixed FAQ answer for disabling a module
Content fixes (bootstrap-contexts.md EN + RU):
- Replaced CONTEXT_* string constants with BootContext enum cases throughout
- Updated boot() signature: string $context -> BootContext $context
- Updated getContext() return type: ?string -> ?BootContext
New framework reference docs (EN + RU):
- docs/{en,ru}/development/event-system.md: EventDispatcher singleton bridge,
#[ListensTo] attribute, getEventSubscribers() array API, stoppable events,
built-in event catalog, custom event authoring, ListensTo attribute reference
- docs/{en,ru}/development/exception-hierarchy.md: full XcVmException tree,
container vs module subtrees, PSR-11 compliance notes, catch-by-subsystem examples
2.0 KiB
2.0 KiB
Process Management Patterns
ProcessManager centralizes Linux process checks, termination, PID-file checks, and cron locking.
It replaces scattered ad-hoc posix_kill, ps, and /proc checks.
Core Operations
Check if process is running
ProcessManager::isRunning(int $pid, ?string $exe = null): bool
- without
$exe: checks/proc/{pid}existence - with
$exe: validates executable name via/proc/{pid}/exe
Check named process
ProcessManager::isNamedProcessRunning(
int $pid,
string $processName,
int|string $identifier,
?string $exe = null
): bool
Matches cmdline pattern NAME[ID] (for process-title-based workers).
Check stream process
ProcessManager::isStreamRunning(int $pid, int $streamId): bool
ffmpeg: validates stream-specific output pattern in cmdlinephp: considered alive for stream worker context
PID File Utilities
ProcessManager::checkPidFile(string $pidFile, string $searchString): bool
ProcessManager::matchesCmdline(int $pid, string $search): bool
Process Termination
ProcessManager::kill(int $pid, int $signal = SIGKILL): bool
Use SIGTERM for graceful shutdown when possible.
Cron Locking
ProcessManager::acquireCronLock(string $pidFile, int $maxAge = 1800): void
Behavior:
- active lock -> exits current run
- stale lock -> removed and replaced
- lock cleanup -> registered via shutdown callback
/proc Check Cache
isRunning() uses short TTL caching for /proc checks (1 second) to reduce repeated I/O in tight loops.
Naming Convention
Common process title format:
XC_VM[{id}]Thumbnail[{id}]TVArchive[{id}]
Used together with CLI process title helpers.
Related Files
| File | Purpose |
|---|---|
src/core/Process/ProcessManager.php |
process operations |
src/core/Process/Multithread.php |
multi-thread helpers |
src/core/Process/Thread.php |
thread wrapper |
src/bootstrap.php |
CLI process context |