Class: HTTPClient::Session

Inherits:
Object
  • Object
show all
Includes:
Timeout, Util
Defined in:
lib/httpclient.rb,
lib/httpclient/session.rb

Overview

Manages a HTTP session with a Site.

Direct Known Subclasses

HTTPAccess2::Session

Constant Summary collapse

BadResponse = 
::HTTPClient::BadResponseError

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Util

#argument_to_hash, #force_binary, hash_find_value, #https?, #keyword_argument, uri_dirname, uri_part_of, #urify

Methods included from Timeout

#timeout

Constructor Details

#initialize(client, dest, agent_name, from) ⇒ Session

Returns a new instance of Session.



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/httpclient/session.rb', line 527

def initialize(client, dest, agent_name, from)
  @client = client
  @dest = dest
  @invalidated = false
  @proxy = nil
  @socket_sync = true
  @requested_version = nil

  @debug_dev = nil

  @connect_timeout = nil
  @connect_retry = 1
  @send_timeout = nil
  @receive_timeout = nil
  @read_block_size = nil
  @protocol_retry_count = 5

  @ssl_config = nil
  @ssl_peer_cert = nil

  @test_loopback_http_response = nil
  @socket_local = Site::EMPTY

  @agent_name = agent_name
  @from = from
  @state = :INIT

  @requests = []

  @status = nil
  @reason = nil
  @headers = []

  @socket = nil
  @readbuf = nil

  @transparent_gzip_decompression = false
end

Instance Attribute Details

#connect_retry ⇒ Object

Returns the value of attribute connect_retry.



513
514
515
 
# File 'lib/httpclient/session.rb', line 513

def connect_retry
  @connect_retry
end

#connect_timeout ⇒ Object

Returns the value of attribute connect_timeout.



512
513
514
 
# File 'lib/httpclient/session.rb', line 512

def connect_timeout
  @connect_timeout
end

#debug_dev ⇒ Object

Device for dumping log for debugging



510
511
512
 
# File 'lib/httpclient/session.rb', line 510

def debug_dev
  @debug_dev
end

#dest ⇒ Object (readonly)

Destination site



502
503
504
 
# File 'lib/httpclient/session.rb', line 502

def dest
  @dest
end

#protocol_retry_count ⇒ Object

Returns the value of attribute protocol_retry_count.



517
518
519
 
# File 'lib/httpclient/session.rb', line 517

def protocol_retry_count
  @protocol_retry_count
end

#proxy ⇒ Object

Proxy site



504
505
506
 
# File 'lib/httpclient/session.rb', line 504

def proxy
  @proxy
end

#read_block_size ⇒ Object

Returns the value of attribute read_block_size.



516
517
518
 
# File 'lib/httpclient/session.rb', line 516

def read_block_size
  @read_block_size
end

#receive_timeout ⇒ Object

Returns the value of attribute receive_timeout.



515
516
517
 
# File 'lib/httpclient/session.rb', line 515

def receive_timeout
  @receive_timeout
end

#requested_version ⇒ Object

Requested protocol version



508
509
510
 
# File 'lib/httpclient/session.rb', line 508

def requested_version
  @requested_version
end

#send_timeout ⇒ Object

Returns the value of attribute send_timeout.



514
515
516
 
# File 'lib/httpclient/session.rb', line 514

def send_timeout
  @send_timeout
end

#socket_local ⇒ Object

Returns the value of attribute socket_local.



519
520
521
 
# File 'lib/httpclient/session.rb', line 519

def socket_local
  @socket_local
end

#socket_sync ⇒ Object

Boolean value for Socket#sync



506
507
508
 
# File 'lib/httpclient/session.rb', line 506

def socket_sync
  @socket_sync
end

#ssl_config ⇒ Object

Returns the value of attribute ssl_config.



521
522
523
 
# File 'lib/httpclient/session.rb', line 521

def ssl_config
  @ssl_config
end

#ssl_peer_cert ⇒ Object (readonly)

Returns the value of attribute ssl_peer_cert.



522
523
524
 
# File 'lib/httpclient/session.rb', line 522

def ssl_peer_cert
  @ssl_peer_cert
