Class: CFoundry::V1::App::Instance

Inherits:
Object
  • Object
show all
Defined in:
lib/cfoundry/v1/app.rb

Overview

Class represnting a running instance of an application.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app, id, client, manifest = {}) ⇒ Instance

Create an Instance object.

You’ll usually call App#instances instead



491
492
493
494
495
496
 
# File 'lib/cfoundry/v1/app.rb', line 491

def initialize(app, id, client, manifest = {})
  @app = app
  @id = id
  @client = client
  @manifest = manifest
end

Instance Attribute Details

#app ⇒ Object (readonly)

The application this instance belongs to.



483
484
485
 
# File 'lib/cfoundry/v1/app.rb', line 483

def app
  @app
end

#id ⇒ Object (readonly)

Application instance number.



486
487
488
 
# File 'lib/cfoundry/v1/app.rb', line 486

def id
  @id
end

Instance Method Details

#console ⇒ Object

Instance console data. If instance has a console, returns a hash containing :ip and :port keys.



526
527
528
529
530
531
532
 
# File 'lib/cfoundry/v1/app.rb', line 526

def console
  return unless @manifest[:console_ip] and @manifest[:console_port]

  { :ip => @manifest[:console_ip],
    :port => @manifest[:console_port]
  }
end

#debugger ⇒ Object

Instance debugger data. If instance is in debug mode, returns a hash containing :ip and :port keys.



516
517
518
519
520
521
522
 
# File 'lib/cfoundry/v1/app.rb', line 516

def debugger
  return unless @manifest[:debug_ip] and @manifest[:debug_port]

  { :ip => @manifest[:debug_ip],
    :port => @manifest[:debug_port]
  }
end

#file(*path) ⇒ Object

Retrieve file contents for this instance.

path

A sequence of strings representing path segments.

For example, files("foo", "bar") for foo/bar.



563
564
565
 
# File 'lib/cfoundry/v1/app.rb', line 563

def file(*path)
  @client.base.files(@app.name, @id, *path)
end

#files(*path) ⇒ Object

Retrieve file listing under path for this instance.

path

A sequence of strings representing path segments.

For example, files("foo", "bar") for foo/bar.



551
552
553
554
555
 
# File 'lib/cfoundry/v1/app.rb', line 551

def files(*path)
  @client.base.files(@app.name, @id, *path).split("\n").collect do |entry|
    path + [entry.split(/\s+/, 2)[0]]
  end
end

#healthy? ⇒ Boolean

True if instance is starting or running, false if it’s down or flapping.

Returns:

  • (Boolean) 


536
537
538
539
540
541
542
543
 
# File 'lib/cfoundry/v1/app.rb', line 536

def healthy?
  case state
  when "STARTING", "RUNNING"
    true
  when "DOWN", "FLAPPING"
    false
  end
end

#inspect ⇒ Object

Show string representing the application instance.



499
500
501
 
# File 'lib/cfoundry/v1/app.rb', line 499

def inspect
  "#<App::Instance '#{@app.name}' \##@id>"
end

#since ⇒ Object

Instance start time.



510
511
512
 
# File 'lib/cfoundry/v1/app.rb', line 510

def since
  Time.at(@manifest[:since])
end

#state ⇒ Object Also known as: status

Instance state.



504
505
506
 
# File 'lib/cfoundry/v1/app.rb', line 504

def state
  @manifest[:state]
end