Blame - docs/httplib2.socks.html - platform/external/python/google-api-python-client

2011-02-20 01:42:07 -0500

[diff] [blame]

12

<tt>SocksiPy - Python SOCKS module.

13

Version 1.00

14

15

Copyright 2006 Dan-Haim. All rights reserved.

16

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

17

Redistribution and use in source and binary forms, with or without modification,

18

are permitted provided that the following conditions are met:

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

19

1. Redistributions of source code must retain the above copyright notice, this

20

list of conditions and the following disclaimer.

21

2. Redistributions in binary form must reproduce the above copyright notice,

22

this list of conditions and the following disclaimer in the documentation

23

and/or other materials provided with the distribution.

24

3. Neither the name of Dan Haim nor the names of his contributors may be used

25

to endorse or promote products derived from this software without specific

26

prior written permission.

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

27

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

28

THIS SOFTWARE IS PROVIDED BY DAN HAIM "AS IS" AND ANY EXPRESS OR IMPLIED

29

WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

30

MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO

31

EVENT SHALL DAN HAIM OR HIS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,

32

INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

33

LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA

34

OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

35

LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

36

OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMANGE.

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

37

38

39

This module provides a standard socket-like interface for Python

40

for tunneling connections through SOCKS proxies.</tt>

<big>Modules</big></td></tr>

46

47

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

48

49

</td><td width="25%" valign=top><a href="socket.html">socket</a>

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

50

</td><td width="25%" valign=top><a href="struct.html">struct</a>

51

</td><td width="25%" valign=top><a href="sys.html">sys</a>

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

52

</td></tr></table></td></tr></table>

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

<big>Classes</big></td></tr>

<dt><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)

61

</dt><dd>

62

<dl>

63

<dt><a href="httplib2.socks.html#ProxyError">ProxyError</a>

64

</dt><dd>

65

<dl>

66

<dt><a href="httplib2.socks.html#GeneralProxyError">GeneralProxyError</a>

67

</dt><dt><a href="httplib2.socks.html#HTTPError">HTTPError</a>

68

</dt><dt><a href="httplib2.socks.html#Socks4Error">Socks4Error</a>

69

</dt><dt><a href="httplib2.socks.html#Socks5AuthError">Socks5AuthError</a>

70

</dt><dt><a href="httplib2.socks.html#Socks5Error">Socks5Error</a>

</dt></dl>

</dd>

</dl>

</dd>

<dt><a href="socket.html#_socketobject">socket._socketobject</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

76

</dt><dd>

77

<dl>

78

<dt><a href="httplib2.socks.html#socksocket">socksocket</a>

</dt></dl>

</dd>

</dl>

<a name="GeneralProxyError">class GeneralProxyError</a>(<a href="httplib2.socks.html#ProxyError">ProxyError</a>)</td></tr>

87

88

89

<td width="100%"><dl><dt>Method resolution order:</dt>

90

<dd><a href="httplib2.socks.html#GeneralProxyError">GeneralProxyError</a></dd>

91

<dd><a href="httplib2.socks.html#ProxyError">ProxyError</a></dd>

92

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

93

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

94

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

95

</dl>

96

<hr>

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

97

Data descriptors inherited from <a href="httplib2.socks.html#ProxyError">ProxyError</a>:

98

<dl><dt>__weakref__</dt>

99

<dd><tt>list of weak references to the object (if defined)</tt></dd>

100

</dl>

101

<hr>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

102

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

103

<dl><dt><a name="GeneralProxyError-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#GeneralProxyError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

104

105

<hr>

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

106

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

107

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#GeneralProxyError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>

108

109

<hr>

110

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

111

<dl><dt><a name="GeneralProxyError-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#GeneralProxyError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

112

113

<dl><dt><a name="GeneralProxyError-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#GeneralProxyError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

114

115

<dl><dt><a name="GeneralProxyError-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#GeneralProxyError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

116

117

<dl><dt><a name="GeneralProxyError-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#GeneralProxyError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

118

119

