Class: DRb::DRbMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/drb/drb.rb

Overview

Handler for sending and receiving drb messages.

This takes care of the low-level marshalling and unmarshalling of drb requests and responses sent over the wire between server and client. This relieves the implementor of a new drb protocol layer with having to deal with these details.

The user does not have to directly deal with this object in normal use.

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ DRbMessage

:nodoc:


558
559
560
561
# File 'lib/drb/drb.rb', line 558

def initialize(config) # :nodoc:
  @load_limit = config[:load_limit]
  @argc_limit = config[:argc_limit]
end

Instance Method Details

#dump(obj, error = false) ⇒ Object

:nodoc:


563
564
565
566
567
568
569
570
571
# File 'lib/drb/drb.rb', line 563

def dump(obj, error=false)  # :nodoc:
  obj = make_proxy(obj, error) if obj.kind_of? DRbUndumped
  begin
    str = Marshal::dump(obj)
  rescue
    str = Marshal::dump(make_proxy(obj, error))
  end
  [str.size].pack('N') + str
end

#load(soc) ⇒ Object

:nodoc:

Raises:


573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
# File 'lib/drb/drb.rb', line 573

def load(soc)  # :nodoc:
  begin
    sz = soc.read(4)        # sizeof (N)
  rescue
    raise(DRbConnError, $!.message, $!.backtrace)
  end
  raise(DRbConnError, 'connection closed') if sz.nil?
  raise(DRbConnError, 'premature header') if sz.size < 4
  sz = sz.unpack('N')[0]
  raise(DRbConnError, "too large packet #{sz}") if @load_limit < sz
  begin
    str = soc.read(sz)
  rescue
    raise(DRbConnError, $!.message, $!.backtrace)
  end
  raise(DRbConnError, 'connection closed') if str.nil?
  raise(DRbConnError, 'premature marshal format(can\'t read)') if str.size < sz
  DRb.mutex.synchronize do
    begin
      save = Thread.current[:drb_untaint]
      Thread.current[:drb_untaint] = []
      Marshal::load(str)
    rescue NameError, ArgumentError
      DRbUnknown.new($!, str)
    ensure
      Thread.current[:drb_untaint].each do |x|
        x.untaint
      end
      Thread.current[:drb_untaint] = save
    end
  end
end

#recv_reply(stream) ⇒ Object

:nodoc:


640
641
642
643
644
# File 'lib/drb/drb.rb', line 640

def recv_reply(stream)  # :nodoc:
  succ = load(stream)
  result = load(stream)
  [succ, result]
end

#recv_request(stream) ⇒ Object

:nodoc:

Raises:


620
621
622
623
624
625
626
627
628
629
630
631
632
# File 'lib/drb/drb.rb', line 620

def recv_request(stream) # :nodoc:
  ref = load(stream)
  ro = DRb.to_obj(ref)
  msg = load(stream)
  argc = load(stream)
  raise(DRbConnError, "too many arguments") if @argc_limit < argc
  argv = Array.new(argc, nil)
  argc.times do |n|
    argv[n] = load(stream)
  end
  block = load(stream)
  return ro, msg, argv, block
end

#send_reply(stream, succ, result) ⇒ Object

:nodoc:


634
635
636
637
638
# File 'lib/drb/drb.rb', line 634

def send_reply(stream, succ, result)  # :nodoc:
  stream.write(dump(succ) + dump(result, !succ))
rescue
  raise(DRbConnError, $!.message, $!.backtrace)
end

#send_request(stream, ref, msg_id, arg, b) ⇒ Object

:nodoc:


606
607
608
609
610
611
612
613
614
615
616
617
618
# File 'lib/drb/drb.rb', line 606

def send_request(stream, ref, msg_id, arg, b) # :nodoc:
  ary = []
  ary.push(dump(ref.__drbref))
  ary.push(dump(msg_id.id2name))
  ary.push(dump(arg.length))
  arg.each do |e|
    ary.push(dump(e))
  end
  ary.push(dump(b))
  stream.write(ary.join(''))
rescue
  raise(DRbConnError, $!.message, $!.backtrace)
end