lib/lwes/emitter.rb

   1 # The LWES::Emitter is used for emitting LWES events to a multicast
   2 # network or a single host.  It can emit LWES::Event objects, LWES::Struct
   3 # objects, and even plain Ruby hashes.
   4 #
   5 # It is non-blocking and does not guarantee delivery.
   6 #
   7 #
   8 #    emitter = LWES::Emitter.new(:address => '224.1.1.11',
   9 #                                :port => 12345,
  10 #                                :heartbeat => 30, # nil to disable
  11 #                                :ttl => 1) # nil for default TTL(3)
  12 #    event = MyEvent.new
  13 #    event.foo = "bar"
  14 #
  15 #    emitter << event
  16 #
  17 # === NON-ESF USERS
  18 #
  19 # Since we can't reliably map certain Ruby types to LWES types, you'll
  20 # have to specify them explicitly for IP addresses and all Integer
  21 # types.
  22 #
  23 #    event = {
  24 #      :time_sec => [ :int32, Time.now.to_i ],
  25 #      :time_usec => [ :int32, Time.now.tv_usec ],
  26 #      :remote_addr => [ :ip_addr, "192.168.0.1" ],
  27 #    }
  28 #
  29 #    # Strings and Boolean values are easily mapped, however:
  30 #    event[:field1] = "String value"
  31 #    event[:boolean1] = true
  32 #    event[:boolean2] = false
  33 #
  34 #    # finally, we just emit the hash with any given name
  35 #    emitter.emit "Event3", event
  36 class LWES::Emitter
  37
  38   # creates a new Emitter object which may be used for the lifetime
  39   # of the process:
  40   #
  41   #   LWES::Emitter.new(:address => '224.1.1.11',
  42   #                     :iface => '0.0.0.0',
  43   #                     :port => 12345,
  44   #                     :heartbeat => false, # Integer for frequency
  45   #                     :ttl => 60, # nil for no ttl)
  46   #
  47   def initialize(options = {}, &block)
  48     options[:iface] ||= '0.0.0.0'
  49     _create(options)
  50     block_given?
  51   end
  52 end