Class: Fix::Protocol::Message

Inherits:

MessagePart

• Object
• MessagePart
• Fix::Protocol::Message

Defined in:

lib/fix/protocol/message.rb

Overview

Represents an instance of a FIX message

Direct Known Subclasses

Fix::Protocol::Messages::Heartbeat, Fix::Protocol::Messages::Logon, Fix::Protocol::Messages::Logout, Fix::Protocol::Messages::MarketDataRequest, Fix::Protocol::Messages::Reject, Fix::Protocol::Messages::ResendRequest, Fix::Protocol::Messages::TestRequest

Instance Attribute Summary

Attributes inherited from MessagePart

#name, #parse_failure

Instance Method Summary

• #dump ⇒ String

  Dumps this message as a FIX protocol message, it will automatically calculate the body length and and checksum.

• #initialize ⇒ Message constructor

  A new instance of Message.

• #valid? ⇒ Boolean

  Whether this instance is ready to be dumped as a valid FIX message.

Methods inherited from MessagePart

collection, #errors, field, inherited, #initialize_node, #node_for_name, #nodes, parse, #parse, part, structure

Constructor Details

#initialize ⇒ Message

Returns a new instance of Message.

# File 'lib/fix/protocol/message.rb', line 18

def initialize
  super
  header.msg_type = MessageClassMapping.reverse_get(self.class)
end

Instance Method Details

#dump ⇒ String

Dumps this message as a FIX protocol message, it will automatically calculate the body length and and checksum

Returns:

• (String) —

  The FIX message

# File 'lib/fix/protocol/message.rb', line 29

def dump
  if valid?
    dumped = super
    header.body_length = dumped.gsub(/^8=[^\x01]+\x019=[^\x01]+\x01/, '').length
    dumped = super
    "#{dumped}10=#{'%03d' % (dumped.bytes.inject(&:+) % 256)}\x01"
  end
end

#valid? ⇒ Boolean

Whether this instance is ready to be dumped as a valid FIX message

Returns:

• (Boolean) —

  Whether there are errors present for this instance

# File 'lib/fix/protocol/message.rb', line 43

def valid?
  (errors.nil? || errors.empty?) && parse_failure.nil?
end