PageRenderTime 98ms CodeModel.GetById 41ms RepoModel.GetById 0ms app.codeStats 1ms

/socket.html

https://bitbucket.org/lbesson/mpri-bomberman
HTML | 1079 lines | 981 code | 98 blank | 0 comment | 0 complexity | 4c0d84cdabd49cf9f8982a3cf1d2c4ef MD5 | raw file
Possible License(s): GPL-3.0
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  2. <html><head><title>Python: module socket</title>
  3. </head><body bgcolor="#f0f0f8">
  4. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
  5. <tr bgcolor="#7799ee">
  6. <td valign=bottom>&nbsp;<br>
  7. <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>socket</strong></big></big></font></td
  8. ><td align=right valign=bottom
  9. ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/lib/python2.7/socket.py">/usr/lib/python2.7/socket.py</a><br><a href="http://docs.python.org/library/socket">Module Docs</a></font></td></tr></table>
  10. <p><tt>This&nbsp;module&nbsp;provides&nbsp;<a href="#socket">socket</a>&nbsp;operations&nbsp;and&nbsp;some&nbsp;related&nbsp;functions.<br>
  11. On&nbsp;Unix,&nbsp;it&nbsp;supports&nbsp;IP&nbsp;(Internet&nbsp;Protocol)&nbsp;and&nbsp;Unix&nbsp;domain&nbsp;sockets.<br>
  12. On&nbsp;other&nbsp;systems,&nbsp;it&nbsp;only&nbsp;supports&nbsp;IP.&nbsp;Functions&nbsp;specific&nbsp;for&nbsp;a<br>
  13. <a href="#socket">socket</a>&nbsp;are&nbsp;available&nbsp;as&nbsp;methods&nbsp;of&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a>.<br>
  14. &nbsp;<br>
  15. Functions:<br>
  16. &nbsp;<br>
  17. <a href="#socket">socket</a>()&nbsp;--&nbsp;create&nbsp;a&nbsp;new&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a><br>
  18. <a href="#-socketpair">socketpair</a>()&nbsp;--&nbsp;create&nbsp;a&nbsp;pair&nbsp;of&nbsp;new&nbsp;<a href="#socket">socket</a>&nbsp;objects&nbsp;[*]<br>
  19. <a href="#-fromfd">fromfd</a>()&nbsp;--&nbsp;create&nbsp;a&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;from&nbsp;an&nbsp;open&nbsp;file&nbsp;descriptor&nbsp;[*]<br>
  20. <a href="#-gethostname">gethostname</a>()&nbsp;--&nbsp;return&nbsp;the&nbsp;current&nbsp;hostname<br>
  21. <a href="#-gethostbyname">gethostbyname</a>()&nbsp;--&nbsp;map&nbsp;a&nbsp;hostname&nbsp;to&nbsp;its&nbsp;IP&nbsp;number<br>
  22. <a href="#-gethostbyaddr">gethostbyaddr</a>()&nbsp;--&nbsp;map&nbsp;an&nbsp;IP&nbsp;number&nbsp;or&nbsp;hostname&nbsp;to&nbsp;DNS&nbsp;info<br>
  23. <a href="#-getservbyname">getservbyname</a>()&nbsp;--&nbsp;map&nbsp;a&nbsp;service&nbsp;name&nbsp;and&nbsp;a&nbsp;protocol&nbsp;name&nbsp;to&nbsp;a&nbsp;port&nbsp;number<br>
  24. <a href="#-getprotobyname">getprotobyname</a>()&nbsp;--&nbsp;map&nbsp;a&nbsp;protocol&nbsp;name&nbsp;(e.g.&nbsp;'tcp')&nbsp;to&nbsp;a&nbsp;number<br>
  25. <a href="#-ntohs">ntohs</a>(),&nbsp;<a href="#-ntohl">ntohl</a>()&nbsp;--&nbsp;convert&nbsp;16,&nbsp;32&nbsp;bit&nbsp;int&nbsp;from&nbsp;network&nbsp;to&nbsp;host&nbsp;byte&nbsp;order<br>
  26. <a href="#-htons">htons</a>(),&nbsp;<a href="#-htonl">htonl</a>()&nbsp;--&nbsp;convert&nbsp;16,&nbsp;32&nbsp;bit&nbsp;int&nbsp;from&nbsp;host&nbsp;to&nbsp;network&nbsp;byte&nbsp;order<br>
  27. <a href="#-inet_aton">inet_aton</a>()&nbsp;--&nbsp;convert&nbsp;IP&nbsp;addr&nbsp;string&nbsp;(123.45.67.89)&nbsp;to&nbsp;32-bit&nbsp;packed&nbsp;format<br>
  28. <a href="#-inet_ntoa">inet_ntoa</a>()&nbsp;--&nbsp;convert&nbsp;32-bit&nbsp;packed&nbsp;format&nbsp;IP&nbsp;to&nbsp;string&nbsp;(123.45.67.89)<br>
  29. ssl()&nbsp;--&nbsp;secure&nbsp;<a href="#socket">socket</a>&nbsp;layer&nbsp;support&nbsp;(only&nbsp;available&nbsp;if&nbsp;configured)<br>
  30. <a href="#socket">socket</a>.<a href="#-getdefaulttimeout">getdefaulttimeout</a>()&nbsp;--&nbsp;get&nbsp;the&nbsp;default&nbsp;<a href="#timeout">timeout</a>&nbsp;value<br>
  31. <a href="#socket">socket</a>.<a href="#-setdefaulttimeout">setdefaulttimeout</a>()&nbsp;--&nbsp;set&nbsp;the&nbsp;default&nbsp;<a href="#timeout">timeout</a>&nbsp;value<br>
  32. <a href="#-create_connection">create_connection</a>()&nbsp;--&nbsp;connects&nbsp;to&nbsp;an&nbsp;address,&nbsp;with&nbsp;an&nbsp;optional&nbsp;<a href="#timeout">timeout</a>&nbsp;and<br>
  33. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;optional&nbsp;source&nbsp;address.<br>
  34. &nbsp;<br>
  35. &nbsp;[*]&nbsp;not&nbsp;available&nbsp;on&nbsp;all&nbsp;platforms!<br>
  36. &nbsp;<br>
  37. Special&nbsp;objects:<br>
  38. &nbsp;<br>
  39. <a href="#SocketType">SocketType</a>&nbsp;--&nbsp;type&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;for&nbsp;<a href="#socket">socket</a>&nbsp;objects<br>
  40. <a href="#error">error</a>&nbsp;--&nbsp;exception&nbsp;raised&nbsp;for&nbsp;I/O&nbsp;errors<br>
  41. has_ipv6&nbsp;--&nbsp;boolean&nbsp;value&nbsp;indicating&nbsp;if&nbsp;IPv6&nbsp;is&nbsp;supported<br>
  42. &nbsp;<br>
  43. Integer&nbsp;constants:<br>
  44. &nbsp;<br>
  45. AF_INET,&nbsp;AF_UNIX&nbsp;--&nbsp;<a href="#socket">socket</a>&nbsp;domains&nbsp;(first&nbsp;argument&nbsp;to&nbsp;<a href="#socket">socket</a>()&nbsp;call)<br>
  46. SOCK_STREAM,&nbsp;SOCK_DGRAM,&nbsp;SOCK_RAW&nbsp;--&nbsp;<a href="#socket">socket</a>&nbsp;types&nbsp;(second&nbsp;argument)<br>
  47. &nbsp;<br>
  48. Many&nbsp;other&nbsp;constants&nbsp;may&nbsp;be&nbsp;defined;&nbsp;these&nbsp;may&nbsp;be&nbsp;used&nbsp;in&nbsp;calls&nbsp;to<br>
  49. the&nbsp;setsockopt()&nbsp;and&nbsp;getsockopt()&nbsp;methods.</tt></p>
  50. <p>
  51. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  52. <tr bgcolor="#aa55cc">
  53. <td colspan=3 valign=bottom>&nbsp;<br>
  54. <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
  55. <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  56. <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="_socket.html">_socket</a><br>
  57. <a href="_ssl.html">_ssl</a><br>
  58. </td><td width="25%" valign=top><a href="errno.html">errno</a><br>
  59. <a href="os.html">os</a><br>
  60. </td><td width="25%" valign=top><a href="sys.html">sys</a><br>
  61. <a href="warnings.html">warnings</a><br>
  62. </td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
  63. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  64. <tr bgcolor="#ee77aa">
  65. <td colspan=3 valign=bottom>&nbsp;<br>
  66. <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
  67. <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  68. <td width="100%"><dl>
  69. <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
  70. </font></dt><dd>
  71. <dl>
  72. <dt><font face="helvetica, arial"><a href="socket.html#_socketobject">_socketobject</a>
  73. </font></dt><dt><font face="helvetica, arial"><a href="socket.html#_socketobject">_socketobject</a>
  74. </font></dt></dl>
  75. </dd>
  76. <dt><font face="helvetica, arial"><a href="exceptions.html#IOError">exceptions.IOError</a>(<a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>)
  77. </font></dt><dd>
  78. <dl>
  79. <dt><font face="helvetica, arial"><a href="socket.html#error">error</a>
  80. </font></dt><dd>
  81. <dl>
  82. <dt><font face="helvetica, arial"><a href="socket.html#gaierror">gaierror</a>
  83. </font></dt><dt><font face="helvetica, arial"><a href="socket.html#herror">herror</a>
  84. </font></dt><dt><font face="helvetica, arial"><a href="socket.html#timeout">timeout</a>
  85. </font></dt></dl>
  86. </dd>
  87. </dl>
  88. </dd>
  89. </dl>
  90. <p>
  91. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  92. <tr bgcolor="#ffc8d8">
  93. <td colspan=3 valign=bottom>&nbsp;<br>
  94. <font color="#000000" face="helvetica, arial"><strong>SocketType</strong> = <a name="SocketType">class _socketobject</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
  95. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  96. <td colspan=2><tt><a href="#socket">socket</a>([family[,&nbsp;type[,&nbsp;proto]]])&nbsp;-&gt;&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a><br>
  97. &nbsp;<br>
  98. Open&nbsp;a&nbsp;<a href="#socket">socket</a>&nbsp;of&nbsp;the&nbsp;given&nbsp;type.&nbsp;&nbsp;The&nbsp;family&nbsp;argument&nbsp;specifies&nbsp;the<br>
  99. address&nbsp;family;&nbsp;it&nbsp;defaults&nbsp;to&nbsp;AF_INET.&nbsp;&nbsp;The&nbsp;type&nbsp;argument&nbsp;specifies<br>
  100. whether&nbsp;this&nbsp;is&nbsp;a&nbsp;stream&nbsp;(SOCK_STREAM,&nbsp;this&nbsp;is&nbsp;the&nbsp;default)<br>
  101. or&nbsp;datagram&nbsp;(SOCK_DGRAM)&nbsp;<a href="#socket">socket</a>.&nbsp;&nbsp;The&nbsp;protocol&nbsp;argument&nbsp;defaults&nbsp;to&nbsp;0,<br>
  102. specifying&nbsp;the&nbsp;default&nbsp;protocol.&nbsp;&nbsp;Keyword&nbsp;arguments&nbsp;are&nbsp;accepted.<br>
  103. &nbsp;<br>
  104. A&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;represents&nbsp;one&nbsp;endpoint&nbsp;of&nbsp;a&nbsp;network&nbsp;connection.<br>
  105. &nbsp;<br>
  106. Methods&nbsp;of&nbsp;<a href="#socket">socket</a>&nbsp;objects&nbsp;(keyword&nbsp;arguments&nbsp;not&nbsp;allowed):<br>
  107. &nbsp;<br>
  108. <a href="#SocketType-accept">accept</a>()&nbsp;--&nbsp;accept&nbsp;a&nbsp;connection,&nbsp;returning&nbsp;new&nbsp;<a href="#socket">socket</a>&nbsp;and&nbsp;client&nbsp;address<br>
  109. <a href="#SocketType-bind">bind</a>(addr)&nbsp;--&nbsp;bind&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;to&nbsp;a&nbsp;local&nbsp;address<br>
  110. <a href="#SocketType-close">close</a>()&nbsp;--&nbsp;close&nbsp;the&nbsp;<a href="#socket">socket</a><br>
  111. <a href="#SocketType-connect">connect</a>(addr)&nbsp;--&nbsp;connect&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;to&nbsp;a&nbsp;remote&nbsp;address<br>
  112. <a href="#SocketType-connect_ex">connect_ex</a>(addr)&nbsp;--&nbsp;connect,&nbsp;return&nbsp;an&nbsp;<a href="#error">error</a>&nbsp;code&nbsp;instead&nbsp;of&nbsp;an&nbsp;exception<br>
  113. <a href="#SocketType-dup">dup</a>()&nbsp;--&nbsp;return&nbsp;a&nbsp;new&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;identical&nbsp;to&nbsp;the&nbsp;current&nbsp;one&nbsp;[*]<br>
  114. <a href="#SocketType-fileno">fileno</a>()&nbsp;--&nbsp;return&nbsp;underlying&nbsp;file&nbsp;descriptor<br>
  115. <a href="#SocketType-getpeername">getpeername</a>()&nbsp;--&nbsp;return&nbsp;remote&nbsp;address&nbsp;[*]<br>
  116. <a href="#SocketType-getsockname">getsockname</a>()&nbsp;--&nbsp;return&nbsp;local&nbsp;address<br>
  117. <a href="#SocketType-getsockopt">getsockopt</a>(level,&nbsp;optname[,&nbsp;buflen])&nbsp;--&nbsp;get&nbsp;<a href="#socket">socket</a>&nbsp;options<br>
  118. <a href="#SocketType-gettimeout">gettimeout</a>()&nbsp;--&nbsp;return&nbsp;<a href="#timeout">timeout</a>&nbsp;or&nbsp;None<br>
  119. <a href="#SocketType-listen">listen</a>(n)&nbsp;--&nbsp;start&nbsp;listening&nbsp;for&nbsp;incoming&nbsp;connections<br>
  120. <a href="#SocketType-makefile">makefile</a>([mode,&nbsp;[bufsize]])&nbsp;--&nbsp;return&nbsp;a&nbsp;file&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;for&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;[*]<br>
  121. <a href="#SocketType-recv">recv</a>(buflen[,&nbsp;flags])&nbsp;--&nbsp;receive&nbsp;data<br>
  122. <a href="#SocketType-recv_into">recv_into</a>(buffer[,&nbsp;nbytes[,&nbsp;flags]])&nbsp;--&nbsp;receive&nbsp;data&nbsp;(into&nbsp;a&nbsp;buffer)<br>
  123. <a href="#SocketType-recvfrom">recvfrom</a>(buflen[,&nbsp;flags])&nbsp;--&nbsp;receive&nbsp;data&nbsp;and&nbsp;sender's&nbsp;address<br>
  124. <a href="#SocketType-recvfrom_into">recvfrom_into</a>(buffer[,&nbsp;nbytes,&nbsp;[,&nbsp;flags])<br>
  125. &nbsp;&nbsp;--&nbsp;receive&nbsp;data&nbsp;and&nbsp;sender's&nbsp;address&nbsp;(into&nbsp;a&nbsp;buffer)<br>
  126. <a href="#SocketType-sendall">sendall</a>(data[,&nbsp;flags])&nbsp;--&nbsp;send&nbsp;all&nbsp;data<br>
  127. <a href="#SocketType-send">send</a>(data[,&nbsp;flags])&nbsp;--&nbsp;send&nbsp;data,&nbsp;may&nbsp;not&nbsp;send&nbsp;all&nbsp;of&nbsp;it<br>
  128. <a href="#SocketType-sendto">sendto</a>(data[,&nbsp;flags],&nbsp;addr)&nbsp;--&nbsp;send&nbsp;data&nbsp;to&nbsp;a&nbsp;given&nbsp;address<br>
  129. <a href="#SocketType-setblocking">setblocking</a>(0&nbsp;|&nbsp;1)&nbsp;--&nbsp;set&nbsp;or&nbsp;clear&nbsp;the&nbsp;blocking&nbsp;I/O&nbsp;flag<br>
  130. <a href="#SocketType-setsockopt">setsockopt</a>(level,&nbsp;optname,&nbsp;value)&nbsp;--&nbsp;set&nbsp;<a href="#socket">socket</a>&nbsp;options<br>
  131. <a href="#SocketType-settimeout">settimeout</a>(None&nbsp;|&nbsp;float)&nbsp;--&nbsp;set&nbsp;or&nbsp;clear&nbsp;the&nbsp;<a href="#timeout">timeout</a><br>
  132. <a href="#SocketType-shutdown">shutdown</a>(how)&nbsp;--&nbsp;shut&nbsp;down&nbsp;traffic&nbsp;in&nbsp;one&nbsp;or&nbsp;both&nbsp;directions<br>
  133. &nbsp;<br>
  134. &nbsp;[*]&nbsp;not&nbsp;available&nbsp;on&nbsp;all&nbsp;platforms!<br>&nbsp;</tt></td></tr>
  135. <tr><td>&nbsp;</td>
  136. <td width="100%">Methods defined here:<br>
  137. <dl><dt><a name="_socketobject-__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>
  138. <dl><dt><a name="_socketobject-accept"><strong>accept</strong></a>(self)</dt><dd><tt><a href="#SocketType-accept">accept</a>()&nbsp;-&gt;&nbsp;(<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;address&nbsp;info)<br>
  139. &nbsp;<br>
  140. Wait&nbsp;for&nbsp;an&nbsp;incoming&nbsp;connection.&nbsp;&nbsp;Return&nbsp;a&nbsp;new&nbsp;<a href="#socket">socket</a>&nbsp;representing&nbsp;the<br>
  141. connection,&nbsp;and&nbsp;the&nbsp;address&nbsp;of&nbsp;the&nbsp;client.&nbsp;&nbsp;For&nbsp;IP&nbsp;sockets,&nbsp;the&nbsp;address<br>
  142. info&nbsp;is&nbsp;a&nbsp;pair&nbsp;(hostaddr,&nbsp;port).</tt></dd></dl>
  143. <dl><dt><a name="_socketobject-bind"><strong>bind</strong></a>(...)</dt><dd><tt><a href="#SocketType-bind">bind</a>(address)<br>
  144. &nbsp;<br>
  145. Bind&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;to&nbsp;a&nbsp;local&nbsp;address.&nbsp;&nbsp;For&nbsp;IP&nbsp;sockets,&nbsp;the&nbsp;address&nbsp;is&nbsp;a<br>
  146. pair&nbsp;(host,&nbsp;port);&nbsp;the&nbsp;host&nbsp;must&nbsp;refer&nbsp;to&nbsp;the&nbsp;local&nbsp;host.&nbsp;For&nbsp;raw&nbsp;packet<br>
  147. sockets&nbsp;the&nbsp;address&nbsp;is&nbsp;a&nbsp;tuple&nbsp;(ifname,&nbsp;proto&nbsp;[,pkttype&nbsp;[,hatype]])</tt></dd></dl>
  148. <dl><dt><a name="_socketobject-close"><strong>close</strong></a>(self, _closedsocket<font color="#909090">=&lt;class 'socket._closedsocket'&gt;</font>, _delegate_methods<font color="#909090">=('recv', 'recvfrom', 'recv_into', 'recvfrom_into', 'send', 'sendto')</font>, setattr<font color="#909090">=&lt;built-in function setattr&gt;</font>)</dt><dd><tt><a href="#SocketType-close">close</a>()<br>
  149. &nbsp;<br>
  150. Close&nbsp;the&nbsp;<a href="#socket">socket</a>.&nbsp;&nbsp;It&nbsp;cannot&nbsp;be&nbsp;used&nbsp;after&nbsp;this&nbsp;call.</tt></dd></dl>
  151. <dl><dt><a name="_socketobject-connect"><strong>connect</strong></a>(...)</dt><dd><tt><a href="#SocketType-connect">connect</a>(address)<br>
  152. &nbsp;<br>
  153. Connect&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;to&nbsp;a&nbsp;remote&nbsp;address.&nbsp;&nbsp;For&nbsp;IP&nbsp;sockets,&nbsp;the&nbsp;address<br>
  154. is&nbsp;a&nbsp;pair&nbsp;(host,&nbsp;port).</tt></dd></dl>
  155. <dl><dt><a name="_socketobject-connect_ex"><strong>connect_ex</strong></a>(...)</dt><dd><tt><a href="#SocketType-connect_ex">connect_ex</a>(address)&nbsp;-&gt;&nbsp;errno<br>
  156. &nbsp;<br>
  157. This&nbsp;is&nbsp;like&nbsp;<a href="#SocketType-connect">connect</a>(address),&nbsp;but&nbsp;returns&nbsp;an&nbsp;<a href="#error">error</a>&nbsp;code&nbsp;(the&nbsp;errno&nbsp;value)<br>
  158. instead&nbsp;of&nbsp;raising&nbsp;an&nbsp;exception&nbsp;when&nbsp;an&nbsp;<a href="#error">error</a>&nbsp;occurs.</tt></dd></dl>
  159. <dl><dt><a name="_socketobject-dup"><strong>dup</strong></a>(self)</dt><dd><tt><a href="#SocketType-dup">dup</a>()&nbsp;-&gt;&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a><br>
  160. &nbsp;<br>
  161. Return&nbsp;a&nbsp;new&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;connected&nbsp;to&nbsp;the&nbsp;same&nbsp;system&nbsp;resource.</tt></dd></dl>
  162. <dl><dt><a name="_socketobject-fileno"><strong>fileno</strong></a>(...)</dt><dd><tt><a href="#SocketType-fileno">fileno</a>()&nbsp;-&gt;&nbsp;integer<br>
  163. &nbsp;<br>
  164. Return&nbsp;the&nbsp;integer&nbsp;file&nbsp;descriptor&nbsp;of&nbsp;the&nbsp;<a href="#socket">socket</a>.</tt></dd></dl>
  165. <dl><dt><a name="_socketobject-getpeername"><strong>getpeername</strong></a>(...)</dt><dd><tt><a href="#SocketType-getpeername">getpeername</a>()&nbsp;-&gt;&nbsp;address&nbsp;info<br>
  166. &nbsp;<br>
  167. Return&nbsp;the&nbsp;address&nbsp;of&nbsp;the&nbsp;remote&nbsp;endpoint.&nbsp;&nbsp;For&nbsp;IP&nbsp;sockets,&nbsp;the&nbsp;address<br>
  168. info&nbsp;is&nbsp;a&nbsp;pair&nbsp;(hostaddr,&nbsp;port).</tt></dd></dl>
  169. <dl><dt><a name="_socketobject-getsockname"><strong>getsockname</strong></a>(...)</dt><dd><tt><a href="#SocketType-getsockname">getsockname</a>()&nbsp;-&gt;&nbsp;address&nbsp;info<br>
  170. &nbsp;<br>
  171. Return&nbsp;the&nbsp;address&nbsp;of&nbsp;the&nbsp;local&nbsp;endpoint.&nbsp;&nbsp;For&nbsp;IP&nbsp;sockets,&nbsp;the&nbsp;address<br>
  172. info&nbsp;is&nbsp;a&nbsp;pair&nbsp;(hostaddr,&nbsp;port).</tt></dd></dl>
  173. <dl><dt><a name="_socketobject-getsockopt"><strong>getsockopt</strong></a>(...)</dt><dd><tt><a href="#SocketType-getsockopt">getsockopt</a>(level,&nbsp;option[,&nbsp;buffersize])&nbsp;-&gt;&nbsp;value<br>
  174. &nbsp;<br>
  175. Get&nbsp;a&nbsp;<a href="#socket">socket</a>&nbsp;option.&nbsp;&nbsp;See&nbsp;the&nbsp;Unix&nbsp;manual&nbsp;for&nbsp;level&nbsp;and&nbsp;option.<br>
  176. If&nbsp;a&nbsp;nonzero&nbsp;buffersize&nbsp;argument&nbsp;is&nbsp;given,&nbsp;the&nbsp;return&nbsp;value&nbsp;is&nbsp;a<br>
  177. string&nbsp;of&nbsp;that&nbsp;length;&nbsp;otherwise&nbsp;it&nbsp;is&nbsp;an&nbsp;integer.</tt></dd></dl>
  178. <dl><dt><a name="_socketobject-gettimeout"><strong>gettimeout</strong></a>(...)</dt><dd><tt><a href="#SocketType-gettimeout">gettimeout</a>()&nbsp;-&gt;&nbsp;<a href="#timeout">timeout</a><br>
  179. &nbsp;<br>
  180. Returns&nbsp;the&nbsp;<a href="#timeout">timeout</a>&nbsp;in&nbsp;seconds&nbsp;(float)&nbsp;associated&nbsp;with&nbsp;<a href="#socket">socket</a>&nbsp;<br>
  181. operations.&nbsp;A&nbsp;<a href="#timeout">timeout</a>&nbsp;of&nbsp;None&nbsp;indicates&nbsp;that&nbsp;timeouts&nbsp;on&nbsp;<a href="#socket">socket</a>&nbsp;<br>
  182. operations&nbsp;are&nbsp;disabled.</tt></dd></dl>
  183. <dl><dt><a name="_socketobject-listen"><strong>listen</strong></a>(...)</dt><dd><tt><a href="#SocketType-listen">listen</a>(backlog)<br>
  184. &nbsp;<br>
  185. Enable&nbsp;a&nbsp;server&nbsp;to&nbsp;accept&nbsp;connections.&nbsp;&nbsp;The&nbsp;backlog&nbsp;argument&nbsp;must&nbsp;be&nbsp;at<br>
  186. least&nbsp;0&nbsp;(if&nbsp;it&nbsp;is&nbsp;lower,&nbsp;it&nbsp;is&nbsp;set&nbsp;to&nbsp;0);&nbsp;it&nbsp;specifies&nbsp;the&nbsp;number&nbsp;of<br>
  187. unaccepted&nbsp;connections&nbsp;that&nbsp;the&nbsp;system&nbsp;will&nbsp;allow&nbsp;before&nbsp;refusing&nbsp;new<br>
  188. connections.</tt></dd></dl>
  189. <dl><dt><a name="_socketobject-makefile"><strong>makefile</strong></a>(self, mode<font color="#909090">='r'</font>, bufsize<font color="#909090">=-1</font>)</dt><dd><tt><a href="#SocketType-makefile">makefile</a>([mode[,&nbsp;bufsize]])&nbsp;-&gt;&nbsp;file&nbsp;<a href="__builtin__.html#object">object</a><br>
  190. &nbsp;<br>
  191. Return&nbsp;a&nbsp;regular&nbsp;file&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;corresponding&nbsp;to&nbsp;the&nbsp;<a href="#socket">socket</a>.&nbsp;&nbsp;The&nbsp;mode<br>
  192. and&nbsp;bufsize&nbsp;arguments&nbsp;are&nbsp;as&nbsp;for&nbsp;the&nbsp;built-in&nbsp;open()&nbsp;function.</tt></dd></dl>
  193. <dl><dt><a name="_socketobject-sendall"><strong>sendall</strong></a>(...)</dt><dd><tt><a href="#SocketType-sendall">sendall</a>(data[,&nbsp;flags])<br>
  194. &nbsp;<br>
  195. Send&nbsp;a&nbsp;data&nbsp;string&nbsp;to&nbsp;the&nbsp;<a href="#socket">socket</a>.&nbsp;&nbsp;For&nbsp;the&nbsp;optional&nbsp;flags<br>
  196. argument,&nbsp;see&nbsp;the&nbsp;Unix&nbsp;manual.&nbsp;&nbsp;This&nbsp;calls&nbsp;<a href="#SocketType-send">send</a>()&nbsp;repeatedly<br>
  197. until&nbsp;all&nbsp;data&nbsp;is&nbsp;sent.&nbsp;&nbsp;If&nbsp;an&nbsp;<a href="#error">error</a>&nbsp;occurs,&nbsp;it's&nbsp;impossible<br>
  198. to&nbsp;tell&nbsp;how&nbsp;much&nbsp;data&nbsp;has&nbsp;been&nbsp;sent.</tt></dd></dl>
  199. <dl><dt><a name="_socketobject-setblocking"><strong>setblocking</strong></a>(...)</dt><dd><tt><a href="#SocketType-setblocking">setblocking</a>(flag)<br>
  200. &nbsp;<br>
  201. Set&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;to&nbsp;blocking&nbsp;(flag&nbsp;is&nbsp;true)&nbsp;or&nbsp;non-blocking&nbsp;(false).<br>
  202. <a href="#SocketType-setblocking">setblocking</a>(True)&nbsp;is&nbsp;equivalent&nbsp;to&nbsp;<a href="#SocketType-settimeout">settimeout</a>(None);<br>
  203. <a href="#SocketType-setblocking">setblocking</a>(False)&nbsp;is&nbsp;equivalent&nbsp;to&nbsp;<a href="#SocketType-settimeout">settimeout</a>(0.0).</tt></dd></dl>
  204. <dl><dt><a name="_socketobject-setsockopt"><strong>setsockopt</strong></a>(...)</dt><dd><tt><a href="#SocketType-setsockopt">setsockopt</a>(level,&nbsp;option,&nbsp;value)<br>
  205. &nbsp;<br>
  206. Set&nbsp;a&nbsp;<a href="#socket">socket</a>&nbsp;option.&nbsp;&nbsp;See&nbsp;the&nbsp;Unix&nbsp;manual&nbsp;for&nbsp;level&nbsp;and&nbsp;option.<br>
  207. The&nbsp;value&nbsp;argument&nbsp;can&nbsp;either&nbsp;be&nbsp;an&nbsp;integer&nbsp;or&nbsp;a&nbsp;string.</tt></dd></dl>
  208. <dl><dt><a name="_socketobject-settimeout"><strong>settimeout</strong></a>(...)</dt><dd><tt><a href="#SocketType-settimeout">settimeout</a>(<a href="#timeout">timeout</a>)<br>
  209. &nbsp;<br>
  210. Set&nbsp;a&nbsp;<a href="#timeout">timeout</a>&nbsp;on&nbsp;<a href="#socket">socket</a>&nbsp;operations.&nbsp;&nbsp;'<a href="#timeout">timeout</a>'&nbsp;can&nbsp;be&nbsp;a&nbsp;float,<br>
  211. giving&nbsp;in&nbsp;seconds,&nbsp;or&nbsp;None.&nbsp;&nbsp;Setting&nbsp;a&nbsp;<a href="#timeout">timeout</a>&nbsp;of&nbsp;None&nbsp;disables<br>
  212. the&nbsp;<a href="#timeout">timeout</a>&nbsp;feature&nbsp;and&nbsp;is&nbsp;equivalent&nbsp;to&nbsp;<a href="#SocketType-setblocking">setblocking</a>(1).<br>
  213. Setting&nbsp;a&nbsp;<a href="#timeout">timeout</a>&nbsp;of&nbsp;zero&nbsp;is&nbsp;the&nbsp;same&nbsp;as&nbsp;<a href="#SocketType-setblocking">setblocking</a>(0).</tt></dd></dl>
  214. <dl><dt><a name="_socketobject-shutdown"><strong>shutdown</strong></a>(...)</dt><dd><tt><a href="#SocketType-shutdown">shutdown</a>(flag)<br>
  215. &nbsp;<br>
  216. Shut&nbsp;down&nbsp;the&nbsp;reading&nbsp;side&nbsp;of&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;(flag&nbsp;==&nbsp;SHUT_RD),&nbsp;the&nbsp;writing&nbsp;side<br>
  217. of&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;(flag&nbsp;==&nbsp;SHUT_WR),&nbsp;or&nbsp;both&nbsp;ends&nbsp;(flag&nbsp;==&nbsp;SHUT_RDWR).</tt></dd></dl>
  218. <hr>
  219. Data descriptors defined here:<br>
  220. <dl><dt><strong>__weakref__</strong></dt>
  221. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  222. </dl>
  223. <dl><dt><strong>family</strong></dt>
  224. <dd><tt>the&nbsp;socket&nbsp;family</tt></dd>
  225. </dl>
  226. <dl><dt><strong>proto</strong></dt>
  227. <dd><tt>the&nbsp;socket&nbsp;protocol</tt></dd>
  228. </dl>
  229. <dl><dt><strong>recv</strong></dt>
  230. </dl>
  231. <dl><dt><strong>recv_into</strong></dt>
  232. </dl>
  233. <dl><dt><strong>recvfrom</strong></dt>
  234. </dl>
  235. <dl><dt><strong>recvfrom_into</strong></dt>
  236. </dl>
  237. <dl><dt><strong>send</strong></dt>
  238. </dl>
  239. <dl><dt><strong>sendto</strong></dt>
  240. </dl>
  241. <dl><dt><strong>type</strong></dt>
  242. <dd><tt>the&nbsp;socket&nbsp;type</tt></dd>
  243. </dl>
  244. </td></tr></table> <p>
  245. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  246. <tr bgcolor="#ffc8d8">
  247. <td colspan=3 valign=bottom>&nbsp;<br>
  248. <font color="#000000" face="helvetica, arial"><a name="error">class <strong>error</strong></a>(<a href="exceptions.html#IOError">exceptions.IOError</a>)</font></td></tr>
  249. <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  250. <td width="100%"><dl><dt>Method resolution order:</dt>
  251. <dd><a href="socket.html#error">error</a></dd>
  252. <dd><a href="exceptions.html#IOError">exceptions.IOError</a></dd>
  253. <dd><a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a></dd>
  254. <dd><a href="exceptions.html#StandardError">exceptions.StandardError</a></dd>
  255. <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
  256. <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
  257. <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
  258. </dl>
  259. <hr>
  260. Data descriptors defined here:<br>
  261. <dl><dt><strong>__weakref__</strong></dt>
  262. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  263. </dl>
  264. <hr>
  265. Methods inherited from <a href="exceptions.html#IOError">exceptions.IOError</a>:<br>
  266. <dl><dt><a name="error-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#error-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;help(type(x))&nbsp;for&nbsp;signature</tt></dd></dl>
  267. <hr>
  268. Data and other attributes inherited from <a href="exceptions.html#IOError">exceptions.IOError</a>:<br>
  269. <dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#error-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
  270. <hr>
  271. Methods inherited from <a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>:<br>
  272. <dl><dt><a name="error-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
  273. <dl><dt><a name="error-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#error-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
  274. <hr>
  275. Data descriptors inherited from <a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>:<br>
  276. <dl><dt><strong>errno</strong></dt>
  277. <dd><tt>exception&nbsp;errno</tt></dd>
  278. </dl>
  279. <dl><dt><strong>filename</strong></dt>
  280. <dd><tt>exception&nbsp;filename</tt></dd>
  281. </dl>
  282. <dl><dt><strong>strerror</strong></dt>
  283. <dd><tt>exception&nbsp;strerror</tt></dd>
  284. </dl>
  285. <hr>
  286. Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  287. <dl><dt><a name="error-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#error-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
  288. <dl><dt><a name="error-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#error-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
  289. <dl><dt><a name="error-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#error-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
  290. <dl><dt><a name="error-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#error-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
  291. &nbsp;<br>
  292. Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
  293. <dl><dt><a name="error-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#error-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
  294. <dl><dt><a name="error-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#error-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
  295. <dl><dt><a name="error-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
  296. <dl><dt><a name="error-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
  297. <hr>
  298. Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  299. <dl><dt><strong>__dict__</strong></dt>
  300. </dl>
  301. <dl><dt><strong>args</strong></dt>
  302. </dl>
  303. <dl><dt><strong>message</strong></dt>
  304. </dl>
  305. </td></tr></table> <p>
  306. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  307. <tr bgcolor="#ffc8d8">
  308. <td colspan=3 valign=bottom>&nbsp;<br>
  309. <font color="#000000" face="helvetica, arial"><a name="gaierror">class <strong>gaierror</strong></a>(<a href="socket.html#error">error</a>)</font></td></tr>
  310. <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  311. <td width="100%"><dl><dt>Method resolution order:</dt>
  312. <dd><a href="socket.html#gaierror">gaierror</a></dd>
  313. <dd><a href="socket.html#error">error</a></dd>
  314. <dd><a href="exceptions.html#IOError">exceptions.IOError</a></dd>
  315. <dd><a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a></dd>
  316. <dd><a href="exceptions.html#StandardError">exceptions.StandardError</a></dd>
  317. <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
  318. <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
  319. <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
  320. </dl>
  321. <hr>
  322. Data descriptors inherited from <a href="socket.html#error">error</a>:<br>
  323. <dl><dt><strong>__weakref__</strong></dt>
  324. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  325. </dl>
  326. <hr>
  327. Methods inherited from <a href="exceptions.html#IOError">exceptions.IOError</a>:<br>
  328. <dl><dt><a name="gaierror-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#gaierror-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;help(type(x))&nbsp;for&nbsp;signature</tt></dd></dl>
  329. <hr>
  330. Data and other attributes inherited from <a href="exceptions.html#IOError">exceptions.IOError</a>:<br>
  331. <dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#gaierror-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
  332. <hr>
  333. Methods inherited from <a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>:<br>
  334. <dl><dt><a name="gaierror-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
  335. <dl><dt><a name="gaierror-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#gaierror-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
  336. <hr>
  337. Data descriptors inherited from <a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>:<br>
  338. <dl><dt><strong>errno</strong></dt>
  339. <dd><tt>exception&nbsp;errno</tt></dd>
  340. </dl>
  341. <dl><dt><strong>filename</strong></dt>
  342. <dd><tt>exception&nbsp;filename</tt></dd>
  343. </dl>
  344. <dl><dt><strong>strerror</strong></dt>
  345. <dd><tt>exception&nbsp;strerror</tt></dd>
  346. </dl>
  347. <hr>
  348. Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  349. <dl><dt><a name="gaierror-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#gaierror-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
  350. <dl><dt><a name="gaierror-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#gaierror-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
  351. <dl><dt><a name="gaierror-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#gaierror-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
  352. <dl><dt><a name="gaierror-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#gaierror-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
  353. &nbsp;<br>
  354. Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
  355. <dl><dt><a name="gaierror-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#gaierror-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
  356. <dl><dt><a name="gaierror-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#gaierror-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
  357. <dl><dt><a name="gaierror-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
  358. <dl><dt><a name="gaierror-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
  359. <hr>
  360. Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  361. <dl><dt><strong>__dict__</strong></dt>
  362. </dl>
  363. <dl><dt><strong>args</strong></dt>
  364. </dl>
  365. <dl><dt><strong>message</strong></dt>
  366. </dl>
  367. </td></tr></table> <p>
  368. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  369. <tr bgcolor="#ffc8d8">
  370. <td colspan=3 valign=bottom>&nbsp;<br>
  371. <font color="#000000" face="helvetica, arial"><a name="herror">class <strong>herror</strong></a>(<a href="socket.html#error">error</a>)</font></td></tr>
  372. <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  373. <td width="100%"><dl><dt>Method resolution order:</dt>
  374. <dd><a href="socket.html#herror">herror</a></dd>
  375. <dd><a href="socket.html#error">error</a></dd>
  376. <dd><a href="exceptions.html#IOError">exceptions.IOError</a></dd>
  377. <dd><a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a></dd>
  378. <dd><a href="exceptions.html#StandardError">exceptions.StandardError</a></dd>
  379. <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
  380. <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
  381. <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
  382. </dl>
  383. <hr>
  384. Data descriptors inherited from <a href="socket.html#error">error</a>:<br>
  385. <dl><dt><strong>__weakref__</strong></dt>
  386. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  387. </dl>
  388. <hr>
  389. Methods inherited from <a href="exceptions.html#IOError">exceptions.IOError</a>:<br>
  390. <dl><dt><a name="herror-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#herror-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;help(type(x))&nbsp;for&nbsp;signature</tt></dd></dl>
  391. <hr>
  392. Data and other attributes inherited from <a href="exceptions.html#IOError">exceptions.IOError</a>:<br>
  393. <dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#herror-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
  394. <hr>
  395. Methods inherited from <a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>:<br>
  396. <dl><dt><a name="herror-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
  397. <dl><dt><a name="herror-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#herror-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
  398. <hr>
  399. Data descriptors inherited from <a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>:<br>
  400. <dl><dt><strong>errno</strong></dt>
  401. <dd><tt>exception&nbsp;errno</tt></dd>
  402. </dl>
  403. <dl><dt><strong>filename</strong></dt>
  404. <dd><tt>exception&nbsp;filename</tt></dd>
  405. </dl>
  406. <dl><dt><strong>strerror</strong></dt>
  407. <dd><tt>exception&nbsp;strerror</tt></dd>
  408. </dl>
  409. <hr>
  410. Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  411. <dl><dt><a name="herror-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#herror-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
  412. <dl><dt><a name="herror-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#herror-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
  413. <dl><dt><a name="herror-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#herror-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
  414. <dl><dt><a name="herror-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#herror-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
  415. &nbsp;<br>
  416. Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
  417. <dl><dt><a name="herror-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#herror-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
  418. <dl><dt><a name="herror-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#herror-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
  419. <dl><dt><a name="herror-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
  420. <dl><dt><a name="herror-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
  421. <hr>
  422. Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  423. <dl><dt><strong>__dict__</strong></dt>
  424. </dl>
  425. <dl><dt><strong>args</strong></dt>
  426. </dl>
  427. <dl><dt><strong>message</strong></dt>
  428. </dl>
  429. </td></tr></table> <p>
  430. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  431. <tr bgcolor="#ffc8d8">
  432. <td colspan=3 valign=bottom>&nbsp;<br>
  433. <font color="#000000" face="helvetica, arial"><strong>socket</strong> = <a name="socket">class _socketobject</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
  434. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  435. <td colspan=2><tt><a href="#socket">socket</a>([family[,&nbsp;type[,&nbsp;proto]]])&nbsp;-&gt;&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a><br>
  436. &nbsp;<br>
  437. Open&nbsp;a&nbsp;<a href="#socket">socket</a>&nbsp;of&nbsp;the&nbsp;given&nbsp;type.&nbsp;&nbsp;The&nbsp;family&nbsp;argument&nbsp;specifies&nbsp;the<br>
  438. address&nbsp;family;&nbsp;it&nbsp;defaults&nbsp;to&nbsp;AF_INET.&nbsp;&nbsp;The&nbsp;type&nbsp;argument&nbsp;specifies<br>
  439. whether&nbsp;this&nbsp;is&nbsp;a&nbsp;stream&nbsp;(SOCK_STREAM,&nbsp;this&nbsp;is&nbsp;the&nbsp;default)<br>
  440. or&nbsp;datagram&nbsp;(SOCK_DGRAM)&nbsp;<a href="#socket">socket</a>.&nbsp;&nbsp;The&nbsp;protocol&nbsp;argument&nbsp;defaults&nbsp;to&nbsp;0,<br>
  441. specifying&nbsp;the&nbsp;default&nbsp;protocol.&nbsp;&nbsp;Keyword&nbsp;arguments&nbsp;are&nbsp;accepted.<br>
  442. &nbsp;<br>
  443. A&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;represents&nbsp;one&nbsp;endpoint&nbsp;of&nbsp;a&nbsp;network&nbsp;connection.<br>
  444. &nbsp;<br>
  445. Methods&nbsp;of&nbsp;<a href="#socket">socket</a>&nbsp;objects&nbsp;(keyword&nbsp;arguments&nbsp;not&nbsp;allowed):<br>
  446. &nbsp;<br>
  447. <a href="#socket-accept">accept</a>()&nbsp;--&nbsp;accept&nbsp;a&nbsp;connection,&nbsp;returning&nbsp;new&nbsp;<a href="#socket">socket</a>&nbsp;and&nbsp;client&nbsp;address<br>
  448. <a href="#socket-bind">bind</a>(addr)&nbsp;--&nbsp;bind&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;to&nbsp;a&nbsp;local&nbsp;address<br>
  449. <a href="#socket-close">close</a>()&nbsp;--&nbsp;close&nbsp;the&nbsp;<a href="#socket">socket</a><br>
  450. <a href="#socket-connect">connect</a>(addr)&nbsp;--&nbsp;connect&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;to&nbsp;a&nbsp;remote&nbsp;address<br>
  451. <a href="#socket-connect_ex">connect_ex</a>(addr)&nbsp;--&nbsp;connect,&nbsp;return&nbsp;an&nbsp;<a href="#error">error</a>&nbsp;code&nbsp;instead&nbsp;of&nbsp;an&nbsp;exception<br>
  452. <a href="#socket-dup">dup</a>()&nbsp;--&nbsp;return&nbsp;a&nbsp;new&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;identical&nbsp;to&nbsp;the&nbsp;current&nbsp;one&nbsp;[*]<br>
  453. <a href="#socket-fileno">fileno</a>()&nbsp;--&nbsp;return&nbsp;underlying&nbsp;file&nbsp;descriptor<br>
  454. <a href="#socket-getpeername">getpeername</a>()&nbsp;--&nbsp;return&nbsp;remote&nbsp;address&nbsp;[*]<br>
  455. <a href="#socket-getsockname">getsockname</a>()&nbsp;--&nbsp;return&nbsp;local&nbsp;address<br>
  456. <a href="#socket-getsockopt">getsockopt</a>(level,&nbsp;optname[,&nbsp;buflen])&nbsp;--&nbsp;get&nbsp;<a href="#socket">socket</a>&nbsp;options<br>
  457. <a href="#socket-gettimeout">gettimeout</a>()&nbsp;--&nbsp;return&nbsp;<a href="#timeout">timeout</a>&nbsp;or&nbsp;None<br>
  458. <a href="#socket-listen">listen</a>(n)&nbsp;--&nbsp;start&nbsp;listening&nbsp;for&nbsp;incoming&nbsp;connections<br>
  459. <a href="#socket-makefile">makefile</a>([mode,&nbsp;[bufsize]])&nbsp;--&nbsp;return&nbsp;a&nbsp;file&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;for&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;[*]<br>
  460. <a href="#socket-recv">recv</a>(buflen[,&nbsp;flags])&nbsp;--&nbsp;receive&nbsp;data<br>
  461. <a href="#socket-recv_into">recv_into</a>(buffer[,&nbsp;nbytes[,&nbsp;flags]])&nbsp;--&nbsp;receive&nbsp;data&nbsp;(into&nbsp;a&nbsp;buffer)<br>
  462. <a href="#socket-recvfrom">recvfrom</a>(buflen[,&nbsp;flags])&nbsp;--&nbsp;receive&nbsp;data&nbsp;and&nbsp;sender's&nbsp;address<br>
  463. <a href="#socket-recvfrom_into">recvfrom_into</a>(buffer[,&nbsp;nbytes,&nbsp;[,&nbsp;flags])<br>
  464. &nbsp;&nbsp;--&nbsp;receive&nbsp;data&nbsp;and&nbsp;sender's&nbsp;address&nbsp;(into&nbsp;a&nbsp;buffer)<br>
  465. <a href="#socket-sendall">sendall</a>(data[,&nbsp;flags])&nbsp;--&nbsp;send&nbsp;all&nbsp;data<br>
  466. <a href="#socket-send">send</a>(data[,&nbsp;flags])&nbsp;--&nbsp;send&nbsp;data,&nbsp;may&nbsp;not&nbsp;send&nbsp;all&nbsp;of&nbsp;it<br>
  467. <a href="#socket-sendto">sendto</a>(data[,&nbsp;flags],&nbsp;addr)&nbsp;--&nbsp;send&nbsp;data&nbsp;to&nbsp;a&nbsp;given&nbsp;address<br>
  468. <a href="#socket-setblocking">setblocking</a>(0&nbsp;|&nbsp;1)&nbsp;--&nbsp;set&nbsp;or&nbsp;clear&nbsp;the&nbsp;blocking&nbsp;I/O&nbsp;flag<br>
  469. <a href="#socket-setsockopt">setsockopt</a>(level,&nbsp;optname,&nbsp;value)&nbsp;--&nbsp;set&nbsp;<a href="#socket">socket</a>&nbsp;options<br>
  470. <a href="#socket-settimeout">settimeout</a>(None&nbsp;|&nbsp;float)&nbsp;--&nbsp;set&nbsp;or&nbsp;clear&nbsp;the&nbsp;<a href="#timeout">timeout</a><br>
  471. <a href="#socket-shutdown">shutdown</a>(how)&nbsp;--&nbsp;shut&nbsp;down&nbsp;traffic&nbsp;in&nbsp;one&nbsp;or&nbsp;both&nbsp;directions<br>
  472. &nbsp;<br>
  473. &nbsp;[*]&nbsp;not&nbsp;available&nbsp;on&nbsp;all&nbsp;platforms!<br>&nbsp;</tt></td></tr>
  474. <tr><td>&nbsp;</td>
  475. <td width="100%">Methods defined here:<br>
  476. <dl><dt><a name="_socketobject-__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>
  477. <dl><dt><a name="_socketobject-accept"><strong>accept</strong></a>(self)</dt><dd><tt><a href="#socket-accept">accept</a>()&nbsp;-&gt;&nbsp;(<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;address&nbsp;info)<br>
  478. &nbsp;<br>
  479. Wait&nbsp;for&nbsp;an&nbsp;incoming&nbsp;connection.&nbsp;&nbsp;Return&nbsp;a&nbsp;new&nbsp;<a href="#socket">socket</a>&nbsp;representing&nbsp;the<br>
  480. connection,&nbsp;and&nbsp;the&nbsp;address&nbsp;of&nbsp;the&nbsp;client.&nbsp;&nbsp;For&nbsp;IP&nbsp;sockets,&nbsp;the&nbsp;address<br>
  481. info&nbsp;is&nbsp;a&nbsp;pair&nbsp;(hostaddr,&nbsp;port).</tt></dd></dl>
  482. <dl><dt><a name="_socketobject-bind"><strong>bind</strong></a>(...)</dt><dd><tt><a href="#socket-bind">bind</a>(address)<br>
  483. &nbsp;<br>
  484. Bind&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;to&nbsp;a&nbsp;local&nbsp;address.&nbsp;&nbsp;For&nbsp;IP&nbsp;sockets,&nbsp;the&nbsp;address&nbsp;is&nbsp;a<br>
  485. pair&nbsp;(host,&nbsp;port);&nbsp;the&nbsp;host&nbsp;must&nbsp;refer&nbsp;to&nbsp;the&nbsp;local&nbsp;host.&nbsp;For&nbsp;raw&nbsp;packet<br>
  486. sockets&nbsp;the&nbsp;address&nbsp;is&nbsp;a&nbsp;tuple&nbsp;(ifname,&nbsp;proto&nbsp;[,pkttype&nbsp;[,hatype]])</tt></dd></dl>
  487. <dl><dt><a name="_socketobject-close"><strong>close</strong></a>(self, _closedsocket<font color="#909090">=&lt;class 'socket._closedsocket'&gt;</font>, _delegate_methods<font color="#909090">=('recv', 'recvfrom', 'recv_into', 'recvfrom_into', 'send', 'sendto')</font>, setattr<font color="#909090">=&lt;built-in function setattr&gt;</font>)</dt><dd><tt><a href="#socket-close">close</a>()<br>
  488. &nbsp;<br>
  489. Close&nbsp;the&nbsp;<a href="#socket">socket</a>.&nbsp;&nbsp;It&nbsp;cannot&nbsp;be&nbsp;used&nbsp;after&nbsp;this&nbsp;call.</tt></dd></dl>
  490. <dl><dt><a name="_socketobject-connect"><strong>connect</strong></a>(...)</dt><dd><tt><a href="#socket-connect">connect</a>(address)<br>
  491. &nbsp;<br>
  492. Connect&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;to&nbsp;a&nbsp;remote&nbsp;address.&nbsp;&nbsp;For&nbsp;IP&nbsp;sockets,&nbsp;the&nbsp;address<br>
  493. is&nbsp;a&nbsp;pair&nbsp;(host,&nbsp;port).</tt></dd></dl>
  494. <dl><dt><a name="_socketobject-connect_ex"><strong>connect_ex</strong></a>(...)</dt><dd><tt><a href="#socket-connect_ex">connect_ex</a>(address)&nbsp;-&gt;&nbsp;errno<br>
  495. &nbsp;<br>
  496. This&nbsp;is&nbsp;like&nbsp;<a href="#socket-connect">connect</a>(address),&nbsp;but&nbsp;returns&nbsp;an&nbsp;<a href="#error">error</a>&nbsp;code&nbsp;(the&nbsp;errno&nbsp;value)<br>
  497. instead&nbsp;of&nbsp;raising&nbsp;an&nbsp;exception&nbsp;when&nbsp;an&nbsp;<a href="#error">error</a>&nbsp;occurs.</tt></dd></dl>
  498. <dl><dt><a name="_socketobject-dup"><strong>dup</strong></a>(self)</dt><dd><tt><a href="#socket-dup">dup</a>()&nbsp;-&gt;&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a><br>
  499. &nbsp;<br>
  500. Return&nbsp;a&nbsp;new&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;connected&nbsp;to&nbsp;the&nbsp;same&nbsp;system&nbsp;resource.</tt></dd></dl>
  501. <dl><dt><a name="_socketobject-fileno"><strong>fileno</strong></a>(...)</dt><dd><tt><a href="#socket-fileno">fileno</a>()&nbsp;-&gt;&nbsp;integer<br>
  502. &nbsp;<br>
  503. Return&nbsp;the&nbsp;integer&nbsp;file&nbsp;descriptor&nbsp;of&nbsp;the&nbsp;<a href="#socket">socket</a>.</tt></dd></dl>
  504. <dl><dt><a name="_socketobject-getpeername"><strong>getpeername</strong></a>(...)</dt><dd><tt><a href="#socket-getpeername">getpeername</a>()&nbsp;-&gt;&nbsp;address&nbsp;info<br>
  505. &nbsp;<br>
  506. Return&nbsp;the&nbsp;address&nbsp;of&nbsp;the&nbsp;remote&nbsp;endpoint.&nbsp;&nbsp;For&nbsp;IP&nbsp;sockets,&nbsp;the&nbsp;address<br>
  507. info&nbsp;is&nbsp;a&nbsp;pair&nbsp;(hostaddr,&nbsp;port).</tt></dd></dl>
  508. <dl><dt><a name="_socketobject-getsockname"><strong>getsockname</strong></a>(...)</dt><dd><tt><a href="#socket-getsockname">getsockname</a>()&nbsp;-&gt;&nbsp;address&nbsp;info<br>
  509. &nbsp;<br>
  510. Return&nbsp;the&nbsp;address&nbsp;of&nbsp;the&nbsp;local&nbsp;endpoint.&nbsp;&nbsp;For&nbsp;IP&nbsp;sockets,&nbsp;the&nbsp;address<br>
  511. info&nbsp;is&nbsp;a&nbsp;pair&nbsp;(hostaddr,&nbsp;port).</tt></dd></dl>
  512. <dl><dt><a name="_socketobject-getsockopt"><strong>getsockopt</strong></a>(...)</dt><dd><tt><a href="#socket-getsockopt">getsockopt</a>(level,&nbsp;option[,&nbsp;buffersize])&nbsp;-&gt;&nbsp;value<br>
  513. &nbsp;<br>
  514. Get&nbsp;a&nbsp;<a href="#socket">socket</a>&nbsp;option.&nbsp;&nbsp;See&nbsp;the&nbsp;Unix&nbsp;manual&nbsp;for&nbsp;level&nbsp;and&nbsp;option.<br>
  515. If&nbsp;a&nbsp;nonzero&nbsp;buffersize&nbsp;argument&nbsp;is&nbsp;given,&nbsp;the&nbsp;return&nbsp;value&nbsp;is&nbsp;a<br>
  516. string&nbsp;of&nbsp;that&nbsp;length;&nbsp;otherwise&nbsp;it&nbsp;is&nbsp;an&nbsp;integer.</tt></dd></dl>
  517. <dl><dt><a name="_socketobject-gettimeout"><strong>gettimeout</strong></a>(...)</dt><dd><tt><a href="#socket-gettimeout">gettimeout</a>()&nbsp;-&gt;&nbsp;<a href="#timeout">timeout</a><br>
  518. &nbsp;<br>
  519. Returns&nbsp;the&nbsp;<a href="#timeout">timeout</a>&nbsp;in&nbsp;seconds&nbsp;(float)&nbsp;associated&nbsp;with&nbsp;<a href="#socket">socket</a>&nbsp;<br>
  520. operations.&nbsp;A&nbsp;<a href="#timeout">timeout</a>&nbsp;of&nbsp;None&nbsp;indicates&nbsp;that&nbsp;timeouts&nbsp;on&nbsp;<a href="#socket">socket</a>&nbsp;<br>
  521. operations&nbsp;are&nbsp;disabled.</tt></dd></dl>
  522. <dl><dt><a name="_socketobject-listen"><strong>listen</strong></a>(...)</dt><dd><tt><a href="#socket-listen">listen</a>(backlog)<br>
  523. &nbsp;<br>
  524. Enable&nbsp;a&nbsp;server&nbsp;to&nbsp;accept&nbsp;connections.&nbsp;&nbsp;The&nbsp;backlog&nbsp;argument&nbsp;must&nbsp;be&nbsp;at<br>
  525. least&nbsp;0&nbsp;(if&nbsp;it&nbsp;is&nbsp;lower,&nbsp;it&nbsp;is&nbsp;set&nbsp;to&nbsp;0);&nbsp;it&nbsp;specifies&nbsp;the&nbsp;number&nbsp;of<br>
  526. unaccepted&nbsp;connections&nbsp;that&nbsp;the&nbsp;system&nbsp;will&nbsp;allow&nbsp;before&nbsp;refusing&nbsp;new<br>
  527. connections.</tt></dd></dl>
  528. <dl><dt><a name="_socketobject-makefile"><strong>makefile</strong></a>(self, mode<font color="#909090">='r'</font>, bufsize<font color="#909090">=-1</font>)</dt><dd><tt><a href="#socket-makefile">makefile</a>([mode[,&nbsp;bufsize]])&nbsp;-&gt;&nbsp;file&nbsp;<a href="__builtin__.html#object">object</a><br>
  529. &nbsp;<br>
  530. Return&nbsp;a&nbsp;regular&nbsp;file&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;corresponding&nbsp;to&nbsp;the&nbsp;<a href="#socket">socket</a>.&nbsp;&nbsp;The&nbsp;mode<br>
  531. and&nbsp;bufsize&nbsp;arguments&nbsp;are&nbsp;as&nbsp;for&nbsp;the&nbsp;built-in&nbsp;open()&nbsp;function.</tt></dd></dl>
  532. <dl><dt><a name="_socketobject-sendall"><strong>sendall</strong></a>(...)</dt><dd><tt><a href="#socket-sendall">sendall</a>(data[,&nbsp;flags])<br>
  533. &nbsp;<br>
  534. Send&nbsp;a&nbsp;data&nbsp;string&nbsp;to&nbsp;the&nbsp;<a href="#socket">socket</a>.&nbsp;&nbsp;For&nbsp;the&nbsp;optional&nbsp;flags<br>
  535. argument,&nbsp;see&nbsp;the&nbsp;Unix&nbsp;manual.&nbsp;&nbsp;This&nbsp;calls&nbsp;<a href="#socket-send">send</a>()&nbsp;repeatedly<br>
  536. until&nbsp;all&nbsp;data&nbsp;is&nbsp;sent.&nbsp;&nbsp;If&nbsp;an&nbsp;<a href="#error">error</a>&nbsp;occurs,&nbsp;it's&nbsp;impossible<br>
  537. to&nbsp;tell&nbsp;how&nbsp;much&nbsp;data&nbsp;has&nbsp;been&nbsp;sent.</tt></dd></dl>
  538. <dl><dt><a name="_socketobject-setblocking"><strong>setblocking</strong></a>(...)</dt><dd><tt><a href="#socket-setblocking">setblocking</a>(flag)<br>
  539. &nbsp;<br>
  540. Set&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;to&nbsp;blocking&nbsp;(flag&nbsp;is&nbsp;true)&nbsp;or&nbsp;non-blocking&nbsp;(false).<br>
  541. <a href="#socket-setblocking">setblocking</a>(True)&nbsp;is&nbsp;equivalent&nbsp;to&nbsp;<a href="#socket-settimeout">settimeout</a>(None);<br>
  542. <a href="#socket-setblocking">setblocking</a>(False)&nbsp;is&nbsp;equivalent&nbsp;to&nbsp;<a href="#socket-settimeout">settimeout</a>(0.0).</tt></dd></dl>
  543. <dl><dt><a name="_socketobject-setsockopt"><strong>setsockopt</strong></a>(...)</dt><dd><tt><a href="#socket-setsockopt">setsockopt</a>(level,&nbsp;option,&nbsp;value)<br>
  544. &nbsp;<br>
  545. Set&nbsp;a&nbsp;<a href="#socket">socket</a>&nbsp;option.&nbsp;&nbsp;See&nbsp;the&nbsp;Unix&nbsp;manual&nbsp;for&nbsp;level&nbsp;and&nbsp;option.<br>
  546. The&nbsp;value&nbsp;argument&nbsp;can&nbsp;either&nbsp;be&nbsp;an&nbsp;integer&nbsp;or&nbsp;a&nbsp;string.</tt></dd></dl>
  547. <dl><dt><a name="_socketobject-settimeout"><strong>settimeout</strong></a>(...)</dt><dd><tt><a href="#socket-settimeout">settimeout</a>(<a href="#timeout">timeout</a>)<br>
  548. &nbsp;<br>
  549. Set&nbsp;a&nbsp;<a href="#timeout">timeout</a>&nbsp;on&nbsp;<a href="#socket">socket</a>&nbsp;operations.&nbsp;&nbsp;'<a href="#timeout">timeout</a>'&nbsp;can&nbsp;be&nbsp;a&nbsp;float,<br>
  550. giving&nbsp;in&nbsp;seconds,&nbsp;or&nbsp;None.&nbsp;&nbsp;Setting&nbsp;a&nbsp;<a href="#timeout">timeout</a>&nbsp;of&nbsp;None&nbsp;disables<br>
  551. the&nbsp;<a href="#timeout">timeout</a>&nbsp;feature&nbsp;and&nbsp;is&nbsp;equivalent&nbsp;to&nbsp;<a href="#socket-setblocking">setblocking</a>(1).<br>
  552. Setting&nbsp;a&nbsp;<a href="#timeout">timeout</a>&nbsp;of&nbsp;zero&nbsp;is&nbsp;the&nbsp;same&nbsp;as&nbsp;<a href="#socket-setblocking">setblocking</a>(0).</tt></dd></dl>
  553. <dl><dt><a name="_socketobject-shutdown"><strong>shutdown</strong></a>(...)</dt><dd><tt><a href="#socket-shutdown">shutdown</a>(flag)<br>
  554. &nbsp;<br>
  555. Shut&nbsp;down&nbsp;the&nbsp;reading&nbsp;side&nbsp;of&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;(flag&nbsp;==&nbsp;SHUT_RD),&nbsp;the&nbsp;writing&nbsp;side<br>
  556. of&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;(flag&nbsp;==&nbsp;SHUT_WR),&nbsp;or&nbsp;both&nbsp;ends&nbsp;(flag&nbsp;==&nbsp;SHUT_RDWR).</tt></dd></dl>
  557. <hr>
  558. Data descriptors defined here:<br>
  559. <dl><dt><strong>__weakref__</strong></dt>
  560. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  561. </dl>
  562. <dl><dt><strong>family</strong></dt>
  563. <dd><tt>the&nbsp;socket&nbsp;family</tt></dd>
  564. </dl>
  565. <dl><dt><strong>proto</strong></dt>
  566. <dd><tt>the&nbsp;socket&nbsp;protocol</tt></dd>
  567. </dl>
  568. <dl><dt><strong>recv</strong></dt>
  569. </dl>
  570. <dl><dt><strong>recv_into</strong></dt>
  571. </dl>
  572. <dl><dt><strong>recvfrom</strong></dt>
  573. </dl>
  574. <dl><dt><strong>recvfrom_into</strong></dt>
  575. </dl>
  576. <dl><dt><strong>send</strong></dt>
  577. </dl>
  578. <dl><dt><strong>sendto</strong></dt>
  579. </dl>
  580. <dl><dt><strong>type</strong></dt>
  581. <dd><tt>the&nbsp;socket&nbsp;type</tt></dd>
  582. </dl>
  583. </td></tr></table> <p>
  584. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  585. <tr bgcolor="#ffc8d8">
  586. <td colspan=3 valign=bottom>&nbsp;<br>
  587. <font color="#000000" face="helvetica, arial"><a name="timeout">class <strong>timeout</strong></a>(<a href="socket.html#error">error</a>)</font></td></tr>
  588. <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  589. <td width="100%"><dl><dt>Method resolution order:</dt>
  590. <dd><a href="socket.html#timeout">timeout</a></dd>
  591. <dd><a href="socket.html#error">error</a></dd>
  592. <dd><a href="exceptions.html#IOError">exceptions.IOError</a></dd>
  593. <dd><a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a></dd>
  594. <dd><a href="exceptions.html#StandardError">exceptions.StandardError</a></dd>
  595. <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
  596. <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
  597. <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
  598. </dl>
  599. <hr>
  600. Data descriptors inherited from <a href="socket.html#error">error</a>:<br>
  601. <dl><dt><strong>__weakref__</strong></dt>
  602. <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  603. </dl>
  604. <hr>
  605. Methods inherited from <a href="exceptions.html#IOError">exceptions.IOError</a>:<br>
  606. <dl><dt><a name="timeout-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#timeout-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;help(type(x))&nbsp;for&nbsp;signature</tt></dd></dl>
  607. <hr>
  608. Data and other attributes inherited from <a href="exceptions.html#IOError">exceptions.IOError</a>:<br>
  609. <dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#timeout-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
  610. <hr>
  611. Methods inherited from <a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>:<br>
  612. <dl><dt><a name="timeout-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
  613. <dl><dt><a name="timeout-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#timeout-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
  614. <hr>
  615. Data descriptors inherited from <a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>:<br>
  616. <dl><dt><strong>errno</strong></dt>
  617. <dd><tt>exception&nbsp;errno</tt></dd>
  618. </dl>
  619. <dl><dt><strong>filename</strong></dt>
  620. <dd><tt>exception&nbsp;filename</tt></dd>
  621. </dl>
  622. <dl><dt><strong>strerror</strong></dt>
  623. <dd><tt>exception&nbsp;strerror</tt></dd>
  624. </dl>
  625. <hr>
  626. Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  627. <dl><dt><a name="timeout-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#timeout-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
  628. <dl><dt><a name="timeout-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#timeout-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
  629. <dl><dt><a name="timeout-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#timeout-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
  630. <dl><dt><a name="timeout-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#timeout-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
  631. &nbsp;<br>
  632. Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
  633. <dl><dt><a name="timeout-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#timeout-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
  634. <dl><dt><a name="timeout-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#timeout-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
  635. <dl><dt><a name="timeout-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
  636. <dl><dt><a name="timeout-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
  637. <hr>
  638. Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
  639. <dl><dt><strong>__dict__</strong></dt>
  640. </dl>
  641. <dl><dt><strong>args</strong></dt>
  642. </dl>
  643. <dl><dt><strong>message</strong></dt>
  644. </dl>
  645. </td></tr></table></td></tr></table><p>
  646. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  647. <tr bgcolor="#eeaa77">
  648. <td colspan=3 valign=bottom>&nbsp;<br>
  649. <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
  650. <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  651. <td width="100%"><dl><dt><a name="-create_connection"><strong>create_connection</strong></a>(address, timeout<font color="#909090">=&lt;object object&gt;</font>, source_address<font color="#909090">=None</font>)</dt><dd><tt>Connect&nbsp;to&nbsp;*address*&nbsp;and&nbsp;return&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a>.<br>
  652. &nbsp;<br>
  653. Convenience&nbsp;function.&nbsp;&nbsp;Connect&nbsp;to&nbsp;*address*&nbsp;(a&nbsp;2-tuple&nbsp;``(host,<br>
  654. port)``)&nbsp;and&nbsp;return&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a>.&nbsp;&nbsp;Passing&nbsp;the&nbsp;optional<br>
  655. *<a href="#timeout">timeout</a>*&nbsp;parameter&nbsp;will&nbsp;set&nbsp;the&nbsp;<a href="#timeout">timeout</a>&nbsp;on&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;instance<br>
  656. before&nbsp;attempting&nbsp;to&nbsp;connect.&nbsp;&nbsp;If&nbsp;no&nbsp;*<a href="#timeout">timeout</a>*&nbsp;is&nbsp;supplied,&nbsp;the<br>
  657. global&nbsp;default&nbsp;<a href="#timeout">timeout</a>&nbsp;setting&nbsp;returned&nbsp;by&nbsp;:func:`getdefaulttimeout`<br>
  658. is&nbsp;used.&nbsp;&nbsp;If&nbsp;*source_address*&nbsp;is&nbsp;set&nbsp;it&nbsp;must&nbsp;be&nbsp;a&nbsp;tuple&nbsp;of&nbsp;(host,&nbsp;port)<br>
  659. for&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;to&nbsp;bind&nbsp;as&nbsp;a&nbsp;source&nbsp;address&nbsp;before&nbsp;making&nbsp;the&nbsp;connection.<br>
  660. An&nbsp;host&nbsp;of&nbsp;''&nbsp;or&nbsp;port&nbsp;0&nbsp;tells&nbsp;the&nbsp;OS&nbsp;to&nbsp;use&nbsp;the&nbsp;default.</tt></dd></dl>
  661. <dl><dt><a name="-fromfd"><strong>fromfd</strong></a>(...)</dt><dd><tt><a href="#-fromfd">fromfd</a>(fd,&nbsp;family,&nbsp;type[,&nbsp;proto])&nbsp;-&gt;&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a><br>
  662. &nbsp;<br>
  663. Create&nbsp;a&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;from&nbsp;a&nbsp;duplicate&nbsp;of&nbsp;the&nbsp;given<br>
  664. file&nbsp;descriptor.<br>
  665. The&nbsp;remaining&nbsp;arguments&nbsp;are&nbsp;the&nbsp;same&nbsp;as&nbsp;for&nbsp;<a href="#socket">socket</a>().</tt></dd></dl>
  666. <dl><dt><a name="-getaddrinfo"><strong>getaddrinfo</strong></a>(...)</dt><dd><tt><a href="#-getaddrinfo">getaddrinfo</a>(host,&nbsp;port&nbsp;[,&nbsp;family,&nbsp;socktype,&nbsp;proto,&nbsp;flags])<br>
  667. &nbsp;&nbsp;&nbsp;&nbsp;-&gt;&nbsp;list&nbsp;of&nbsp;(family,&nbsp;socktype,&nbsp;proto,&nbsp;canonname,&nbsp;sockaddr)<br>
  668. &nbsp;<br>
  669. Resolve&nbsp;host&nbsp;and&nbsp;port&nbsp;into&nbsp;addrinfo&nbsp;struct.</tt></dd></dl>
  670. <dl><dt><a name="-getdefaulttimeout"><strong>getdefaulttimeout</strong></a>(...)</dt><dd><tt><a href="#-getdefaulttimeout">getdefaulttimeout</a>()&nbsp;-&gt;&nbsp;<a href="#timeout">timeout</a><br>
  671. &nbsp;<br>
  672. Returns&nbsp;the&nbsp;default&nbsp;<a href="#timeout">timeout</a>&nbsp;in&nbsp;seconds&nbsp;(float)&nbsp;for&nbsp;new&nbsp;<a href="#socket">socket</a>&nbsp;objects.<br>
  673. A&nbsp;value&nbsp;of&nbsp;None&nbsp;indicates&nbsp;that&nbsp;new&nbsp;<a href="#socket">socket</a>&nbsp;objects&nbsp;have&nbsp;no&nbsp;<a href="#timeout">timeout</a>.<br>
  674. When&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;module&nbsp;is&nbsp;first&nbsp;imported,&nbsp;the&nbsp;default&nbsp;is&nbsp;None.</tt></dd></dl>
  675. <dl><dt><a name="-getfqdn"><strong>getfqdn</strong></a>(name<font color="#909090">=''</font>)</dt><dd><tt>Get&nbsp;fully&nbsp;qualified&nbsp;domain&nbsp;name&nbsp;from&nbsp;name.<br>
  676. &nbsp;<br>
  677. An&nbsp;empty&nbsp;argument&nbsp;is&nbsp;interpreted&nbsp;as&nbsp;meaning&nbsp;the&nbsp;local&nbsp;host.<br>
  678. &nbsp;<br>
  679. First&nbsp;the&nbsp;hostname&nbsp;returned&nbsp;by&nbsp;<a href="#-gethostbyaddr">gethostbyaddr</a>()&nbsp;is&nbsp;checked,&nbsp;then<br>
  680. possibly&nbsp;existing&nbsp;aliases.&nbsp;In&nbsp;case&nbsp;no&nbsp;FQDN&nbsp;is&nbsp;available,&nbsp;hostname<br>
  681. from&nbsp;<a href="#-gethostname">gethostname</a>()&nbsp;is&nbsp;returned.</tt></dd></dl>
  682. <dl><dt><a name="-gethostbyaddr"><strong>gethostbyaddr</strong></a>(...)</dt><dd><tt><a href="#-gethostbyaddr">gethostbyaddr</a>(host)&nbsp;-&gt;&nbsp;(name,&nbsp;aliaslist,&nbsp;addresslist)<br>
  683. &nbsp;<br>
  684. Return&nbsp;the&nbsp;true&nbsp;host&nbsp;name,&nbsp;a&nbsp;list&nbsp;of&nbsp;aliases,&nbsp;and&nbsp;a&nbsp;list&nbsp;of&nbsp;IP&nbsp;addresses,<br>
  685. for&nbsp;a&nbsp;host.&nbsp;&nbsp;The&nbsp;host&nbsp;argument&nbsp;is&nbsp;a&nbsp;string&nbsp;giving&nbsp;a&nbsp;host&nbsp;name&nbsp;or&nbsp;IP&nbsp;number.</tt></dd></dl>
  686. <dl><dt><a name="-gethostbyname"><strong>gethostbyname</strong></a>(...)</dt><dd><tt><a href="#-gethostbyname">gethostbyname</a>(host)&nbsp;-&gt;&nbsp;address<br>
  687. &nbsp;<br>
  688. Return&nbsp;the&nbsp;IP&nbsp;address&nbsp;(a&nbsp;string&nbsp;of&nbsp;the&nbsp;form&nbsp;'255.255.255.255')&nbsp;for&nbsp;a&nbsp;host.</tt></dd></dl>
  689. <dl><dt><a name="-gethostbyname_ex"><strong>gethostbyname_ex</strong></a>(...)</dt><dd><tt><a href="#-gethostbyname_ex">gethostbyname_ex</a>(host)&nbsp;-&gt;&nbsp;(name,&nbsp;aliaslist,&nbsp;addresslist)<br>
  690. &nbsp;<br>
  691. Return&nbsp;the&nbsp;true&nbsp;host&nbsp;name,&nbsp;a&nbsp;list&nbsp;of&nbsp;aliases,&nbsp;and&nbsp;a&nbsp;list&nbsp;of&nbsp;IP&nbsp;addresses,<br>
  692. for&nbsp;a&nbsp;host.&nbsp;&nbsp;The&nbsp;host&nbsp;argument&nbsp;is&nbsp;a&nbsp;string&nbsp;giving&nbsp;a&nbsp;host&nbsp;name&nbsp;or&nbsp;IP&nbsp;number.</tt></dd></dl>
  693. <dl><dt><a name="-gethostname"><strong>gethostname</strong></a>(...)</dt><dd><tt><a href="#-gethostname">gethostname</a>()&nbsp;-&gt;&nbsp;string<br>
  694. &nbsp;<br>
  695. Return&nbsp;the&nbsp;current&nbsp;host&nbsp;name.</tt></dd></dl>
  696. <dl><dt><a name="-getnameinfo"><strong>getnameinfo</strong></a>(...)</dt><dd><tt><a href="#-getnameinfo">getnameinfo</a>(sockaddr,&nbsp;flags)&nbsp;--&gt;&nbsp;(host,&nbsp;port)<br>
  697. &nbsp;<br>
  698. Get&nbsp;host&nbsp;and&nbsp;port&nbsp;for&nbsp;a&nbsp;sockaddr.</tt></dd></dl>
  699. <dl><dt><a name="-getprotobyname"><strong>getprotobyname</strong></a>(...)</dt><dd><tt><a href="#-getprotobyname">getprotobyname</a>(name)&nbsp;-&gt;&nbsp;integer<br>
  700. &nbsp;<br>
  701. Return&nbsp;the&nbsp;protocol&nbsp;number&nbsp;for&nbsp;the&nbsp;named&nbsp;protocol.&nbsp;&nbsp;(Rarely&nbsp;used.)</tt></dd></dl>
  702. <dl><dt><a name="-getservbyname"><strong>getservbyname</strong></a>(...)</dt><dd><tt><a href="#-getservbyname">getservbyname</a>(servicename[,&nbsp;protocolname])&nbsp;-&gt;&nbsp;integer<br>
  703. &nbsp;<br>
  704. Return&nbsp;a&nbsp;port&nbsp;number&nbsp;from&nbsp;a&nbsp;service&nbsp;name&nbsp;and&nbsp;protocol&nbsp;name.<br>
  705. The&nbsp;optional&nbsp;protocol&nbsp;name,&nbsp;if&nbsp;given,&nbsp;should&nbsp;be&nbsp;'tcp'&nbsp;or&nbsp;'udp',<br>
  706. otherwise&nbsp;any&nbsp;protocol&nbsp;will&nbsp;match.</tt></dd></dl>
  707. <dl><dt><a name="-getservbyport"><strong>getservbyport</strong></a>(...)</dt><dd><tt><a href="#-getservbyport">getservbyport</a>(port[,&nbsp;protocolname])&nbsp;-&gt;&nbsp;string<br>
  708. &nbsp;<br>
  709. Return&nbsp;the&nbsp;service&nbsp;name&nbsp;from&nbsp;a&nbsp;port&nbsp;number&nbsp;and&nbsp;protocol&nbsp;name.<br>
  710. The&nbsp;optional&nbsp;protocol&nbsp;name,&nbsp;if&nbsp;given,&nbsp;should&nbsp;be&nbsp;'tcp'&nbsp;or&nbsp;'udp',<br>
  711. otherwise&nbsp;any&nbsp;protocol&nbsp;will&nbsp;match.</tt></dd></dl>
  712. <dl><dt><a name="-htonl"><strong>htonl</strong></a>(...)</dt><dd><tt><a href="#-htonl">htonl</a>(integer)&nbsp;-&gt;&nbsp;integer<br>
  713. &nbsp;<br>
  714. Convert&nbsp;a&nbsp;32-bit&nbsp;integer&nbsp;from&nbsp;host&nbsp;to&nbsp;network&nbsp;byte&nbsp;order.</tt></dd></dl>
  715. <dl><dt><a name="-htons"><strong>htons</strong></a>(...)</dt><dd><tt><a href="#-htons">htons</a>(integer)&nbsp;-&gt;&nbsp;integer<br>
  716. &nbsp;<br>
  717. Convert&nbsp;a&nbsp;16-bit&nbsp;integer&nbsp;from&nbsp;host&nbsp;to&nbsp;network&nbsp;byte&nbsp;order.</tt></dd></dl>
  718. <dl><dt><a name="-inet_aton"><strong>inet_aton</strong></a>(...)</dt><dd><tt><a href="#-inet_aton">inet_aton</a>(string)&nbsp;-&gt;&nbsp;packed&nbsp;32-bit&nbsp;IP&nbsp;representation<br>
  719. &nbsp;<br>
  720. Convert&nbsp;an&nbsp;IP&nbsp;address&nbsp;in&nbsp;string&nbsp;format&nbsp;(123.45.67.89)&nbsp;to&nbsp;the&nbsp;32-bit&nbsp;packed<br>
  721. binary&nbsp;format&nbsp;used&nbsp;in&nbsp;low-level&nbsp;network&nbsp;functions.</tt></dd></dl>
  722. <dl><dt><a name="-inet_ntoa"><strong>inet_ntoa</strong></a>(...)</dt><dd><tt><a href="#-inet_ntoa">inet_ntoa</a>(packed_ip)&nbsp;-&gt;&nbsp;ip_address_string<br>
  723. &nbsp;<br>
  724. Convert&nbsp;an&nbsp;IP&nbsp;address&nbsp;from&nbsp;32-bit&nbsp;packed&nbsp;binary&nbsp;format&nbsp;to&nbsp;string&nbsp;format</tt></dd></dl>
  725. <dl><dt><a name="-inet_ntop"><strong>inet_ntop</strong></a>(...)</dt><dd><tt><a href="#-inet_ntop">inet_ntop</a>(af,&nbsp;packed_ip)&nbsp;-&gt;&nbsp;string&nbsp;formatted&nbsp;IP&nbsp;address<br>
  726. &nbsp;<br>
  727. Convert&nbsp;a&nbsp;packed&nbsp;IP&nbsp;address&nbsp;of&nbsp;the&nbsp;given&nbsp;family&nbsp;to&nbsp;string&nbsp;format.</tt></dd></dl>
  728. <dl><dt><a name="-inet_pton"><strong>inet_pton</strong></a>(...)</dt><dd><tt><a href="#-inet_pton">inet_pton</a>(af,&nbsp;ip)&nbsp;-&gt;&nbsp;packed&nbsp;IP&nbsp;address&nbsp;string<br>
  729. &nbsp;<br>
  730. Convert&nbsp;an&nbsp;IP&nbsp;address&nbsp;from&nbsp;string&nbsp;format&nbsp;to&nbsp;a&nbsp;packed&nbsp;string&nbsp;suitable<br>
  731. for&nbsp;use&nbsp;with&nbsp;low-level&nbsp;network&nbsp;functions.</tt></dd></dl>
  732. <dl><dt><a name="-ntohl"><strong>ntohl</strong></a>(...)</dt><dd><tt><a href="#-ntohl">ntohl</a>(integer)&nbsp;-&gt;&nbsp;integer<br>
  733. &nbsp;<br>
  734. Convert&nbsp;a&nbsp;32-bit&nbsp;integer&nbsp;from&nbsp;network&nbsp;to&nbsp;host&nbsp;byte&nbsp;order.</tt></dd></dl>
  735. <dl><dt><a name="-ntohs"><strong>ntohs</strong></a>(...)</dt><dd><tt><a href="#-ntohs">ntohs</a>(integer)&nbsp;-&gt;&nbsp;integer<br>
  736. &nbsp;<br>
  737. Convert&nbsp;a&nbsp;16-bit&nbsp;integer&nbsp;from&nbsp;network&nbsp;to&nbsp;host&nbsp;byte&nbsp;order.</tt></dd></dl>
  738. <dl><dt><a name="-setdefaulttimeout"><strong>setdefaulttimeout</strong></a>(...)</dt><dd><tt><a href="#-setdefaulttimeout">setdefaulttimeout</a>(<a href="#timeout">timeout</a>)<br>
  739. &nbsp;<br>
  740. Set&nbsp;the&nbsp;default&nbsp;<a href="#timeout">timeout</a>&nbsp;in&nbsp;seconds&nbsp;(float)&nbsp;for&nbsp;new&nbsp;<a href="#socket">socket</a>&nbsp;objects.<br>
  741. A&nbsp;value&nbsp;of&nbsp;None&nbsp;indicates&nbsp;that&nbsp;new&nbsp;<a href="#socket">socket</a>&nbsp;objects&nbsp;have&nbsp;no&nbsp;<a href="#timeout">timeout</a>.<br>
  742. When&nbsp;the&nbsp;<a href="#socket">socket</a>&nbsp;module&nbsp;is&nbsp;first&nbsp;imported,&nbsp;the&nbsp;default&nbsp;is&nbsp;None.</tt></dd></dl>
  743. <dl><dt><a name="-socketpair"><strong>socketpair</strong></a>(...)</dt><dd><tt><a href="#-socketpair">socketpair</a>([family[,&nbsp;type[,&nbsp;proto]]])&nbsp;-&gt;&nbsp;(<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;<a href="#socket">socket</a>&nbsp;<a href="__builtin__.html#object">object</a>)<br>
  744. &nbsp;<br>
  745. Create&nbsp;a&nbsp;pair&nbsp;of&nbsp;<a href="#socket">socket</a>&nbsp;objects&nbsp;from&nbsp;the&nbsp;sockets&nbsp;returned&nbsp;by&nbsp;the&nbsp;platform<br>
  746. <a href="#-socketpair">socketpair</a>()&nbsp;function.<br>
  747. The&nbsp;arguments&nbsp;are&nbsp;the&nbsp;same&nbsp;as&nbsp;for&nbsp;<a href="#socket">socket</a>()&nbsp;except&nbsp;the&nbsp;default&nbsp;family&nbsp;is<br>
  748. AF_UNIX&nbsp;if&nbsp;defined&nbsp;on&nbsp;the&nbsp;platform;&nbsp;otherwise,&nbsp;the&nbsp;default&nbsp;is&nbsp;AF_INET.</tt></dd></dl>
  749. </td></tr></table><p>
  750. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  751. <tr bgcolor="#55aa55">
  752. <td colspan=3 valign=bottom>&nbsp;<br>
  753. <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
  754. <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  755. <td width="100%"><strong>AF_APPLETALK</strong> = 5<br>
  756. <strong>AF_ASH</strong> = 18<br>
  757. <strong>AF_ATMPVC</strong> = 8<br>
  758. <strong>AF_ATMSVC</strong> = 20<br>
  759. <strong>AF_AX25</strong> = 3<br>
  760. <strong>AF_BLUETOOTH</strong> = 31<br>
  761. <strong>AF_BRIDGE</strong> = 7<br>
  762. <strong>AF_DECnet</strong> = 12<br>
  763. <strong>AF_ECONET</strong> = 19<br>
  764. <strong>AF_INET</strong> = 2<br>
  765. <strong>AF_INET6</strong> = 10<br>
  766. <strong>AF_IPX</strong> = 4<br>
  767. <strong>AF_IRDA</strong> = 23<br>
  768. <strong>AF_KEY</strong> = 15<br>
  769. <strong>AF_LLC</strong> = 26<br>
  770. <strong>AF_NETBEUI</strong> = 13<br>
  771. <strong>AF_NETLINK</strong> = 16<br>
  772. <strong>AF_NETROM</strong> = 6<br>
  773. <strong>AF_PACKET</strong> = 17<br>
  774. <strong>AF_PPPOX</strong> = 24<br>
  775. <strong>AF_ROSE</strong> = 11<br>
  776. <strong>AF_ROUTE</strong> = 16<br>
  777. <strong>AF_SECURITY</strong> = 14<br>
  778. <strong>AF_SNA</strong> = 22<br>
  779. <strong>AF_TIPC</strong> = 30<br>
  780. <strong>AF_UNIX</strong> = 1<br>
  781. <strong>AF_UNSPEC</strong> = 0<br>
  782. <strong>AF_WANPIPE</strong> = 25<br>
  783. <strong>AF_X25</strong> = 9<br>
  784. <strong>AI_ADDRCONFIG</strong> = 32<br>
  785. <strong>AI_ALL</strong> = 16<br>
  786. <strong>AI_CANONNAME</strong> = 2<br>
  787. <strong>AI_NUMERICHOST</strong> = 4<br>
  788. <strong>AI_NUMERICSERV</strong> = 1024<br>
  789. <strong>AI_PASSIVE</strong> = 1<br>
  790. <strong>AI_V4MAPPED</strong> = 8<br>
  791. <strong>BDADDR_ANY</strong> = '00:00:00:00:00:00'<br>
  792. <strong>BDADDR_LOCAL</strong> = '00:00:00:FF:FF:FF'<br>
  793. <strong>BTPROTO_HCI</strong> = 1<br>
  794. <strong>BTPROTO_L2CAP</strong> = 0<br>
  795. <strong>BTPROTO_RFCOMM</strong> = 3<br>
  796. <strong>BTPROTO_SCO</strong> = 2<br>
  797. <strong>CAPI</strong> = &lt;capsule object "_socket.CAPI"&gt;<br>
  798. <strong>EAI_ADDRFAMILY</strong> = -9<br>
  799. <strong>EAI_AGAIN</strong> = -3<br>
  800. <strong>EAI_BADFLAGS</strong> = -1<br>
  801. <strong>EAI_FAIL</strong> = -4<br>
  802. <strong>EAI_FAMILY</strong> = -6<br>
  803. <strong>EAI_MEMORY</strong> = -10<br>
  804. <strong>EAI_NODATA</strong> = -5<br>
  805. <strong>EAI_NONAME</strong> = -2<br>
  806. <strong>EAI_OVERFLOW</strong> = -12<br>
  807. <strong>EAI_SERVICE</strong> = -8<br>
  808. <strong>EAI_SOCKTYPE</strong> = -7<br>
  809. <strong>EAI_SYSTEM</strong> = -11<br>
  810. <strong>HCI_DATA_DIR</strong> = 1<br>
  811. <strong>HCI_FILTER</strong> = 2<br>
  812. <strong>HCI_TIME_STAMP</strong> = 3<br>
  813. <strong>INADDR_ALLHOSTS_GROUP</strong> = 3758096385<br>
  814. <strong>INADDR_ANY</strong> = 0<br>
  815. <strong>INADDR_BROADCAST</strong> = 4294967295<br>
  816. <strong>INADDR_LOOPBACK</strong> = 2130706433<br>
  817. <strong>INADDR_MAX_LOCAL_GROUP</strong> = 3758096639<br>
  818. <strong>INADDR_NONE</strong> = 4294967295<br>
  819. <strong>INADDR_UNSPEC_GROUP</strong> = 3758096384<br>
  820. <strong>IPPORT_RESERVED</strong> = 1024<br>
  821. <strong>IPPORT_USERRESERVED</strong> = 5000<br>
  822. <strong>IPPROTO_AH</strong> = 51<br>
  823. <strong>IPPROTO_DSTOPTS</strong> = 60<br>
  824. <strong>IPPROTO_EGP</strong> = 8<br>
  825. <strong>IPPROTO_ESP</strong> = 50<br>
  826. <strong>IPPROTO_FRAGMENT</strong> = 44<br>
  827. <strong>IPPROTO_GRE</strong> = 47<br>
  828. <strong>IPPROTO_HOPOPTS</strong> = 0<br>
  829. <strong>IPPROTO_ICMP</strong> = 1<br>
  830. <strong>IPPROTO_ICMPV6</strong> = 58<br>
  831. <strong>IPPROTO_IDP</strong> = 22<br>
  832. <strong>IPPROTO_IGMP</strong> = 2<br>
  833. <strong>IPPROTO_IP</strong> = 0<br>
  834. <strong>IPPROTO_IPIP</strong> = 4<br>
  835. <strong>IPPROTO_IPV6</strong> = 41<br>
  836. <strong>IPPROTO_NONE</strong> = 59<br>
  837. <strong>IPPROTO_PIM</strong> = 103<br>
  838. <strong>IPPROTO_PUP</strong> = 12<br>
  839. <strong>IPPROTO_RAW</strong> = 255<br>
  840. <strong>IPPROTO_ROUTING</strong> = 43<br>
  841. <strong>IPPROTO_RSVP</strong> = 46<br>
  842. <strong>IPPROTO_TCP</strong> = 6<br>
  843. <strong>IPPROTO_TP</strong> = 29<br>
  844. <strong>IPPROTO_UDP</strong> = 17<br>
  845. <strong>IPV6_CHECKSUM</strong> = 7<br>
  846. <strong>IPV6_DSTOPTS</strong> = 59<br>
  847. <strong>IPV6_HOPLIMIT</strong> = 52<br>
  848. <strong>IPV6_HOPOPTS</strong> = 54<br>
  849. <strong>IPV6_JOIN_GROUP</strong> = 20<br>
  850. <strong>IPV6_LEAVE_GROUP</strong> = 21<br>
  851. <strong>IPV6_MULTICAST_HOPS</strong> = 18<br>
  852. <strong>IPV6_MULTICAST_IF</strong> = 17<br>
  853. <strong>IPV6_MULTICAST_LOOP</strong> = 19<br>
  854. <strong>IPV6_NEXTHOP</strong> = 9<br>
  855. <strong>IPV6_PKTINFO</strong> = 50<br>
  856. <strong>IPV6_RECVDSTOPTS</strong> = 58<br>
  857. <strong>IPV6_RECVHOPLIMIT</strong> = 51<br>
  858. <strong>IPV6_RECVHOPOPTS</strong> = 53<br>
  859. <strong>IPV6_RECVPKTINFO</strong> = 49<br>
  860. <strong>IPV6_RECVRTHDR</strong> = 56<br>
  861. <strong>IPV6_RECVTCLASS</strong> = 66<br>
  862. <strong>IPV6_RTHDR</strong> = 57<br>
  863. <strong>IPV6_RTHDRDSTOPTS</strong> = 55<br>
  864. <strong>IPV6_RTHDR_TYPE_0</strong> = 0<br>
  865. <strong>IPV6_TCLASS</strong> = 67<br>
  866. <strong>IPV6_UNICAST_HOPS</strong> = 16<br>
  867. <strong>IPV6_V6ONLY</strong> = 26<br>
  868. <strong>IP_ADD_MEMBERSHIP</strong> = 35<br>
  869. <strong>IP_DEFAULT_MULTICAST_LOOP</strong> = 1<br>
  870. <strong>IP_DEFAULT_MULTICAST_TTL</strong> = 1<br>
  871. <strong>IP_DROP_MEMBERSHIP</strong> = 36<br>
  872. <strong>IP_HDRINCL</strong> = 3<br>
  873. <strong>IP_MAX_MEMBERSHIPS</strong> = 20<br>
  874. <strong>IP_MULTICAST_IF</strong> = 32<br>
  875. <strong>IP_MULTICAST_LOOP</strong> = 34<br>
  876. <strong>IP_MULTICAST_TTL</strong> = 33<br>
  877. <strong>IP_OPTIONS</strong> = 4<br>
  878. <strong>IP_RECVOPTS</strong> = 6<br>
  879. <strong>IP_RECVRETOPTS</strong> = 7<br>
  880. <strong>IP_RETOPTS</strong> = 7<br>
  881. <strong>IP_TOS</strong> = 1<br>
  882. <strong>IP_TTL</strong> = 2<br>
  883. <strong>MSG_CTRUNC</strong> = 8<br>
  884. <strong>MSG_DONTROUTE</strong> = 4<br>
  885. <strong>MSG_DONTWAIT</strong> = 64<br>
  886. <strong>MSG_EOR</strong> = 128<br>
  887. <strong>MSG_OOB</strong> = 1<br>
  888. <strong>MSG_PEEK</strong> = 2<br>
  889. <strong>MSG_TRUNC</strong> = 32<br>
  890. <strong>MSG_WAITALL</strong> = 256<br>
  891. <strong>NETLINK_DNRTMSG</strong> = 14<br>
  892. <strong>NETLINK_FIREWALL</strong> = 3<br>
  893. <strong>NETLINK_IP6_FW</strong> = 13<br>
  894. <strong>NETLINK_NFLOG</strong> = 5<br>
  895. <strong>NETLINK_ROUTE</strong> = 0<br>
  896. <strong>NETLINK_USERSOCK</strong> = 2<br>
  897. <strong>NETLINK_XFRM</strong> = 6<br>
  898. <strong>NI_DGRAM</strong> = 16<br>
  899. <strong>NI_MAXHOST</strong> = 1025<br>
  900. <strong>NI_MAXSERV</strong> = 32<br>
  901. <strong>NI_NAMEREQD</strong> = 8<br>
  902. <strong>NI_NOFQDN</strong> = 4<br>
  903. <strong>NI_NUMERICHOST</strong> = 1<br>
  904. <strong>NI_NUMERICSERV</strong> = 2<br>
  905. <strong>PACKET_BROADCAST</strong> = 1<br>
  906. <strong>PACKET_FASTROUTE</strong> = 6<br>
  907. <strong>PACKET_HOST</strong> = 0<br>
  908. <strong>PACKET_LOOPBACK</strong> = 5<br>
  909. <strong>PACKET_MULTICAST</strong> = 2<br>
  910. <strong>PACKET_OTHERHOST</strong> = 3<br>
  911. <strong>PACKET_OUTGOING</strong> = 4<br>
  912. <strong>PF_PACKET</strong> = 17<br>
  913. <strong>SHUT_RD</strong> = 0<br>
  914. <strong>SHUT_RDWR</strong> = 2<br>
  915. <strong>SHUT_WR</strong> = 1<br>
  916. <strong>SOCK_DGRAM</strong> = 2<br>
  917. <strong>SOCK_RAW</strong> = 3<br>
  918. <strong>SOCK_RDM</strong> = 4<br>
  919. <strong>SOCK_SEQPACKET</strong> = 5<br>
  920. <strong>SOCK_STREAM</strong> = 1<br>
  921. <strong>SOL_HCI</strong> = 0<br>
  922. <strong>SOL_IP</strong> = 0<br>
  923. <strong>SOL_SOCKET</strong> = 1<br>
  924. <strong>SOL_TCP</strong> = 6<br>
  925. <strong>SOL_TIPC</strong> = 271<br>
  926. <strong>SOL_UDP</strong> = 17<br>
  927. <strong>SOMAXCONN</strong> = 128<br>
  928. <strong>SO_ACCEPTCONN</strong> = 30<br>
  929. <strong>SO_BROADCAST</strong> = 6<br>
  930. <strong>SO_DEBUG</strong> = 1<br>
  931. <strong>SO_DONTROUTE</strong> = 5<br>
  932. <strong>SO_ERROR</strong> = 4<br>
  933. <strong>SO_KEEPALIVE</strong> = 9<br>
  934. <strong>SO_LINGER</strong> = 13<br>
  935. <strong>SO_OOBINLINE</strong> = 10<br>
  936. <strong>SO_RCVBUF</strong> = 8<br>
  937. <strong>SO_RCVLOWAT</strong> = 18<br>
  938. <strong>SO_RCVTIMEO</strong> = 20<br>
  939. <strong>SO_REUSEADDR</strong> = 2<br>
  940. <strong>SO_SNDBUF</strong> = 7<br>
  941. <strong>SO_SNDLOWAT</strong> = 19<br>
  942. <strong>SO_SNDTIMEO</strong> = 21<br>
  943. <strong>SO_TYPE</strong> = 3<br>
  944. <strong>TCP_CORK</strong> = 3<br>
  945. <strong>TCP_DEFER_ACCEPT</strong> = 9<br>
  946. <strong>TCP_INFO</strong> = 11<br>
  947. <strong>TCP_KEEPCNT</strong> = 6<br>
  948. <strong>TCP_KEEPIDLE</strong> = 4<br>
  949. <strong>TCP_KEEPINTVL</strong> = 5<br>
  950. <strong>TCP_LINGER2</strong> = 8<br>
  951. <strong>TCP_MAXSEG</strong> = 2<br>
  952. <strong>TCP_NODELAY</strong> = 1<br>
  953. <strong>TCP_QUICKACK</strong> = 12<br>
  954. <strong>TCP_SYNCNT</strong> = 7<br>
  955. <strong>TCP_WINDOW_CLAMP</strong> = 10<br>
  956. <strong>TIPC_ADDR_ID</strong> = 3<br>
  957. <strong>TIPC_ADDR_NAME</strong> = 2<br>
  958. <strong>TIPC_ADDR_NAMESEQ</strong> = 1<br>
  959. <strong>TIPC_CFG_SRV</strong> = 0<br>
  960. <strong>TIPC_CLUSTER_SCOPE</strong> = 2<br>
  961. <strong>TIPC_CONN_TIMEOUT</strong> = 130<br>
  962. <strong>TIPC_CRITICAL_IMPORTANCE</strong> = 3<br>
  963. <strong>TIPC_DEST_DROPPABLE</strong> = 129<br>
  964. <strong>TIPC_HIGH_IMPORTANCE</strong> = 2<br>
  965. <strong>TIPC_IMPORTANCE</strong> = 127<br>
  966. <strong>TIPC_LOW_IMPORTANCE</strong> = 0<br>
  967. <strong>TIPC_MEDIUM_IMPORTANCE</strong> = 1<br>
  968. <strong>TIPC_NODE_SCOPE</strong> = 3<br>
  969. <strong>TIPC_PUBLISHED</strong> = 1<br>
  970. <strong>TIPC_SRC_DROPPABLE</strong> = 128<br>
  971. <strong>TIPC_SUBSCR_TIMEOUT</strong> = 3<br>
  972. <strong>TIPC_SUB_CANCEL</strong> = 4<br>
  973. <strong>TIPC_SUB_PORTS</strong> = 1<br>
  974. <strong>TIPC_SUB_SERVICE</strong> = 2<br>
  975. <strong>TIPC_TOP_SRV</strong> = 1<br>
  976. <strong>TIPC_WAIT_FOREVER</strong> = -1<br>
  977. <strong>TIPC_WITHDRAWN</strong> = 2<br>
  978. <strong>TIPC_ZONE_SCOPE</strong> = 1<br>
  979. <strong>__all__</strong> = ['getfqdn', 'create_connection', 'AF_APPLETALK', 'AF_ASH', 'AF_ATMPVC', 'AF_ATMSVC', 'AF_AX25', 'AF_BLUETOOTH', 'AF_BRIDGE', 'AF_DECnet', 'AF_ECONET', 'AF_INET', 'AF_INET6', 'AF_IPX', 'AF_IRDA', 'AF_KEY', 'AF_LLC', 'AF_NETBEUI', 'AF_NETLINK', 'AF_NETROM', ...]<br>
  980. <strong>has_ipv6</strong> = True</td></tr></table>
  981. </body></html>