end

#test_loopback_http_response ⇒ Object

Returns the value of attribute test_loopback_http_response.



523
524
525
 
# File 'lib/httpclient/session.rb', line 523

def test_loopback_http_response
  @test_loopback_http_response
end

#transparent_gzip_decompression ⇒ Object

Returns the value of attribute transparent_gzip_decompression.



525
526
527
 
# File 'lib/httpclient/session.rb', line 525

def transparent_gzip_decompression
  @transparent_gzip_decompression
end

Instance Method Details

#close ⇒ Object 



599
600
601
602
603
604
605
606
 
# File 'lib/httpclient/session.rb', line 599

def close
  if !@socket.nil? and !@socket.closed?
    # @socket.flush may block when it the socket is already closed by
    # foreign host and the client runs under MT-condition.
    @socket.close
  end
  @state = :INIT
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


608
609
610
 
# File 'lib/httpclient/session.rb', line 608

def closed?
  @state == :INIT
end

#eof? ⇒ Boolean

Returns:

  • (Boolean) 


633
634
635
636
637
638
639
 
# File 'lib/httpclient/session.rb', line 633

def eof?
  if !@content_length.nil?
    @content_length == 0
  else
    @socket.closed? or @socket.eof?
  end
end

#get_body(&block) ⇒ Object 



641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
 
# File 'lib/httpclient/session.rb', line 641

def get_body(&block)
  begin
    read_header if @state == :META
    return nil if @state != :DATA
    if @gzipped and @transparent_gzip_decompression
      # zlib itself has a functionality to decompress gzip stream.
      # - zlib 1.2.5 Manual
      #   http://www.zlib.net/manual.html#Advanced
      # > windowBits can also be greater than 15 for optional gzip decoding. Add 32 to
      # > windowBits to enable zlib and gzip decoding with automatic header detection,
      # > or add 16 to decode only the gzip format
      inflate_stream = Zlib::Inflate.new(Zlib::MAX_WBITS + 32)
      original_block = block
      block = Proc.new { |buf|
        original_block.call(inflate_stream.inflate(buf))
      }
    end
    if @chunked
      read_body_chunked(&block)
    elsif @content_length
      read_body_length(&block)
    else
      read_body_rest(&block)
    end
  rescue
    close
    raise
  end
  if eof?
    if @next_connection
      @state = :WAIT
    else
      close
    end
  end
  nil
end

#get_header ⇒ Object 



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

def get_header
  begin
    if @state != :META
      raise RuntimeError.new("get_status must be called at the beginning of a session")
    end
    read_header
  rescue
    close
    raise
  end
  [@version, @status, @reason, @headers]
end

#invalidate ⇒ Object 



612
613
614
 
# File 'lib/httpclient/session.rb', line 612

def invalidate
  @invalidated = true
end

#invalidated? ⇒ Boolean

Returns:

  • (Boolean) 


616
617
618
 
# File 'lib/httpclient/session.rb', line 616

def invalidated?
  @invalidated
end

#query(req) ⇒ Object

Send a request to the server



567
568
569
570
571
572
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
 
# File 'lib/httpclient/session.rb', line 567

def query(req)
  connect if @state == :INIT
  # Use absolute URI (not absolute path) iif via proxy AND not HTTPS.
  req.header.request_absolute_uri = !@proxy.nil? and !https?(@dest)
  begin
    timeout(@send_timeout, SendTimeoutError) do
      set_header(req)
      req.dump(@socket)
      # flush the IO stream as IO::sync mode is false
      @socket.flush unless @socket_sync
    end
  rescue Errno::ECONNABORTED, Errno::ECONNRESET, Errno::EPIPE, IOError
    # JRuby can raise IOError instead of ECONNRESET for now
    close
    raise KeepAliveDisconnected.new(self)
  rescue HTTPClient::TimeoutError
    close
    raise
  rescue
    close
    if SSLEnabled and $!.is_a?(OpenSSL::SSL::SSLError)
      raise KeepAliveDisconnected.new(self)
    else
      raise
    end
  end

  @state = :META if @state == :WAIT
  @next_connection = nil
  @requests.push(req)
end