Class: AMQ::Protocol::Method

Inherits:

Object

• Object
• AMQ::Protocol::Method

Defined in:

lib/amq/protocol/client.rb

Direct Known Subclasses

Basic::Ack, Basic::Cancel, Basic::CancelOk, Basic::Consume, Basic::ConsumeOk, Basic::Credit, Basic::CreditDrained, Basic::CreditOk, Basic::Deliver, Basic::Get, Basic::GetEmpty, Basic::GetOk, Basic::Nack, Basic::Publish, Basic::Qos, Basic::QosOk, Basic::Recover, Basic::RecoverAsync, Basic::RecoverOk, Basic::Reject, Basic::Return, Channel::Close, Channel::CloseOk, Channel::Flow, Channel::FlowOk, Channel::Open, Channel::OpenOk, Confirm::Select, Confirm::SelectOk, Connection::Close, Connection::CloseOk, Connection::Open, Connection::OpenOk, Connection::Secure, Connection::SecureOk, Connection::Start, Connection::StartOk, Connection::Tune, Connection::TuneOk, Exchange::Bind, Exchange::BindOk, Exchange::Declare, Exchange::DeclareOk, Exchange::Delete, Exchange::DeleteOk, Exchange::Unbind, Exchange::UnbindOk, Queue::Bind, Queue::BindOk, Queue::Declare, Queue::DeclareOk, Queue::Delete, Queue::DeleteOk, Queue::Purge, Queue::PurgeOk, Queue::Unbind, Queue::UnbindOk, Tx::Commit, Tx::CommitOk, Tx::Rollback, Tx::RollbackOk, Tx::Select, Tx::SelectOk

Class Method Summary

• .encode_body(body, channel, frame_size) ⇒ Object
• .index ⇒ Object
• .inherited(base) ⇒ Object
• .instantiate(*args, &block) ⇒ Object

  We can return different: - instantiate given subclass of Method - create an OpenStruct object - create a hash - yield params into the block rather than just return.

• .method_id ⇒ Object
• .methods ⇒ Object
• .name ⇒ Object
• .split_headers(user_headers) ⇒ Object

Class Method Details

.encode_body(body, channel, frame_size) ⇒ Object

# File 'lib/amq/protocol/client.rb', line 252

def self.encode_body(body, channel, frame_size)
  return [] if body.empty?

  # 8 = 1 + 2 + 4 + 1
  # 1 byte of frame type
  # 2 bytes of channel number
  # 4 bytes of frame payload length
  # 1 byte of payload trailer FRAME_END byte
  limit        = frame_size - 8

  # Otherwise String#slice on 1.9 will operate with code points,
  # and we need bytes. MK.
  body.force_encoding("ASCII-8BIT") if RUBY_VERSION.to_f >= 1.9

  array = Array.new
  while body
    payload, body = body[0, limit], body[limit, body.length - limit]
    # array << [0x03, payload]
    array << BodyFrame.new(payload, channel)
  end

  array
end

.index ⇒ Object

# File 'lib/amq/protocol/client.rb', line 224

def self.index
  @index
end

.inherited(base) ⇒ Object

# File 'lib/amq/protocol/client.rb', line 228

def self.inherited(base)
  if self == Protocol::Method
    @methods << base
  end
end

.instantiate(*args, &block) ⇒ Object

We can return different:

• instantiate given subclass of Method

• create an OpenStruct object

• create a hash

• yield params into the block rather than just return

# File 'lib/amq/protocol/client.rb', line 282

def self.instantiate(*args, &block)
  self.new(*args, &block)
  # or OpenStruct.new(args.first)
  # or args.first
  # or block.call(*args)
end

.method_id ⇒ Object

# File 'lib/amq/protocol/client.rb', line 216

def self.method_id
  @method_id
end

.methods ⇒ Object

# File 'lib/amq/protocol/client.rb', line 234

def self.methods
  @methods
end

.name ⇒ Object

# File 'lib/amq/protocol/client.rb', line 220

def self.name
  @name
end

.split_headers(user_headers) ⇒ Object

# File 'lib/amq/protocol/client.rb', line 238

def self.split_headers(user_headers)
  properties, headers = {}, {}
  user_headers.each do |key, value|
    # key MUST be a symbol since symbols are not garbage-collected
    if Basic::PROPERTIES.include?(key)
      properties[key] = value
    else
      headers[key] = value
    end
  end

  return [properties, headers]
end