Class: Carnivore::Callback

Inherits:

Object

• Object
• Carnivore::Callback

show all

Includes:

Utils::Logging, Celluloid

Defined in:

lib/carnivore/callback.rb

Overview

Class Attribute Summary (collapse)

• + (Object) workers

  Define number of workers to create.

Instance Attribute Summary (collapse)

• - (String, Symbol) name readonly

  Name of callback.

• - (Carnivore::Source) source readonly

  Source this callback is attached.

Instance Method Summary (collapse)

• - (Object) call(message)

  Execute callback against given message.

• - (Callback) initialize(name, source, block = nil) constructor

  Creates a new callback.

• - (String) inspect (also: #to_s)

  Provide nice output when printed.

• - (NilClass) log(*args) included from Utils::Logging

  Log message.

• - (Object) setup

  Used by custom callback classes for setup.

• - (TrueClass, FalseClass) valid?(message)

  Message is valid for this callback.

26
27
28
29
30
31
32
33
34

# File 'lib/carnivore/callback.rb', line 26

def initialize(name, source, block=nil)
  @name = name
  @source = source
  if(block.nil? && self.class == Callback)
    raise ArgumentError.new 'Block is required for dynamic callbacks!'
  end
  define_singleton_method(:execute, &block) if block
  setup
end

9
10
11

# File 'lib/carnivore/callback.rb', line 9

def workers
  @workers
end

17
18
19

# File 'lib/carnivore/callback.rb', line 17

def name
  @name
end

19
20
21

# File 'lib/carnivore/callback.rb', line 19

def source
  @source
end

60
61
62
63
64
65
66
67
68
69
70
71
72
73

# File 'lib/carnivore/callback.rb', line 60

def call(message)
  begin
    if(valid?(message))
      debug ">> Received message is valid for this callback (#{message})"
      execute(message)
    else
      debug "Invalid message for this callback #{message})"
    end
  rescue => e
    error "[callback: #{self}, source: #{message[:source]}, message: #{message[:message].object_id}]: #{e.class} - #{e}"
    debug "#{e.class}: #{e}\n#{e.backtrace.join("\n")}"
    nil
  end
end

44
45
46

# File 'lib/carnivore/callback.rb', line 44

def inspect
  "callback<#{self.name}:#{self.object_id}>"
end

37
38
39

# File 'lib/carnivore/callback.rb', line 37

def setup
  debug 'No custom setup defined'
end

53
54
55

# File 'lib/carnivore/callback.rb', line 53

def valid?(message)
  true
end