Class: RubyAMI::Action

Inherits:

Object

• Object
• RubyAMI::Action

show all

Defined in:

lib/ruby_ami/action.rb

Defined Under Namespace

Classes: UnsupportedActionName

Constant Summary

CAUSAL_EVENT_NAMES =

%w[queuestatus sippeers iaxpeers parkedcalls dahdishowchannels coreshowchannels
dbget status agents konferencelist]

Instance Attribute Summary (collapse)

• - (Object) action_id readonly

  Returns the value of attribute action_id.

• - (Object) headers readonly

  Returns the value of attribute headers.

• - (Object) name readonly

  Returns the value of attribute name.

• - (Object) state

  Returns the value of attribute state.

Instance Method Summary (collapse)

• - (Object) <<(message)
• - (String) causal_event_terminator_name

  Used to determine the event name for an action which has causal events.

• - (Boolean) eql?(other) (also: #==)
• - (Object) events
• - (String) has_causal_events?

  When sending an action with "causal events" (i.e. events which must be collected to form a proper response), AMI should send a particular event which instructs us that no more events will be sent.

• - (Action) initialize(name, headers = {}, &block) constructor

  A new instance of Action.

• - (Boolean) replies_with_action_id?
• - (Object) response(timeout = nil)

  If the response has simply not been received yet from Asterisk, the calling Thread will block until it comes in.

• - (Object) response=(other)
• - (Object) to_s

  Converts this action into a protocol-valid String, ready to be sent over a socket.

10
11
12
13
14
15
16
17
18
19

# File 'lib/ruby_ami/action.rb', line 10

def initialize(name, headers = {}, &block)
  @name       = name.to_s.downcase.freeze
  @headers    = headers.stringify_keys.freeze
  @action_id  = UUIDTools::UUID.random_create.to_s
  @response   = FutureResource.new
  @response_callback = block
  @state      = :new
  @events     = []
  @event_lock = Mutex.new
end

3
4
5

# File 'lib/ruby_ami/action.rb', line 3

def action_id
  @action_id
end

3
4
5

# File 'lib/ruby_ami/action.rb', line 3

def headers
  @headers
end

3
4
5

# File 'lib/ruby_ami/action.rb', line 3

def name
  @name
end

5
6
7

# File 'lib/ruby_ami/action.rb', line 5

def state
  @state
end

93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

# File 'lib/ruby_ami/action.rb', line 93

def <<(message)
  case message
  when Error
    self.response = message
  when Event
    raise StandardError, 'This action should not trigger events. Maybe it is now a causal action? This is most likely a bug in RubyAMI' unless has_causal_events?
    @event_lock.synchronize do
      @events << message
    end
    self.response = @pending_response if message.name.downcase == causal_event_terminator_name
  when Response
    if has_causal_events?
      @pending_response = message
    else
      self.response = message
    end
  end
end

51
52
53
54
55
56
57
58
59
60
61
62
63

# File 'lib/ruby_ami/action.rb', line 51

def causal_event_terminator_name
  return unless has_causal_events?
  case name
  when "sippeers", "iaxpeers"
    "peerlistcomplete"
  when "dbget"
    "dbgetresponse"
  when "konferencelist"
    "conferencelistcomplete"
  else
    name + "complete"
  end
end

118
119
120

# File 'lib/ruby_ami/action.rb', line 118

def eql?(other)
  to_s == other.to_s
end

112
113
114
115
116

# File 'lib/ruby_ami/action.rb', line 112

def events
  @event_lock.synchronize do
    @events.dup
  end
end

41
42
43

# File 'lib/ruby_ami/action.rb', line 41

def has_causal_events?
  CAUSAL_EVENT_NAMES.include? name
end

25
26
27

# File 'lib/ruby_ami/action.rb', line 25

def replies_with_action_id?
  !UnsupportedActionName::UNSUPPORTED_ACTION_NAMES.include? name
end

81
82
83
84
85

# File 'lib/ruby_ami/action.rb', line 81

def response(timeout = nil)
  @response.resource(timeout).tap do |resp|
    raise resp if resp.is_a? Exception
  end
end

87
88
89
90
91

# File 'lib/ruby_ami/action.rb', line 87

def response=(other)
  @state = :complete
  @response.resource = other
  @response_callback.call other if @response_callback
end

68
69
70
71
72
73
74

# File 'lib/ruby_ami/action.rb', line 68

def to_s
  @textual_representation ||= (
      "Action: #{@name}\r\nActionID: #{@action_id}\r\n" +
      @headers.map { |(key,value)| "#{key}: #{value}" }.join("\r\n") +
      (@headers.any? ? "\r\n\r\n" : "\r\n")
  )
end