Use of negative indices is not supported.</tt></dd></dl>

120

121

<dl><dt><a name="GeneralProxyError-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="GeneralProxyError-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#GeneralProxyError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

126

127

<dl><dt><a name="GeneralProxyError-__setstate__">__setstate__</a>(...)</dt></dl>

128

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

129

130

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

131

<dl><dt><a name="GeneralProxyError-__unicode__">__unicode__</a>(...)</dt></dl>

132

133

<hr>

134

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

</td></tr></table>

<a name="HTTPError">class HTTPError</a>(<a href="httplib2.socks.html#ProxyError">ProxyError</a>)</td></tr>

146

147

148

<td width="100%"><dl><dt>Method resolution order:</dt>

149

<dd><a href="httplib2.socks.html#HTTPError">HTTPError</a></dd>

150

<dd><a href="httplib2.socks.html#ProxyError">ProxyError</a></dd>

151

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

152

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

153

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

154

</dl>

155

<hr>

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

156

Data descriptors inherited from <a href="httplib2.socks.html#ProxyError">ProxyError</a>:

157

<dl><dt>__weakref__</dt>

158

<dd><tt>list of weak references to the object (if defined)</tt></dd>

159

</dl>

160

<hr>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

161

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

162

<dl><dt><a name="HTTPError-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#HTTPError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

163

164

<hr>

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

165

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

166

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#HTTPError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>

167

168

<hr>

169

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

170

<dl><dt><a name="HTTPError-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#HTTPError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

171

172

<dl><dt><a name="HTTPError-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#HTTPError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

173

174

<dl><dt><a name="HTTPError-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#HTTPError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

175

176

<dl><dt><a name="HTTPError-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#HTTPError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

177

178

Use of negative indices is not supported.</tt></dd></dl>

179

180

<dl><dt><a name="HTTPError-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="HTTPError-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#HTTPError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

185

186

<dl><dt><a name="HTTPError-__setstate__">__setstate__</a>(...)</dt></dl>

187

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

188

189

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

190

<dl><dt><a name="HTTPError-__unicode__">__unicode__</a>(...)</dt></dl>

191

192

<hr>

193

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

</td></tr></table>

<a name="ProxyError">class ProxyError</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</td></tr>

205

206

207

<td width="100%"><dl><dt>Method resolution order:</dt>

208

<dd><a href="httplib2.socks.html#ProxyError">ProxyError</a></dd>

209

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

210

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

211

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

212

</dl>

213

<hr>

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

214

Data descriptors defined here:

215

<dl><dt>__weakref__</dt>

216

<dd><tt>list of weak references to the object (if defined)</tt></dd>

217

</dl>

218

<hr>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

219

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

220

<dl><dt><a name="ProxyError-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#ProxyError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

221

222

<hr>

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

223

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

224

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#ProxyError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>

225

226

<hr>

227

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

228

<dl><dt><a name="ProxyError-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#ProxyError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

229

230

<dl><dt><a name="ProxyError-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#ProxyError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

231

232

<dl><dt><a name="ProxyError-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#ProxyError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

233

234

<dl><dt><a name="ProxyError-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#ProxyError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

235

236

Use of negative indices is not supported.</tt></dd></dl>

237

238

<dl><dt><a name="ProxyError-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="ProxyError-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#ProxyError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

243

244

<dl><dt><a name="ProxyError-__setstate__">__setstate__</a>(...)</dt></dl>

245

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

246

247

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

248

<dl><dt><a name="ProxyError-__unicode__">__unicode__</a>(...)</dt></dl>

249

250

<hr>

251

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

</td></tr></table>

<a name="Socks4Error">class Socks4Error</a>(<a href="httplib2.socks.html#ProxyError">ProxyError</a>)</td></tr>

263

264

265

<td width="100%"><dl><dt>Method resolution order:</dt>

266

<dd><a href="httplib2.socks.html#Socks4Error">Socks4Error</a></dd>

267

<dd><a href="httplib2.socks.html#ProxyError">ProxyError</a></dd>

268

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

269

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

270

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

271

</dl>

272

<hr>

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

273

Data descriptors inherited from <a href="httplib2.socks.html#ProxyError">ProxyError</a>:

274

<dl><dt>__weakref__</dt>

275

<dd><tt>list of weak references to the object (if defined)</tt></dd>

276

</dl>

277

<hr>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

278

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

279

<dl><dt><a name="Socks4Error-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#Socks4Error-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

280

281

<hr>

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

282

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

283

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#Socks4Error-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>

284

285

<hr>

286

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

287

<dl><dt><a name="Socks4Error-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#Socks4Error-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

288

289

<dl><dt><a name="Socks4Error-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#Socks4Error-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

290

291

<dl><dt><a name="Socks4Error-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#Socks4Error-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

292

293

<dl><dt><a name="Socks4Error-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#Socks4Error-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

294

295

Use of negative indices is not supported.</tt></dd></dl>

296

297

<dl><dt><a name="Socks4Error-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="Socks4Error-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#Socks4Error-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

302

303

<dl><dt><a name="Socks4Error-__setstate__">__setstate__</a>(...)</dt></dl>

304

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

305

306

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

307

<dl><dt><a name="Socks4Error-__unicode__">__unicode__</a>(...)</dt></dl>

308

309

<hr>

310

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

</td></tr></table>

<a name="Socks5AuthError">class Socks5AuthError</a>(<a href="httplib2.socks.html#ProxyError">ProxyError</a>)</td></tr>

322

323

324

<td width="100%"><dl><dt>Method resolution order:</dt>

325

<dd><a href="httplib2.socks.html#Socks5AuthError">Socks5AuthError</a></dd>

326

<dd><a href="httplib2.socks.html#ProxyError">ProxyError</a></dd>

327

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

328

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

329

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

330

</dl>

331

<hr>

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

332

Data descriptors inherited from <a href="httplib2.socks.html#ProxyError">ProxyError</a>:

333

<dl><dt>__weakref__</dt>

334

<dd><tt>list of weak references to the object (if defined)</tt></dd>

335

</dl>

336

<hr>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

337

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

338

<dl><dt><a name="Socks5AuthError-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#Socks5AuthError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

339

340

<hr>

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

341

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

342

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#Socks5AuthError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>

343

344

<hr>

345

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

346

<dl><dt><a name="Socks5AuthError-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#Socks5AuthError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

347

348

<dl><dt><a name="Socks5AuthError-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#Socks5AuthError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

349

350

<dl><dt><a name="Socks5AuthError-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#Socks5AuthError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

351

352

<dl><dt><a name="Socks5AuthError-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#Socks5AuthError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

353

354

Use of negative indices is not supported.</tt></dd></dl>

355

356

<dl><dt><a name="Socks5AuthError-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="Socks5AuthError-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#Socks5AuthError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

361

362

<dl><dt><a name="Socks5AuthError-__setstate__">__setstate__</a>(...)</dt></dl>

363

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

364

365

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

366

<dl><dt><a name="Socks5AuthError-__unicode__">__unicode__</a>(...)</dt></dl>

367

368

<hr>

369

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

</td></tr></table>

<a name="Socks5Error">class Socks5Error</a>(<a href="httplib2.socks.html#ProxyError">ProxyError</a>)</td></tr>

381

382

383

<td width="100%"><dl><dt>Method resolution order:</dt>

384

<dd><a href="httplib2.socks.html#Socks5Error">Socks5Error</a></dd>

385

<dd><a href="httplib2.socks.html#ProxyError">ProxyError</a></dd>

386

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

387

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

388

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

389

</dl>

390

<hr>

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

391

Data descriptors inherited from <a href="httplib2.socks.html#ProxyError">ProxyError</a>:

392

<dl><dt>__weakref__</dt>

393

<dd><tt>list of weak references to the object (if defined)</tt></dd>

394

</dl>

395

<hr>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

396

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

397

<dl><dt><a name="Socks5Error-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#Socks5Error-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

398

399

<hr>

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

400

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

401

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#Socks5Error-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>

402

403

<hr>

404

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

405

<dl><dt><a name="Socks5Error-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#Socks5Error-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

406

407

<dl><dt><a name="Socks5Error-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#Socks5Error-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

408

409

<dl><dt><a name="Socks5Error-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#Socks5Error-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

410

411

<dl><dt><a name="Socks5Error-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#Socks5Error-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

412

413

Use of negative indices is not supported.</tt></dd></dl>

414

415

<dl><dt><a name="Socks5Error-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="Socks5Error-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#Socks5Error-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

420

421

<dl><dt><a name="Socks5Error-__setstate__">__setstate__</a>(...)</dt></dl>

422

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

423

424

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

425

<dl><dt><a name="Socks5Error-__unicode__">__unicode__</a>(...)</dt></dl>

426

427

<hr>

428

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

</td></tr></table>

<a name="socksocket">class socksocket</a>(<a href="socket.html#_socketobject">socket._socketobject</a>)</td></tr>

440

441

442

<td colspan=2><tt><a href="#socksocket">socksocket</a>([family[, type[, proto]]]) -> socket object

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

443

Open a SOCKS enabled socket. The parameters are the same as

444

those of the standard socket init. In order for SOCKS to work,

445

you must specify family=AF_INET, type=SOCK_STREAM and proto=0.  </tt></td></tr>

446

447

<td width="100%"><dl><dt>Method resolution order:</dt>

448

<dd><a href="httplib2.socks.html#socksocket">socksocket</a></dd>

449

<dd><a href="socket.html#_socketobject">socket._socketobject</a></dd>

450

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

451

</dl>

452

<hr>

453

Methods defined here:

454

<dl><dt><a name="socksocket-__init__">__init__</a>(self, family=2, type=1, proto=0, _sock=None)</dt></dl>

455

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

456

<dl><dt><a name="socksocket-connect">connect</a>(self, destpair)</dt><dd><tt><a href="#socksocket-connect">connect</a>(self, despair)

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

457

Connects to the specified destination through a proxy.

458

destpar - A tuple of the IP/DNS address and the port number.

459

