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

48

<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="socket.html">socket</a>

49

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

50

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

51

</td><td width="25%" valign=top></td></tr></table></td></tr></table>

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

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

60

</dt><dd>

61

<dl>

62

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

63

</dt><dd>

64

<dl>

65

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

66

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

67

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

68

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

69

</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>)

75

</dt><dd>

76

<dl>

77

<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>

86

87

88

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

89

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

90

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

91

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

92

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

93

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

94

</dl>

95

<hr>

Joe Gregorio

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

[diff] [blame]

96

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

97

<dl><dt>__weakref__</dt>

98

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

99

</dl>

100

<hr>

Joe Gregorio

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

[diff] [blame^]

101

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

102

<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>

103

104

<hr>

Joe Gregorio

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

[diff] [blame]

105

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

106

<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>

107

108

<hr>

109

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

110

<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>

111

112

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

113

114

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

115

116

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

117

118

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

119

120

<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>

125

126

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

127

Joe Gregorio

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

[diff] [blame^]

128

129

Joe Gregorio

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

[diff] [blame]

130

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

131

132

<hr>

133

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>

145

146

147

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

148

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

149

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

150

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

151

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

152

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

153

</dl>

154

<hr>

Joe Gregorio

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

[diff] [blame]

155

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

156

<dl><dt>__weakref__</dt>

157

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

158

</dl>

159

<hr>

Joe Gregorio

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

[diff] [blame^]

160

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

161

<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>

162

163

<hr>

Joe Gregorio

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

[diff] [blame]

164

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

165

<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>

166

167

<hr>

168

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

169

<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>

170

171

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

172

173

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

174

175

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

176

177

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

178

179

<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>

184

185

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

186

Joe Gregorio

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

[diff] [blame^]

187

188

Joe Gregorio

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

[diff] [blame]

189

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

190

191

<hr>

192

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>

204

205

206

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

207

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

208

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

209

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

210

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

211

</dl>

212

<hr>

Joe Gregorio

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

[diff] [blame]

213

Data descriptors defined here:

214

<dl><dt>__weakref__</dt>

215

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

216

</dl>

217

<hr>

Joe Gregorio

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

[diff] [blame^]

218

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

219

<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>

220

221

<hr>

Joe Gregorio

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

[diff] [blame]

222

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

223

<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>

224

225

<hr>

226

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

227

<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>

228

229

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

230

231

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

232

233

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

234

235

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

236

237

<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>

242

243

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

244

Joe Gregorio

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

[diff] [blame^]

245

246

Joe Gregorio

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

[diff] [blame]

247

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

248

249

<hr>

250

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>

262

263

264

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

265

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

266

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

267

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

268

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

269

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

270

</dl>

271

<hr>

Joe Gregorio

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

[diff] [blame]

272

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

273

<dl><dt>__weakref__</dt>

274

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

275

</dl>

276

<hr>

Joe Gregorio

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

[diff] [blame^]

277

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

278

<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>

279

280

<hr>

Joe Gregorio

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

[diff] [blame]

281

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

282

<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>

283

284

<hr>

285

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

286

<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>

287

288

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

289

290

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

291

292

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

293

294

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

295

296

<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>

301

302

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

303

Joe Gregorio

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

[diff] [blame^]

304

305

Joe Gregorio

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

[diff] [blame]

306

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

307

308

<hr>

309

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>

321

322

323

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

324

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

325

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

326

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

327

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

328

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

329

</dl>

330

<hr>

Joe Gregorio

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

[diff] [blame]

331

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

332

<dl><dt>__weakref__</dt>

333

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

334

</dl>

335

<hr>

Joe Gregorio

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

[diff] [blame^]

336

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

337

<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>

338

339

<hr>

Joe Gregorio

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

[diff] [blame]

340

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

341

<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>

342

343

<hr>

344

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

345

<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>

346

347

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

348

349

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

350

351

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

352

353

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

354

355

<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>

360

361

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

362

Joe Gregorio

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

[diff] [blame^]

363

364

Joe Gregorio

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

[diff] [blame]

