mirror of
https://github.com/Vateron-Media/XC_VM.git
synced 2026-10-15 04:02:55 +02:00
Overhaul the Docsify documentation (English + Russian) so it matches the current codebase and follows one consistent pattern. Content accuracy (post-migration): - Rewrite development/autoloader.md to PSR-4 / Composer (the old XC_Autoloader scanner, igbinary tmp/cache/autoload_map and registerDirectories are gone). - PascalCase every source path (src/core -> src/Core, domain/Stream, cli/Commands, public/Controllers, Infrastructure/Redis, ...) across all docs. - Replace the removed autoload.php references with vendor/autoload.php (build_system, bootstrap-contexts, error-handling, modules). - ssl-generation: note that the installer now auto-generates a unique self-signed certificate before Nginx starts. Common pattern (Clean & uniform): - Strip emoji from headings; remove the in-page Navigation blocks (the Docsify sidebar already provides navigation). - One H1 + intro per doc; uniform "Related files" / "Связанные файлы" section, added to the code-centric docs that lacked it. Structure: - Remove the empty stray docs/api/; move updates_checklist.md into builds/; link the previously-orphaned ucs-integration.md. - Regroup the sidebars (split the oversized guides group into Developer Guides / Security & Access / Integrations; fold builds into Build & Release). Augment: - dev-workflow: Local Setup (make dev-tools) + Quality Checks (phpstan, cs, gates). - build_system: Composer Dependencies section (committed prod-only vendor, committed lock, dev tools via composer install, no build-time vendor step). en/ru parity: - Apply the same structure, fixes and pattern to docs/ru/ (translated), including a new Russian ucs-integration.md. The en and ru file sets are now identical.
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 |