Class: EventMachine::Completion

Inherits:
Object
  • Object
show all
Includes:
Deferrable
Defined in:
lib/em/completion.rb

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Methods included from Deferrable

future

Constructor Details

- (Completion) initialize

A new instance of Completion



171
172
173
174
175
176
# File 'lib/em/completion.rb', line 171

def initialize
  @state = :unknown
  @callbacks = Hash.new { |h,k| h[k] = [] }
  @value = []
  @timeout_timer = nil
end

Instance Attribute Details

- (Object) state (readonly)

Returns the value of attribute state



169
170
171
# File 'lib/em/completion.rb', line 169

def state
  @state
end

- (Object) value (readonly)

Returns the value of attribute value



169
170
171
# File 'lib/em/completion.rb', line 169

def value
  @value
end

Instance Method Details

- (Object) callback(*a, &b)

Callbacks are called when you enter (or are in) a :succeeded state.



206
207
208
# File 'lib/em/completion.rb', line 206

def callback(*a, &b)
  stateback(:succeeded, *a, &b)
end

- (Object) cancel_callback(*a, &b)

Remove a callback. N.B. Some callbacks cannot be deleted. Usage is NOT recommended, this is an anti-pattern.



272
273
274
# File 'lib/em/completion.rb', line 272

def cancel_callback(*a, &b)
  @callbacks[:succeeded].delete(EM::Callback(*a, &b))
end

- (Object) cancel_errback(*a, &b)

Remove an errback. N.B. Some errbacks cannot be deleted. Usage is NOT recommended, this is an anti-pattern.



266
267
268
# File 'lib/em/completion.rb', line 266

def cancel_errback(*a, &b)
  @callbacks[:failed].delete(EM::Callback(*a, &b))
end

- (Object) cancel_timeout

Disable the timeout



257
258
259
260
261
262
# File 'lib/em/completion.rb', line 257

def cancel_timeout
  if @timeout_timer
    @timeout_timer.cancel
    @timeout_timer = nil
  end
end

- (Object) change_state(state, *args) Also known as: set_deferred_status

Enter a new state, setting the result value if given. If the state is one of :succeeded or :failed, then :completed callbacks will also be called.



224
225
226
227
228
229
# File 'lib/em/completion.rb', line 224

def change_state(state, *args)
  @value = args
  @state = state

  EM.schedule { execute_callbacks }
end

- (Boolean) completed?

Indicates that we've reached some kind of completion state, by default this is :succeeded or :failed. Due to these semantics, the :completed state is reserved for internal use.

Returns:

  • (Boolean)


237
238
239
# File 'lib/em/completion.rb', line 237

def completed?
  completion_states.any? { |s| state == s }
end

- (Object) completion(*a, &b)

Completions are called when you enter (or are in) either a :failed or a :succeeded state. They are stored as a special (reserved) state called :completed.



218
219
220
# File 'lib/em/completion.rb', line 218

def completion(*a, &b)
  stateback(:completed, *a, &b)
end

- (Object) completion_states

Completion states simply returns a list of completion states, by default this is :succeeded and :failed.



243
244
245
# File 'lib/em/completion.rb', line 243

def completion_states
  [:succeeded, :failed]
end

- (Object) errback(*a, &b)

Errbacks are called when you enter (or are in) a :failed state.



211
212
213
# File 'lib/em/completion.rb', line 211

def errback(*a, &b)
  stateback(:failed, *a, &b)
end

- (Object) fail(*args) Also known as: set_deferred_failure

Enter the :failed state, setting the result value if given.



186
187
188
# File 'lib/em/completion.rb', line 186

def fail(*args)
  change_state(:failed, *args)
end

- (Object) stateback(state, *a, &b)

Statebacks are called when you enter (or are in) the named state.



193
194
195
196
197
198
199
200
201
202
203
# File 'lib/em/completion.rb', line 193

def stateback(state, *a, &b)
  # The following is quite unfortunate special casing for :completed
  # statebacks, but it's a necessary evil for latent completion
  # definitions.

  if :completed == state || !completed? || @state == state
    @callbacks[state] << EM::Callback(*a, &b)
  end
  execute_callbacks
  self
end

- (Object) succeed(*args) Also known as: set_deferred_success

Enter the :succeeded state, setting the result value if given.



179
180
181
# File 'lib/em/completion.rb', line 179

def succeed(*args)
  change_state(:succeeded, *args)
end

- (Object) timeout(time, *args)

Schedule a time which if passes before we enter a completion state, this deferrable will be failed with the given arguments.



249
250
251
252
253
254
# File 'lib/em/completion.rb', line 249

def timeout(time, *args)
  cancel_timeout
  @timeout_timer = EM::Timer.new(time) do
    fail(*args) unless completed?
  end
end