process-manager-socket

Wayland socket path management crate.

Overview

Provides types for building, registering, and managing Wayland socket paths. Sockets are created in XDG_RUNTIME_DIR and can be shared across threads via Arc<SocketManager>.

In a Wayland compositor, each output may need its own socket. SocketManager allows registering multiple sockets by name (e.g. "default", "hdmi-1") and retrieving them when spawning compositor clients. The Socket type is a lightweight PathBuf newtype that can be passed to ProcessConfig::socket() to automatically set WAYLAND_DISPLAY in a child process’s environment.

Types

Socket - PathBuf newtype with path() accessor, Deref<Target = Path>, Display, AsRef<OsStr>, AsRef<str>, Serialize/Deserialize implementations
SocketBuilder - Builds socket paths in XDG_RUNTIME_DIR, validates existing names or generates unique ones
SocketManager - Multi-socket manager using DashMap, shareable via Arc across threads
SocketBuilderError - Error type for socket construction failures
SocketManagerError - Error type for socket management operations

Architecture

graph TD
    classDef default fill: #1e1e1e, stroke: #333333, stroke-width: 1px, color: #ffffff
    classDef builder fill: #00a1e4, stroke: #ffffff, stroke-width: 2px, color: #ffffff
    classDef manager fill: #f5b700, stroke: #333333, stroke-width: 2px, color: #000000
    classDef socket fill: #89fc00, stroke: #333333, stroke-width: 1px, color: #000

    A["SocketBuilder::build()"] --> B["Socket"]
    B --> C["SocketManager::register()"]
    C --> D["SocketManager<br/><small>DashMap&lt;String, Socket&gt;</small>"]
    D --> E["SocketManager::get()"]
    E --> F["Socket"]
    F --> G["ProcessConfig::socket()"]

    class A builder
    class B socket
    class C manager
    class D manager
    class E manager
    class F socket
    class G builder

Dependencies

dashmap - concurrent map for SocketManager
thiserror - error types
serde - Serialize/Deserialize for Socket

Usage

#![allow(unused)]
fn main() {
use process_manager_socket::{SocketBuilder, SocketManager};
use std::sync::Arc;

// Build a socket (auto-generates unique name if None)
let socket = SocketBuilder::build(&None)?;

// Register in manager
let manager = Arc::new(SocketManager::new());
manager.register("default", socket)?;

// Retrieve by name
let socket = manager.get("default");
assert!(socket.is_some());
}

See the individual pages for detailed documentation: