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


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
148
149
150
# File 'lib/httpclient/session.rb', line 121

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_nameObject

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


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

def agent_name
  @agent_name
end

#chunk_sizeObject

Chunk size for chunked request


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

def chunk_size
  @chunk_size
end

#connect_retryObject

Maximum retry count. 0 for infinite.


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

def connect_retry
  @connect_retry
end

#connect_timeoutObject

Returns the value of attribute connect_timeout


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

def connect_timeout
  @connect_timeout
end

#debug_devObject

Device for dumping log for debugging


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

def debug_dev
  @debug_dev
end

#fromObject

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


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

def from
  @from
end

#keep_alive_timeoutObject

Returns the value of attribute keep_alive_timeout


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

def keep_alive_timeout
  @keep_alive_timeout
end

#protocol_retry_countObject

Returns the value of attribute protocol_retry_count


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

def protocol_retry_count
  @protocol_retry_count
end

#protocol_versionObject

Requested protocol version


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

def protocol_version
  @protocol_version
end

#read_block_sizeObject

Returns the value of attribute read_block_size


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

def read_block_size
  @read_block_size
end

#receive_timeoutObject

Returns the value of attribute receive_timeout


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

def receive_timeout
  @receive_timeout
end

#send_timeoutObject

Returns the value of attribute send_timeout


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

def send_timeout
  @send_timeout
end

#socket_localObject

Local address to bind local side of the socket to


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

def socket_local
  @socket_local
end

#socket_syncObject

Boolean value for Socket#sync


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

def socket_sync
  @socket_sync
end

#ssl_configObject

Returns the value of attribute ssl_config


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

def ssl_config
  @ssl_config
end

#test_loopback_http_responseObject (readonly)

Returns the value of attribute test_loopback_http_response


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

def test_loopback_http_response
  @test_loopback_http_response
end

#transparent_gzip_decompressionObject

Returns the value of attribute transparent_gzip_decompression


119
120
121
# File 'lib/httpclient/session.rb', line 119

def transparent_gzip_decompression
  @transparent_gzip_decompression
end

Instance Method Details

#invalidate(site) ⇒ Object


186
187
188
189
190
191
192
193
194
# File 'lib/httpclient/session.rb', line 186

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


182
183
184
# File 'lib/httpclient/session.rb', line 182

def keep(sess)
  add_cached_session(sess)
end

#proxy=(proxy) ⇒ Object


152
153
154
155
156
157
158
# File 'lib/httpclient/session.rb', line 152

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

#query(req, via_proxy) ⇒ Object


160
161
162
163
164
165
166
167
168
169
170
# File 'lib/httpclient/session.rb', line 160

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

#reset(uri) ⇒ Object


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

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

#reset_allObject


177
178
179
# File 'lib/httpclient/session.rb', line 177

def reset_all
  close_all
end