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

><a href=".">index</a> <a href="file:/home/jcgregorio/projects/google-api-python-client/httplib2/socks.py">/home/jcgregorio/projects/google-api-python-client/httplib2/socks.py</a></td></tr></table>

Joe Gregorio

55d5818

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

17

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

18

modification, are permitted provided that the following conditions are met:

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.

27

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

36

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

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>

96

Methods defined here:

97

<dl><dt><a name="GeneralProxyError-__init__">__init__</a>(self, value)</dt></dl>

<hr>

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

103

<dl><dt>__weakref__</dt>

104

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

105

</dl>

106

<hr>

107

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

108

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

109

110

<hr>

111

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

112

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

113

114

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

115

116

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

117

118

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

119

120

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

121

122

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

127

128

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

129

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>

155

Methods defined here:

156

<dl><dt><a name="HTTPError-__init__">__init__</a>(self, value)</dt></dl>

<hr>

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

162

<dl><dt>__weakref__</dt>

163

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

164

</dl>

165

<hr>

166

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

167

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

168

169

<hr>

170

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

171

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

172

173

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

174

175

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

176

177

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

178

179

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

180

181

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

186

187

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

188

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>

213

Methods defined here:

214

<dl><dt><a name="ProxyError-__init__">__init__</a>(self, value)</dt></dl>

<hr>

Data descriptors defined here:

220

<dl><dt>__weakref__</dt>

221

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

222

</dl>

223

<hr>

224

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

225

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

226

227

<hr>

228

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

229

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

230

231

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

232

233

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

234

235

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

236

237

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

238

239

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

244

245

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

246

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>

272

Methods defined here:

273

<dl><dt><a name="Socks4Error-__init__">__init__</a>(self, value)</dt></dl>

<hr>

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

279

<dl><dt>__weakref__</dt>

280

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

281

</dl>

282

<hr>

283

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

284

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

285

286

<hr>

287

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

288

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

289

290

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

291

292

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

293

294

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

295

296

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

297

298

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

303

304

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

305

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>

331

Methods defined here:

332

<dl><dt><a name="Socks5AuthError-__init__">__init__</a>(self, value)</dt></dl>

<hr>

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

338

<dl><dt>__weakref__</dt>

339

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

340

</dl>

341

<hr>

342

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

343

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

344

345

<hr>

346

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

347

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

348

349

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

350

351

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

352

353

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

354

355

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

356

357

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

362

363

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

364

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>

390

Methods defined here:

391

<dl><dt><a name="Socks5Error-__init__">__init__</a>(self, value)</dt></dl>

<hr>

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

397

<dl><dt>__weakref__</dt>

398

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

399

</dl>

400

<hr>

401

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

402

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

403

404

<hr>

405

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

406

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

407

408

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

409

410

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

411

412

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

413

414

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

415

416

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

421

422

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

423

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

442

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

456

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

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

472

<dl><dt><a name="socksocket-sendall">sendall</a>(self, bytes)</dt></dl>

473

474

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

475

Sets the proxy to be used.

476

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

477

are supported: PROXY_TYPE_SOCKS4 (including socks4a),

478

PROXY_TYPE_SOCKS5 and PROXY_TYPE_HTTP

479

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

480

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

481

servers and 8080 for HTTP proxy servers.

482

rdns -        Should DNS queries be preformed on the remote side

483

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

484

Note: This has no effect with SOCKS4 servers.

485

username -    Username to authenticate with to the server.

486

The default is no authentication.

487

password -    Password to authenticate with to the server.

488

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

489

490

<hr>

491

Data descriptors defined here:

492

493

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

494

</dl>

495

<hr>

496

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

497

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

498

499

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

500

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

501

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

502

Joe Gregorio

4258d6b

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

[diff] [blame]

503

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

Joe Gregorio

55d5818

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

[diff] [blame]

504

505

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

506

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

507

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

508

Joe Gregorio

4258d6b

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

[diff] [blame]

509

<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

55d5818

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

[diff] [blame]

510

511

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

512

Joe Gregorio

4258d6b

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

[diff] [blame]

513

<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

55d5818

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

[diff] [blame]

514

515

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

516

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

517

518

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

519

520

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

521

Joe Gregorio

4258d6b

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

[diff] [blame]

522

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

Joe Gregorio

55d5818

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

[diff] [blame]

523

524

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

525

Joe Gregorio

4258d6b

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

[diff] [blame]

526

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

Joe Gregorio

55d5818

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

[diff] [blame]

527

528

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

529

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

530

Joe Gregorio

4258d6b

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

[diff] [blame]

531

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

Joe Gregorio

55d5818

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

[diff] [blame]

532

533

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

534

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

535

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

536

Joe Gregorio

4258d6b

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

[diff] [blame]

537

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

Joe Gregorio

55d5818

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

[diff] [blame]

538

539

Returns the timeout in floating seconds associated with socket

540

operations. A timeout of None indicates that timeouts on socket

541

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

542

Joe Gregorio

4258d6b

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

[diff] [blame]

543

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

Joe Gregorio

55d5818

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

[diff] [blame]

544

545

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

546

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

547

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

548

549

<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

550

551

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

552

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

553

Joe Gregorio

4258d6b

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

[diff] [blame]

554

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

Joe Gregorio

55d5818

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

[diff] [blame]

555

556

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

557

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

558

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

559

Joe Gregorio

4258d6b

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

[diff] [blame]

560

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

Joe Gregorio

55d5818

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

[diff] [blame]

561

562

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

563

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

564

Joe Gregorio

4258d6b

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

[diff] [blame]

565

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

Joe Gregorio

55d5818

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

[diff] [blame]

566

567

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

568

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

569

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

570

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

571

Joe Gregorio

4258d6b

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

[diff] [blame]

572

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

Joe Gregorio

55d5818

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

[diff] [blame]

573

574

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

575

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

576

577

<hr>

578

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

579

<dl><dt>__weakref__</dt>

580

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

581

</dl>

582

<dl><dt>family</dt>

583

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

584

</dl>

585

<dl><dt>proto</dt>

586

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

</dl>

</dl>

</dl>

<dl><dt>recvfrom</dt>

593

</dl>

594

<dl><dt>recvfrom_into</dt>

</dl>

</dl>

<dl><dt>sendto</dt>

</dl>

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

602

</dl>

603

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

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

608

609

610

<td width="100%"><dl><dt><a name="-bytes">bytes</a>(obj, enc=None)</dt></dl>

611

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

612

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

613

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

614

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

615