365

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

366

367

<hr>

368

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>

380

381

382

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

383

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

384

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

385

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

386

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

387

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

388

</dl>

389

<hr>

Joe Gregorio

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

[diff] [blame]

390

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

391

<dl><dt>__weakref__</dt>

392

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

393

</dl>

394

<hr>

Joe Gregorio

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

[diff] [blame^]

395

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

396

<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>

397

398

<hr>

Joe Gregorio

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

[diff] [blame]

399

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

400

<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>

401

402

<hr>

403

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

404

<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>

405

406

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

407

408

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

409

410

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

411

412

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

413

414

<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>

419

420

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

421

Joe Gregorio

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

[diff] [blame^]

422

423

Joe Gregorio

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

[diff] [blame]

424

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

425

426

<hr>

427

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>

439

440

441

<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]

442

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

443

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

444

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

445

446

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

447

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

448

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

449

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

450

</dl>

451

<hr>

452

Methods defined here:

453

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

454

Joe Gregorio

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

[diff] [blame^]

455

<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]

456

Connects to the specified destination through a proxy.

457

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

458

(identical to socket's connect).

459

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

460

461

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

462

Returns the IP address and port number of the destination

463

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

464

465

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

466

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

467

468

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

469

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

470

Joe Gregorio

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

[diff] [blame]

471

<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]]]])

472

Sets the proxy to be used.

473

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

474

are supported: PROXY_TYPE_SOCKS4 (including socks4a),

475

PROXY_TYPE_SOCKS5 and PROXY_TYPE_HTTP

476

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

477

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

478

servers and 8080 for HTTP proxy servers.

479

rdns -        Should DNS queries be preformed on the remote side

480

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

481

Note: This has no effect with SOCKS4 servers.

482

username -    Username to authenticate with to the server.

483

The default is no authentication.

484

password -    Password to authenticate with to the server.

485

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

486

487

<hr>

488

Data descriptors defined here:

489

490

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

491

</dl>

492

<hr>

493

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

494

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

495

496

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

497

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

498

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

499

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

500

<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]

501

502

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

503

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

504

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

505

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

506

<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]

507

508

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

509

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

510

<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]

511

512

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

513

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

514

515

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

516

517

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

518

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

519

<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]

520

521

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

522

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

523

<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]

524

525

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

526

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

527

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

528

<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]

529

530

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

531

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

532

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

533

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

534

<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]

535

536

Returns the timeout in floating seconds associated with socket

537

operations. A timeout of None indicates that timeouts on socket

538

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

539

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

540

<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]

541

542

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

543

least 1; it specifies the number of unaccepted connection that the system

544

will allow before refusing new connections.</tt></dd></dl>

545

546

<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

547

548

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

549

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

550

Joe Gregorio

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

[diff] [blame^]

551

<dl><dt><a name="socksocket-sendall">sendall</a>(...)</dt><dd><tt><a href="#socksocket-sendall">sendall</a>(data[, flags])

552

553

Send a data string to the socket.  For the optional flags

554

argument, see the Unix manual.  This calls <a href="#socksocket-send">send</a>() repeatedly

555

until all data is sent.  If an error occurs, it's impossible

556

to tell how much data has been sent.</tt></dd></dl>

557

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

558

<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]

559

560

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

561

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

562

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

563

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

564

<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]

565

566

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

567

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

568

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

569

<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]

570

571

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

572

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

573

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

574

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

575

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

576

<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]

577

578

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

579

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

580

581

<hr>

582

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

583

<dl><dt>__weakref__</dt>

584

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

585

</dl>

586

<dl><dt>family</dt>

587

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

588

</dl>

589

<dl><dt>proto</dt>

590

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

</dl>

</dl>

</dl>

<dl><dt>recvfrom</dt>

597

</dl>

598

<dl><dt>recvfrom_into</dt>

</dl>

</dl>

<dl><dt>sendto</dt>

</dl>

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

606

</dl>

607

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

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

612

613

Joe Gregorio

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

[diff] [blame^]

614

<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]

615

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

616

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

Joe Gregorio