(identical to socket's connect).

460

To select the proxy server use <a href="#socksocket-setproxy">setproxy</a>().</tt></dd></dl>

461

462

<dl><dt><a name="socksocket-getpeername">getpeername</a>(self)</dt><dd><tt><a href="#socksocket-getpeername">getpeername</a>() -> address info

463

Returns the IP address and port number of the destination

464

machine (note: getproxypeername returns the proxy)</tt></dd></dl>

465

466

<dl><dt><a name="socksocket-getproxypeername">getproxypeername</a>(self)</dt><dd><tt><a href="#socksocket-getproxypeername">getproxypeername</a>() -> address info

467

Returns the IP and port number of the proxy.</tt></dd></dl>

468

469

<dl><dt><a name="socksocket-getproxysockname">getproxysockname</a>(self)</dt><dd><tt><a href="#socksocket-getsockname">getsockname</a>() -> address info

470

Returns the bound IP address and port number at the proxy.</tt></dd></dl>

471

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

472

<dl><dt><a name="socksocket-sendall">sendall</a>(self, content, *args)</dt><dd><tt>override socket.socket.sendall method to rewrite the header

473

for non-tunneling proxies if needed</tt></dd></dl>

474

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

475

<dl><dt><a name="socksocket-setproxy">setproxy</a>(self, proxytype=None, addr=None, port=None, rdns=True, username=None, password=None)</dt><dd><tt><a href="#socksocket-setproxy">setproxy</a>(proxytype, addr[, port[, rdns[, username[, password]]]])

476

Sets the proxy to be used.

477

proxytype -    The type of the proxy to be used. Three types

478

are supported: PROXY_TYPE_SOCKS4 (including socks4a),

479

PROXY_TYPE_SOCKS5 and PROXY_TYPE_HTTP

480

addr -        The address of the server (IP or DNS).

481

port -        The port of the server. Defaults to 1080 for SOCKS

482

servers and 8080 for HTTP proxy servers.

483

rdns -        Should DNS queries be preformed on the remote side

484

(rather than the local side). The default is True.

485

Note: This has no effect with SOCKS4 servers.

486

username -    Username to authenticate with to the server.

487

The default is no authentication.

488

password -    Password to authenticate with to the server.

489

Only relevant when username is also provided.</tt></dd></dl>

490

491

<hr>

492

Data descriptors defined here:

493

494

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

495

</dl>

496

<hr>

497

Methods inherited from <a href="socket.html#_socketobject">socket._socketobject</a>:

498

<dl><dt><a name="socksocket-accept">accept</a>(self)</dt><dd><tt><a href="#socksocket-accept">accept</a>() -> (socket object, address info)

499

500

Wait for an incoming connection.  Return a new socket representing the

501

connection, and the address of the client.  For IP sockets, the address

502

info is a pair (hostaddr, port).</tt></dd></dl>

503

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

504

<dl><dt><a name="socksocket-bind">bind</a>(...)</dt><dd><tt><a href="#socksocket-bind">bind</a>(address)

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

505

506

Bind the socket to a local address.  For IP sockets, the address is a

507

pair (host, port); the host must refer to the local host. For raw packet

508

sockets the address is a tuple (ifname, proto [,pkttype [,hatype]])</tt></dd></dl>

509

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

510

<dl><dt><a name="socksocket-close">close</a>(self, _closedsocket=<class 'socket._closedsocket'>, _delegate_methods=('recv', 'recvfrom', 'recv_into', 'recvfrom_into', 'send', 'sendto'), setattr=<built-in function setattr>)</dt><dd><tt><a href="#socksocket-close">close</a>()

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

511

512

Close the socket.  It cannot be used after this call.</tt></dd></dl>

513

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

514

<dl><dt><a name="socksocket-connect_ex">connect_ex</a>(...)</dt><dd><tt><a href="#socksocket-connect_ex">connect_ex</a>(address) -> errno

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

515

516

This is like <a href="#socksocket-connect">connect</a>(address), but returns an error code (the errno value)

517

instead of raising an exception when an error occurs.</tt></dd></dl>

518

519

<dl><dt><a name="socksocket-dup">dup</a>(self)</dt><dd><tt><a href="#socksocket-dup">dup</a>() -> socket object

520

521

Return a new socket object connected to the same system resource.</tt></dd></dl>

522

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

523

<dl><dt><a name="socksocket-fileno">fileno</a>(...)</dt><dd><tt><a href="#socksocket-fileno">fileno</a>() -> integer

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

524

525

Return the integer file descriptor of the socket.</tt></dd></dl>

526

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

527

<dl><dt><a name="socksocket-getsockname">getsockname</a>(...)</dt><dd><tt><a href="#socksocket-getsockname">getsockname</a>() -> address info

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

528

529

Return the address of the local endpoint.  For IP sockets, the address

530

info is a pair (hostaddr, port).</tt></dd></dl>

531

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

532

<dl><dt><a name="socksocket-getsockopt">getsockopt</a>(...)</dt><dd><tt><a href="#socksocket-getsockopt">getsockopt</a>(level, option[, buffersize]) -> value

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

533

534

Get a socket option.  See the Unix manual for level and option.

535

If a nonzero buffersize argument is given, the return value is a

536

string of that length; otherwise it is an integer.</tt></dd></dl>

537

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

538

<dl><dt><a name="socksocket-gettimeout">gettimeout</a>(...)</dt><dd><tt><a href="#socksocket-gettimeout">gettimeout</a>() -> timeout

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

539

540

Returns the timeout in floating seconds associated with socket

541

operations. A timeout of None indicates that timeouts on socket

542

operations are disabled.</tt></dd></dl>

543

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

544

<dl><dt><a name="socksocket-listen">listen</a>(...)</dt><dd><tt><a href="#socksocket-listen">listen</a>(backlog)

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

545

546

Enable a server to accept connections.  The backlog argument must be at

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

547

least 0 (if it is lower, it is set to 0); it specifies the number of

548

unaccepted connections that the system will allow before refusing new

549

connections.</tt></dd></dl>

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

550

551

<dl><dt><a name="socksocket-makefile">makefile</a>(self, mode='r', bufsize=-1)</dt><dd><tt><a href="#socksocket-makefile">makefile</a>([mode[, bufsize]]) -> file object

552

553

Return a regular file object corresponding to the socket.  The mode

554

and bufsize arguments are as for the built-in open() function.</tt></dd></dl>

555

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

556

<dl><dt><a name="socksocket-setblocking">setblocking</a>(...)</dt><dd><tt><a href="#socksocket-setblocking">setblocking</a>(flag)

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

557

558

Set the socket to blocking (flag is true) or non-blocking (false).

559

<a href="#socksocket-setblocking">setblocking</a>(True) is equivalent to <a href="#socksocket-settimeout">settimeout</a>(None);

560

<a href="#socksocket-setblocking">setblocking</a>(False) is equivalent to <a href="#socksocket-settimeout">settimeout</a>(0.0).</tt></dd></dl>

561

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

562

<dl><dt><a name="socksocket-setsockopt">setsockopt</a>(...)</dt><dd><tt><a href="#socksocket-setsockopt">setsockopt</a>(level, option, value)

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

563

564

Set a socket option.  See the Unix manual for level and option.

565

The value argument can either be an integer or a string.</tt></dd></dl>

566

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

567

<dl><dt><a name="socksocket-settimeout">settimeout</a>(...)</dt><dd><tt><a href="#socksocket-settimeout">settimeout</a>(timeout)

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

568

569

Set a timeout on socket operations.  'timeout' can be a float,

570

giving in seconds, or None.  Setting a timeout of None disables

571

the timeout feature and is equivalent to <a href="#socksocket-setblocking">setblocking</a>(1).

572

Setting a timeout of zero is the same as <a href="#socksocket-setblocking">setblocking</a>(0).</tt></dd></dl>

573

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

574

<dl><dt><a name="socksocket-shutdown">shutdown</a>(...)</dt><dd><tt><a href="#socksocket-shutdown">shutdown</a>(flag)

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

575

576

Shut down the reading side of the socket (flag == SHUT_RD), the writing side

577

of the socket (flag == SHUT_WR), or both ends (flag == SHUT_RDWR).</tt></dd></dl>

578

579

<hr>

580

Data descriptors inherited from <a href="socket.html#_socketobject">socket._socketobject</a>:

581

<dl><dt>__weakref__</dt>

582

<dd><tt>list of weak references to the object (if defined)</tt></dd>

583

</dl>

584

<dl><dt>family</dt>

585

<dd><tt>the socket family</tt></dd>

586

</dl>

587

<dl><dt>proto</dt>

588

<dd><tt>the socket protocol</tt></dd>

</dl>

</dl>

</dl>

<dl><dt>recvfrom</dt>

595

</dl>

596

<dl><dt>recvfrom_into</dt>

</dl>

</dl>

<dl><dt>sendto</dt>

</dl>

<dd><tt>the socket type</tt></dd>

604

</dl>

605

</td></tr></table></td></tr></table>

<big>Functions</big></td></tr>

610

611

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

612

<td width="100%"><dl><dt><a name="-setdefaultproxy">setdefaultproxy</a>(proxytype=None, addr=None, port=None, rdns=True, username=None, password=None)</dt><dd><tt><a href="#-setdefaultproxy">setdefaultproxy</a>(proxytype, addr[, port[, rdns[, username[, password]]]])

Joe Gregorio

2011-02-20 01:42:07 -0500

[diff] [blame]

613

Sets a default proxy which all further <a href="#socksocket">socksocket</a> objects will use,

614

unless explicitly changed.</tt></dd></dl>

Joe Gregorio