| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: module httplib2.socks</title> |
| </head><body bgcolor="#f0f0f8"> |
| |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> |
| <tr bgcolor="#7799ee"> |
| <td valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="httplib2.html"><font color="#ffffff">httplib2</font></a>.socks</strong></big></big></font></td |
| ><td align=right valign=bottom |
| ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/httplib2/socks.py">/home/jcgregorio/projects/google-api-python-client/httplib2/socks.py</a></font></td></tr></table> |
| <p><tt>SocksiPy - Python SOCKS module.<br> |
| Version 1.00<br> |
| <br> |
| Copyright 2006 Dan-Haim. All rights reserved.<br> |
| <br> |
| Redistribution and use in source and binary forms, with or without<br> |
| modification, are permitted provided that the following conditions are met:<br> |
| 1. Redistributions of source code must retain the above copyright notice, this<br> |
| list of conditions and the following disclaimer.<br> |
| 2. Redistributions in binary form must reproduce the above copyright notice,<br> |
| this list of conditions and the following disclaimer in the documentation<br> |
| and/or other materials provided with the distribution.<br> |
| 3. Neither the name of Dan Haim nor the names of his contributors may be used<br> |
| to endorse or promote products derived from this software without specific<br> |
| prior written permission.<br> |
| <br> |
| THIS SOFTWARE IS PROVIDED BY DAN HAIM "AS IS" AND ANY EXPRESS OR IMPLIED<br> |
| WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF<br> |
| MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO<br> |
| EVENT SHALL DAN HAIM OR HIS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,<br> |
| INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT<br> |
| LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA<br> |
| OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF<br> |
| LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT<br> |
| OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.<br> |
| <br> |
| <br> |
| This module provides a standard socket-like interface for Python<br> |
| for tunneling connections through SOCKS proxies.</tt></p> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#aa55cc"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> |
| <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="socket.html">socket</a><br> |
| </td><td width="25%" valign=top><a href="struct.html">struct</a><br> |
| </td><td width="25%" valign=top><a href="sys.html">sys</a><br> |
| </td><td width="25%" valign=top></td></tr></table></td></tr></table><p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ee77aa"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> |
| <td width="100%"><dl> |
| <dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="httplib2.socks.html#ProxyError">ProxyError</a> |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="httplib2.socks.html#GeneralProxyError">GeneralProxyError</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="httplib2.socks.html#HTTPError">HTTPError</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="httplib2.socks.html#Socks4Error">Socks4Error</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="httplib2.socks.html#Socks5AuthError">Socks5AuthError</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="httplib2.socks.html#Socks5Error">Socks5Error</a> |
| </font></dt></dl> |
| </dd> |
| </dl> |
| </dd> |
| <dt><font face="helvetica, arial"><a href="socket.html#_socketobject">socket._socketobject</a>(<a href="__builtin__.html#object">__builtin__.object</a>) |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="httplib2.socks.html#socksocket">socksocket</a> |
| </font></dt></dl> |
| </dd> |
| </dl> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#000000" face="helvetica, arial"><a name="GeneralProxyError">class <strong>GeneralProxyError</strong></a>(<a href="httplib2.socks.html#ProxyError">ProxyError</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="httplib2.socks.html#GeneralProxyError">GeneralProxyError</a></dd> |
| <dd><a href="httplib2.socks.html#ProxyError">ProxyError</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Methods defined here:<br> |
| <dl><dt><a name="GeneralProxyError-__init__"><strong>__init__</strong></a>(self, value)</dt></dl> |
| |
| <dl><dt><a name="GeneralProxyError-__str__"><strong>__str__</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="httplib2.socks.html#ProxyError">ProxyError</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <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> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="GeneralProxyError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#GeneralProxyError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="GeneralProxyError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#GeneralProxyError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="GeneralProxyError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#GeneralProxyError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="GeneralProxyError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#GeneralProxyError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="GeneralProxyError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="GeneralProxyError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#GeneralProxyError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="GeneralProxyError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#GeneralProxyError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="GeneralProxyError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="GeneralProxyError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#000000" face="helvetica, arial"><a name="HTTPError">class <strong>HTTPError</strong></a>(<a href="httplib2.socks.html#ProxyError">ProxyError</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="httplib2.socks.html#HTTPError">HTTPError</a></dd> |
| <dd><a href="httplib2.socks.html#ProxyError">ProxyError</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Methods defined here:<br> |
| <dl><dt><a name="HTTPError-__init__"><strong>__init__</strong></a>(self, value)</dt></dl> |
| |
| <dl><dt><a name="HTTPError-__str__"><strong>__str__</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="httplib2.socks.html#ProxyError">ProxyError</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <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> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="HTTPError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#HTTPError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="HTTPError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#HTTPError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="HTTPError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#HTTPError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="HTTPError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#HTTPError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="HTTPError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="HTTPError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#HTTPError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="HTTPError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#HTTPError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="HTTPError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="HTTPError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#000000" face="helvetica, arial"><a name="ProxyError">class <strong>ProxyError</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="httplib2.socks.html#ProxyError">ProxyError</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Methods defined here:<br> |
| <dl><dt><a name="ProxyError-__init__"><strong>__init__</strong></a>(self, value)</dt></dl> |
| |
| <dl><dt><a name="ProxyError-__str__"><strong>__str__</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Data descriptors defined here:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <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> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="ProxyError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ProxyError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="ProxyError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#ProxyError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="ProxyError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#ProxyError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="ProxyError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#ProxyError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="ProxyError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="ProxyError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#ProxyError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="ProxyError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ProxyError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="ProxyError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="ProxyError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#000000" face="helvetica, arial"><a name="Socks4Error">class <strong>Socks4Error</strong></a>(<a href="httplib2.socks.html#ProxyError">ProxyError</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="httplib2.socks.html#Socks4Error">Socks4Error</a></dd> |
| <dd><a href="httplib2.socks.html#ProxyError">ProxyError</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Methods defined here:<br> |
| <dl><dt><a name="Socks4Error-__init__"><strong>__init__</strong></a>(self, value)</dt></dl> |
| |
| <dl><dt><a name="Socks4Error-__str__"><strong>__str__</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="httplib2.socks.html#ProxyError">ProxyError</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <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> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="Socks4Error-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks4Error-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="Socks4Error-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks4Error-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="Socks4Error-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks4Error-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="Socks4Error-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks4Error-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="Socks4Error-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="Socks4Error-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks4Error-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="Socks4Error-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks4Error-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="Socks4Error-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="Socks4Error-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#000000" face="helvetica, arial"><a name="Socks5AuthError">class <strong>Socks5AuthError</strong></a>(<a href="httplib2.socks.html#ProxyError">ProxyError</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="httplib2.socks.html#Socks5AuthError">Socks5AuthError</a></dd> |
| <dd><a href="httplib2.socks.html#ProxyError">ProxyError</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Methods defined here:<br> |
| <dl><dt><a name="Socks5AuthError-__init__"><strong>__init__</strong></a>(self, value)</dt></dl> |
| |
| <dl><dt><a name="Socks5AuthError-__str__"><strong>__str__</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="httplib2.socks.html#ProxyError">ProxyError</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <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> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="Socks5AuthError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks5AuthError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="Socks5AuthError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks5AuthError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="Socks5AuthError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks5AuthError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="Socks5AuthError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks5AuthError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="Socks5AuthError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="Socks5AuthError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks5AuthError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="Socks5AuthError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks5AuthError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="Socks5AuthError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="Socks5AuthError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#000000" face="helvetica, arial"><a name="Socks5Error">class <strong>Socks5Error</strong></a>(<a href="httplib2.socks.html#ProxyError">ProxyError</a>)</font></td></tr> |
| |
| <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="httplib2.socks.html#Socks5Error">Socks5Error</a></dd> |
| <dd><a href="httplib2.socks.html#ProxyError">ProxyError</a></dd> |
| <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> |
| <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Methods defined here:<br> |
| <dl><dt><a name="Socks5Error-__init__"><strong>__init__</strong></a>(self, value)</dt></dl> |
| |
| <dl><dt><a name="Socks5Error-__str__"><strong>__str__</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="httplib2.socks.html#ProxyError">ProxyError</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> |
| <dl><dt><strong>__new__</strong> = <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> |
| |
| <hr> |
| Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><a name="Socks5Error-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks5Error-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> |
| |
| <dl><dt><a name="Socks5Error-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks5Error-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> |
| |
| <dl><dt><a name="Socks5Error-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks5Error-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> |
| |
| <dl><dt><a name="Socks5Error-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks5Error-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> |
| <br> |
| Use of negative indices is not supported.</tt></dd></dl> |
| |
| <dl><dt><a name="Socks5Error-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="Socks5Error-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks5Error-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> |
| |
| <dl><dt><a name="Socks5Error-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks5Error-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> |
| |
| <dl><dt><a name="Socks5Error-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> |
| |
| <dl><dt><a name="Socks5Error-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| </dl> |
| <dl><dt><strong>args</strong></dt> |
| </dl> |
| <dl><dt><strong>message</strong></dt> |
| </dl> |
| </td></tr></table> <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#000000" face="helvetica, arial"><a name="socksocket">class <strong>socksocket</strong></a>(<a href="socket.html#_socketobject">socket._socketobject</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt><a href="#socksocket">socksocket</a>([family[, type[, proto]]]) -> socket object<br> |
| <br> |
| Open a SOCKS enabled socket. The parameters are the same as<br> |
| those of the standard socket init. In order for SOCKS to work,<br> |
| you must specify family=AF_INET, type=SOCK_STREAM and proto=0.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="httplib2.socks.html#socksocket">socksocket</a></dd> |
| <dd><a href="socket.html#_socketobject">socket._socketobject</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Methods defined here:<br> |
| <dl><dt><a name="socksocket-__init__"><strong>__init__</strong></a>(self, family<font color="#909090">=2</font>, type<font color="#909090">=1</font>, proto<font color="#909090">=0</font>, _sock<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="socksocket-connect"><strong>connect</strong></a>(self, destpair)</dt><dd><tt><a href="#socksocket-connect">connect</a>(self,despair)<br> |
| Connects to the specified destination through a proxy.<br> |
| destpar - A tuple of the IP/DNS address and the port number.<br> |
| (identical to socket's connect).<br> |
| To select the proxy server use <a href="#socksocket-setproxy">setproxy</a>().</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-getpeername"><strong>getpeername</strong></a>(self)</dt><dd><tt><a href="#socksocket-getpeername">getpeername</a>() -> address info<br> |
| Returns the IP address and port number of the destination<br> |
| machine (note: getproxypeername returns the proxy)</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-getproxypeername"><strong>getproxypeername</strong></a>(self)</dt><dd><tt><a href="#socksocket-getproxypeername">getproxypeername</a>() -> address info<br> |
| Returns the IP and port number of the proxy.</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-getproxysockname"><strong>getproxysockname</strong></a>(self)</dt><dd><tt><a href="#socksocket-getsockname">getsockname</a>() -> address info<br> |
| Returns the bound IP address and port number at the proxy.</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-sendall"><strong>sendall</strong></a>(self, bytes)</dt></dl> |
| |
| <dl><dt><a name="socksocket-setproxy"><strong>setproxy</strong></a>(self, proxytype<font color="#909090">=None</font>, addr<font color="#909090">=None</font>, port<font color="#909090">=None</font>, rdns<font color="#909090">=True</font>, username<font color="#909090">=None</font>, password<font color="#909090">=None</font>)</dt><dd><tt><a href="#socksocket-setproxy">setproxy</a>(proxytype, addr[, port[, rdns[, username[, password]]]])<br> |
| Sets the proxy to be used.<br> |
| proxytype - The type of the proxy to be used. Three types<br> |
| are supported: PROXY_TYPE_SOCKS4 (including socks4a),<br> |
| PROXY_TYPE_SOCKS5 and PROXY_TYPE_HTTP<br> |
| addr - The address of the server (IP or DNS).<br> |
| port - The port of the server. Defaults to 1080 for SOCKS<br> |
| servers and 8080 for HTTP proxy servers.<br> |
| rdns - Should DNS queries be preformed on the remote side<br> |
| (rather than the local side). The default is True.<br> |
| Note: This has no effect with SOCKS4 servers.<br> |
| username - Username to authenticate with to the server.<br> |
| The default is no authentication.<br> |
| password - Password to authenticate with to the server.<br> |
| Only relevant when username is also provided.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors defined here:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="socket.html#_socketobject">socket._socketobject</a>:<br> |
| <dl><dt><a name="socksocket-accept"><strong>accept</strong></a>(self)</dt><dd><tt><a href="#socksocket-accept">accept</a>() -> (socket object, address info)<br> |
| <br> |
| Wait for an incoming connection. Return a new socket representing the<br> |
| connection, and the address of the client. For IP sockets, the address<br> |
| info is a pair (hostaddr, port).</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-bind"><strong>bind</strong></a>(...)</dt><dd><tt><a href="#socksocket-bind">bind</a>(address)<br> |
| <br> |
| Bind the socket to a local address. For IP sockets, the address is a<br> |
| pair (host, port); the host must refer to the local host. For raw packet<br> |
| sockets the address is a tuple (ifname, proto [,pkttype [,hatype]])</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-close"><strong>close</strong></a>(self, _closedsocket<font color="#909090">=<class 'socket._closedsocket'></font>, _delegate_methods<font color="#909090">=('recv', 'recvfrom', 'recv_into', 'recvfrom_into', 'send', 'sendto')</font>, setattr<font color="#909090">=<built-in function setattr></font>)</dt><dd><tt><a href="#socksocket-close">close</a>()<br> |
| <br> |
| Close the socket. It cannot be used after this call.</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-connect_ex"><strong>connect_ex</strong></a>(...)</dt><dd><tt><a href="#socksocket-connect_ex">connect_ex</a>(address) -> errno<br> |
| <br> |
| This is like <a href="#socksocket-connect">connect</a>(address), but returns an error code (the errno value)<br> |
| instead of raising an exception when an error occurs.</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-dup"><strong>dup</strong></a>(self)</dt><dd><tt><a href="#socksocket-dup">dup</a>() -> socket object<br> |
| <br> |
| Return a new socket object connected to the same system resource.</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-fileno"><strong>fileno</strong></a>(...)</dt><dd><tt><a href="#socksocket-fileno">fileno</a>() -> integer<br> |
| <br> |
| Return the integer file descriptor of the socket.</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-getsockname"><strong>getsockname</strong></a>(...)</dt><dd><tt><a href="#socksocket-getsockname">getsockname</a>() -> address info<br> |
| <br> |
| Return the address of the local endpoint. For IP sockets, the address<br> |
| info is a pair (hostaddr, port).</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-getsockopt"><strong>getsockopt</strong></a>(...)</dt><dd><tt><a href="#socksocket-getsockopt">getsockopt</a>(level, option[, buffersize]) -> value<br> |
| <br> |
| Get a socket option. See the Unix manual for level and option.<br> |
| If a nonzero buffersize argument is given, the return value is a<br> |
| string of that length; otherwise it is an integer.</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-gettimeout"><strong>gettimeout</strong></a>(...)</dt><dd><tt><a href="#socksocket-gettimeout">gettimeout</a>() -> timeout<br> |
| <br> |
| Returns the timeout in floating seconds associated with socket <br> |
| operations. A timeout of None indicates that timeouts on socket <br> |
| operations are disabled.</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-listen"><strong>listen</strong></a>(...)</dt><dd><tt><a href="#socksocket-listen">listen</a>(backlog)<br> |
| <br> |
| Enable a server to accept connections. The backlog argument must be at<br> |
| least 1; it specifies the number of unaccepted connection that the system<br> |
| will allow before refusing new connections.</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-makefile"><strong>makefile</strong></a>(self, mode<font color="#909090">='r'</font>, bufsize<font color="#909090">=-1</font>)</dt><dd><tt><a href="#socksocket-makefile">makefile</a>([mode[, bufsize]]) -> file object<br> |
| <br> |
| Return a regular file object corresponding to the socket. The mode<br> |
| and bufsize arguments are as for the built-in open() function.</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-setblocking"><strong>setblocking</strong></a>(...)</dt><dd><tt><a href="#socksocket-setblocking">setblocking</a>(flag)<br> |
| <br> |
| Set the socket to blocking (flag is true) or non-blocking (false).<br> |
| <a href="#socksocket-setblocking">setblocking</a>(True) is equivalent to <a href="#socksocket-settimeout">settimeout</a>(None);<br> |
| <a href="#socksocket-setblocking">setblocking</a>(False) is equivalent to <a href="#socksocket-settimeout">settimeout</a>(0.0).</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-setsockopt"><strong>setsockopt</strong></a>(...)</dt><dd><tt><a href="#socksocket-setsockopt">setsockopt</a>(level, option, value)<br> |
| <br> |
| Set a socket option. See the Unix manual for level and option.<br> |
| The value argument can either be an integer or a string.</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-settimeout"><strong>settimeout</strong></a>(...)</dt><dd><tt><a href="#socksocket-settimeout">settimeout</a>(timeout)<br> |
| <br> |
| Set a timeout on socket operations. 'timeout' can be a float,<br> |
| giving in seconds, or None. Setting a timeout of None disables<br> |
| the timeout feature and is equivalent to <a href="#socksocket-setblocking">setblocking</a>(1).<br> |
| Setting a timeout of zero is the same as <a href="#socksocket-setblocking">setblocking</a>(0).</tt></dd></dl> |
| |
| <dl><dt><a name="socksocket-shutdown"><strong>shutdown</strong></a>(...)</dt><dd><tt><a href="#socksocket-shutdown">shutdown</a>(flag)<br> |
| <br> |
| Shut down the reading side of the socket (flag == SHUT_RD), the writing side<br> |
| of the socket (flag == SHUT_WR), or both ends (flag == SHUT_RDWR).</tt></dd></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="socket.html#_socketobject">socket._socketobject</a>:<br> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <dl><dt><strong>family</strong></dt> |
| <dd><tt>the socket family</tt></dd> |
| </dl> |
| <dl><dt><strong>proto</strong></dt> |
| <dd><tt>the socket protocol</tt></dd> |
| </dl> |
| <dl><dt><strong>recv</strong></dt> |
| </dl> |
| <dl><dt><strong>recv_into</strong></dt> |
| </dl> |
| <dl><dt><strong>recvfrom</strong></dt> |
| </dl> |
| <dl><dt><strong>recvfrom_into</strong></dt> |
| </dl> |
| <dl><dt><strong>send</strong></dt> |
| </dl> |
| <dl><dt><strong>sendto</strong></dt> |
| </dl> |
| <dl><dt><strong>type</strong></dt> |
| <dd><tt>the socket type</tt></dd> |
| </dl> |
| </td></tr></table></td></tr></table><p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#eeaa77"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt><a name="-bytes"><strong>bytes</strong></a>(obj, enc<font color="#909090">=None</font>)</dt></dl> |
| <dl><dt><a name="-setdefaultproxy"><strong>setdefaultproxy</strong></a>(proxytype<font color="#909090">=None</font>, addr<font color="#909090">=None</font>, port<font color="#909090">=None</font>, rdns<font color="#909090">=True</font>, username<font color="#909090">=None</font>, password<font color="#909090">=None</font>)</dt><dd><tt><a href="#-setdefaultproxy">setdefaultproxy</a>(proxytype, addr[, port[, rdns[, username[, password]]]])<br> |
| Sets a default proxy which all further <a href="#socksocket">socksocket</a> objects will use,<br> |
| unless explicitly changed.</tt></dd></dl> |
| </td></tr></table><p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#55aa55"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> |
| <td width="100%"><strong>PROXY_TYPE_HTTP</strong> = 3<br> |
| <strong>PROXY_TYPE_SOCKS4</strong> = 1<br> |
| <strong>PROXY_TYPE_SOCKS5</strong> = 2</td></tr></table> |
| </body></html> |