Class: IB::Messages::AbstractMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/ib-ruby/messages/abstract_message.rb

Overview

This is just a basic generic message from the server.

Class variables: Instance attributes (at least):

Version:

    • int: current version of message format.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#created_at ⇒ Object

Returns the value of attribute created_at.



49
50
51
 
# File 'lib/ib-ruby/messages/abstract_message.rb', line 49

def created_at
  @created_at
end

#data ⇒ Object

Returns the value of attribute data.



49
50
51
 
# File 'lib/ib-ruby/messages/abstract_message.rb', line 49

def data
  @data
end

Class Method Details

.data_map ⇒ Object

Class methods



24
25
26
 
# File 'lib/ib-ruby/messages/abstract_message.rb', line 24

def self.data_map # Map for converting between structured message and raw data
  @data_map ||= []
end

.message_id ⇒ Object 



32
33
34
 
# File 'lib/ib-ruby/messages/abstract_message.rb', line 32

def self.message_id
  @message_id
end

.message_type ⇒ Object

Returns message type Symbol (e.g. :OpenOrderEnd)



37
38
39
 
# File 'lib/ib-ruby/messages/abstract_message.rb', line 37

def self.message_type
  to_s.split(/::/).last.to_sym
end

.version ⇒ Object

Per class, minimum message version supported



28
29
30
 
# File 'lib/ib-ruby/messages/abstract_message.rb', line 28

def self.version # Per class, minimum message version supported
  @version || 1
end

Instance Method Details

#message_id ⇒ Object 



41
42
43
 
# File 'lib/ib-ruby/messages/abstract_message.rb', line 41

def message_id
  self.class.message_id
end

#message_type ⇒ Object 



45
46
47
 
# File 'lib/ib-ruby/messages/abstract_message.rb', line 45

def message_type
  self.class.message_type
end

#to_human ⇒ Object 



51
52
53
54
55
56
57
58
 
# File 'lib/ib-ruby/messages/abstract_message.rb', line 51

def to_human
  "<#{self.message_type}:" +
      @data.map do |key, value|
        unless [:version].include?(key)
          " #{key} #{ value.is_a?(Hash) ? value.inspect : value}"
        end
      end.compact.join(',') + " >"
end