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, hash_find_value, #http?, #https?, #keyword_argument, try_require, uri_dirname, uri_part_of, urify

Methods included from Timeout

#timeout

Constructor Details

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


566
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
598
599
600
601
602
603
604
# File 'lib/httpclient/session.rb', line 566

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
  @last_used = nil
end

Instance Attribute Details

#connect_retryObject

Returns the value of attribute connect_retry


551
552
553
# File 'lib/httpclient/session.rb', line 551

def connect_retry
  @connect_retry
end

#connect_timeoutObject

Returns the value of attribute connect_timeout


550
551
552
# File 'lib/httpclient/session.rb', line 550

def connect_timeout
  @connect_timeout
end

#debug_devObject

Device for dumping log for debugging


548
549
550
# File 'lib/httpclient/session.rb', line 548

def debug_dev
  @debug_dev
end

#destObject (readonly)

Destination site


540
541
542
# File 'lib/httpclient/session.rb', line 540

def dest
  @dest
end

#last_usedObject (readonly)

Returns the value of attribute last_used


564
565
566
# File 'lib/httpclient/session.rb', line 564

def last_used
  @last_used
end

#protocol_retry_countObject

Returns the value of attribute protocol_retry_count


555
556
557
# File 'lib/httpclient/session.rb', line 555

def protocol_retry_count
  @protocol_retry_count
end

#proxyObject

Proxy site


542
543
544
# File 'lib/httpclient/session.rb', line 542

def proxy
  @proxy
end

#read_block_sizeObject

Returns the value of attribute read_block_size


554
555
556
# File 'lib/httpclient/session.rb', line 554

def read_block_size
  @read_block_size
end

#receive_timeoutObject

Returns the value of attribute receive_timeout


553
554
555
# File 'lib/httpclient/session.rb', line 553

def receive_timeout
  @receive_timeout
end

#requested_versionObject

Requested protocol version


546
547
548
# File 'lib/httpclient/session.rb', line 546

def requested_version
  @requested_version
end

#send_timeoutObject

Returns the value of attribute send_timeout


552
553
554
# File 'lib/httpclient/session.rb', line 552

def send_timeout
  @send_timeout
end

#socket_localObject

Returns the value of attribute socket_local


557
558
559
# File 'lib/httpclient/session.rb', line 557

def socket_local
  @socket_local
end

#socket_syncObject

Boolean value for Socket#sync


544
545
546
# File 'lib/httpclient/session.rb', line 544

def socket_sync
  @socket_sync
end

#ssl_configObject

Returns the value of attribute ssl_config


559
560
561
# File 'lib/httpclient/session.rb', line 559

def ssl_config
  @ssl_config
end

#ssl_peer_certObject (readonly)

Returns the value of attribute ssl_peer_cert


560
561
562
# File 'lib/httpclient/session.rb', line 560

def ssl_peer_cert
  @ssl_peer_cert
end

#test_loopback_http_responseObject

Returns the value of attribute test_loopback_http_response


561
562
563
# File 'lib/httpclient/session.rb', line 561

def test_loopback_http_response
  @test_loopback_http_response
end

#transparent_gzip_decompressionObject

Returns the value of attribute transparent_gzip_decompression


563
564
565
# File 'lib/httpclient/session.rb', line 563

def transparent_gzip_decompression
  @transparent_gzip_decompression
end

Instance Method Details

#closeObject


640
641
642
643
644
645
646
647
# File 'lib/httpclient/session.rb', line 640

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


649
650
651
# File 'lib/httpclient/session.rb', line 649

def closed?
  @state == :INIT
end

#eof?Boolean


674
675
676
677
678
679
680
# File 'lib/httpclient/session.rb', line 674

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

#get_body(&block) ⇒ Object


682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
# File 'lib/httpclient/session.rb', line 682

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_headerObject


661
662
663
664
665
666
667
668
669
670
671
672
# File 'lib/httpclient/session.rb', line 661

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

#invalidateObject


653
654
655
# File 'lib/httpclient/session.rb', line 653

def invalidate
  @invalidated = true
end

#invalidated?Boolean


657
658
659
# File 'lib/httpclient/session.rb', line 657

def invalidated?
  @invalidated
end

#query(req) ⇒ Object

Send a request to the server


607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/httpclient/session.rb', line 607

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? && !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 => e
    close
    if SSLEnabled and e.is_a?(OpenSSL::SSL::SSLError)
      raise KeepAliveDisconnected.new(self, e)
    else
      raise
    end
  end

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