Class: HTTPClient::SessionManager

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

Overview

Manages sessions for a HTTPClient instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ SessionManager

Returns a new instance of SessionManager.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/httpclient/session.rb', line 118

def initialize(client)
  @client = client
  @proxy = client.proxy

  @agent_name = nil
  @from = nil

  @protocol_version = nil
  @debug_dev = client.debug_dev
  @socket_sync = true
  @chunk_size = ::HTTP::Message::Body::DEFAULT_CHUNK_SIZE

  @connect_timeout = 60
  @connect_retry = 1
  @send_timeout = 120
  @receive_timeout = 60        # For each read_block_size bytes
  @keep_alive_timeout = 15     # '15' is from Apache 2 default
  @read_block_size = 1024 * 16 # follows net/http change in 1.8.7
  @protocol_retry_count = 5

  @ssl_config = nil
  @test_loopback_http_response = []

  @transparent_gzip_decompression = false
  @socket_local = Site.new

  @sess_pool = {}
  @sess_pool_mutex = Mutex.new
  @sess_pool_last_checked = Time.now
end

Instance Attribute Details

#agent_name ⇒ Object

Name of this client. Used for ‘User-Agent’ header in HTTP request.



87
88
89
 
# File 'lib/httpclient/session.rb', line 87

def agent_name
  @agent_name
end

#chunk_size ⇒ Object

Chunk size for chunked request



94
95
96
 
# File 'lib/httpclient/session.rb', line 94

def chunk_size
  @chunk_size
end

#connect_retry ⇒ Object

Maximum retry count. 0 for infinite.



102
103
104
 
# File 'lib/httpclient/session.rb', line 102

def connect_retry
  @connect_retry
end

#connect_timeout ⇒ Object

Returns the value of attribute connect_timeout.



100
101
102
 
# File 'lib/httpclient/session.rb', line 100

def connect_timeout
  @connect_timeout
end

#debug_dev ⇒ Object

Device for dumping log for debugging



96
97
98
 
# File 'lib/httpclient/session.rb', line 96

def debug_dev
  @debug_dev
end

#from ⇒ Object

Owner of this client. Used for ‘From’ header in HTTP request.



89
90
91
 
# File 'lib/httpclient/session.rb', line 89

def from
  @from
end

#keep_alive_timeout ⇒ Object

Returns the value of attribute keep_alive_timeout.



105
106
107
 
# File 'lib/httpclient/session.rb', line 105

def keep_alive_timeout
  @keep_alive_timeout
end

#protocol_retry_count ⇒ Object

Returns the value of attribute protocol_retry_count.



107
108
109
 
# File 'lib/httpclient/session.rb', line 107

def protocol_retry_count
  @protocol_retry_count
end

#protocol_version ⇒ Object

Requested protocol version



92
93
94
 
# File 'lib/httpclient/session.rb', line 92

def protocol_version
  @protocol_version
end

#read_block_size ⇒ Object

Returns the value of attribute read_block_size.



106
107
108
 
# File 'lib/httpclient/session.rb', line 106

def read_block_size
  @read_block_size
end

#receive_timeout ⇒ Object

Returns the value of attribute receive_timeout.



104
105
106
 
# File 'lib/httpclient/session.rb', line 104

def receive_timeout
  @receive_timeout
end

#send_timeout ⇒ Object

Returns the value of attribute send_timeout.



103
104
105
 
# File 'lib/httpclient/session.rb', line 103

def send_timeout
  @send_timeout
end

#socket_local ⇒ Object

Local address to bind local side of the socket to



110
111
112
 
# File 'lib/httpclient/session.rb', line 110

def socket_local
  @socket_local
end

#socket_sync ⇒ Object

Boolean value for Socket#sync



98
99
100
 
# File 'lib/httpclient/session.rb', line 98

def socket_sync
  @socket_sync
end

#ssl_config ⇒ Object

Returns the value of attribute ssl_config.



112
113
114
 
# File 'lib/httpclient/session.rb', line 112

def ssl_config
  @ssl_config
end

#test_loopback_http_response ⇒ Object (readonly)

Returns the value of attribute test_loopback_http_response.



114
115
116
 
# File 'lib/httpclient/session.rb', line 114

def test_loopback_http_response
  @test_loopback_http_response
end

#transparent_gzip_decompression ⇒ Object

Returns the value of attribute transparent_gzip_decompression.



116
117
118
 
# File 'lib/httpclient/session.rb', line 116

def transparent_gzip_decompression
  @transparent_gzip_decompression
end

Instance Method Details

#invalidate(site) ⇒ Object 



183
184
185
186
187
188
189
190
191
 
# File 'lib/httpclient/session.rb', line 183

def invalidate(site)
  @sess_pool_mutex.synchronize do
    if pool = @sess_pool[site]
      pool.each do |sess|
        sess.invalidate
      end
    end
  end
end

#keep(sess) ⇒ Object

assert: sess.last_used must not be nil



179
180
181
 
# File 'lib/httpclient/session.rb', line 179

def keep(sess)
  add_cached_session(sess)
end

#proxy=(proxy) ⇒ Object 



149
150
151
152
153
154
155
 
# File 'lib/httpclient/session.rb', line 149

def proxy=(proxy)
  if proxy.nil?
    @proxy = nil
  else
    @proxy = Site.new(proxy)
  end
end

#query(req, via_proxy) ⇒ Object 



157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/httpclient/session.rb', line 157

def query(req, via_proxy)
  req.http_body.chunk_size = @chunk_size
  sess = open(req.header.request_uri, via_proxy)
  begin
    sess.query(req)
  rescue
    sess.close
    raise
  end
  sess
end

#reset(uri) ⇒ Object 



169
170
171
172
 
# File 'lib/httpclient/session.rb', line 169

def reset(uri)
  site = Site.new(uri)
  close(site)
end

#reset_all ⇒ Object 



174
175
176
 
# File 'lib/httpclient/session.rb', line 174

def reset_all
  close_all
end