Class: Utils::ProbeClient

Inherits:
Object show all
Defined in:
lib/utils/probe_server.rb

Overview

A client for interacting with the probe server through Unix domain sockets.

This class provides an interface for enqueueing process jobs and managing environment variables on a remote probe server. It uses Unix domain sockets to communicate with the server, enabling distributed task execution and configuration management.

Defined Under Namespace

Classes: EnvProxy

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Utils::ProbeServer

The initialize method sets up a new probe server instance.

This method creates and configures a Unix domain socket server for handling probe jobs and communication. It initializes the server with a specific socket name and runtime directory, preparing it to listen for incoming connections and process jobs.



197
198
199
 
# File 'lib/utils/probe_server.rb', line 197

def initialize
  @server = UnixSocks::Server.new(socket_name: 'probe.sock', runtime_dir: Dir.pwd)
end

Instance Method Details

#enqueue(args) ⇒ Object

The enqueue method submits a new process job to the probe server for execution.

This method transmits a process job request to the underlying Unix domain socket server, which then adds the job to the processing queue. The job includes the specified command arguments that will be executed by the probe server.

job

Parameters:

  • args (Array) —

    the command arguments to be executed by the process



224
225
226
 
# File 'lib/utils/probe_server.rb', line 224

def enqueue(args)
  @server.transmit({ type: 'process_job', args: })
end

#env ⇒ Utils::ProbeServer::EnvProxy

The env method provides access to environment variable management through a proxy object.

This method returns an EnvProxy instance that allows for setting and retrieving environment variables via the probe server communication channel.

variable operations

Returns:

  • (Utils::ProbeServer::EnvProxy) —

    a proxy object for environment



210
211
212
 
# File 'lib/utils/probe_server.rb', line 210

def env
  EnvProxy.new(@server)
end