Class: Nonnative::ConfigurationRunner

Inherits:
Object
  • Object
show all
Defined in:
lib/nonnative/configuration_runner.rb

Overview

Base configuration for a runnable unit managed by Nonnative.

This class holds connection and timing attributes common to processes, servers and services, as well as a nested ConfigurationProxy describing how/if a proxy should be started.

Instances of this type are typically created via Nonnative::Configuration#process, Nonnative::Configuration#server, or Nonnative::Configuration#service.

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ void

Creates a runner configuration with defaults.

Defaults:



42
43
44
45
46
47
48
 
# File 'lib/nonnative/configuration_runner.rb', line 42

def initialize
  self.host = '127.0.0.1'
  self.ports = [0]
  self.wait = 0.1

  @proxy = Nonnative::ConfigurationProxy.new
end

Instance Attribute Details

#host ⇒ String, ...

Returns:

  • (String, nil) —

    runner name used for lookup (for example via ‘pool.process_by_name`)

  • (String) —

    host to bind/connect to (defaults to ‘“127.0.0.1”`)

  • (Array<Integer>) —

    ports to bind/connect to

  • (Numeric) —

    wait interval (seconds) used by runners between lifecycle steps



20
21
22
 
# File 'lib/nonnative/configuration_runner.rb', line 20

def host
  @host
end

#name ⇒ String, ...

Returns:

  • (String, nil) —

    runner name used for lookup (for example via ‘pool.process_by_name`)

  • (String) —

    host to bind/connect to (defaults to ‘“127.0.0.1”`)

  • (Array<Integer>) —

    ports to bind/connect to

  • (Numeric) —

    wait interval (seconds) used by runners between lifecycle steps



20
21
22
 
# File 'lib/nonnative/configuration_runner.rb', line 20

def name
  @name
end

#ports ⇒ Array<Integer>

Returns client-facing ports used for readiness/shutdown checks.

Returns:

  • (Array<Integer>) —

    client-facing ports used for readiness/shutdown checks



23
24
25
 
# File 'lib/nonnative/configuration_runner.rb', line 23

def ports
  @ports
end

#proxy ⇒ Nonnative::ConfigurationProxy

Proxy configuration for this runner.

Note that this returns a configuration object even if no proxy is enabled; by default the proxy kind is ‘“none”`.

Returns:



31
32
33
 
# File 'lib/nonnative/configuration_runner.rb', line 31

def proxy
  @proxy
end

#wait ⇒ String, ...

Returns:

  • (String, nil) —

    runner name used for lookup (for example via ‘pool.process_by_name`)

  • (String) —

    host to bind/connect to (defaults to ‘“127.0.0.1”`)

  • (Array<Integer>) —

    ports to bind/connect to

  • (Numeric) —

    wait interval (seconds) used by runners between lifecycle steps



20
21
22
 
# File 'lib/nonnative/configuration_runner.rb', line 20

def wait
  @wait
end

Instance Method Details

#port ⇒ Integer

Returns the primary client-facing port.

This preserves a single endpoint for proxy binding and client helpers while the public configuration contract uses #ports.

Returns:

  • (Integer) 


64
65
66
 
# File 'lib/nonnative/configuration_runner.rb', line 64

def port
  ports.first
end