Domů Procházet Nápověda
Přihlásit se
SleepyHackers
/
sleepermud
Sledovat 2
Oblíbit 0
Rozštěpit 1
Soubory Úkoly 0 Pull Requesty 0 Wiki
Větev: master
Větve Značky
sleepermud
/
html
/
pydocs
/
mudsock.html

mudsock.html 8.7 KB
Trvalý odkaz Historie Surový

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144 
  1. 

  2. <!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
    3. 

  3. <html><head><title>Python: mudsock</title>
    4. 

  4. </head><body bgcolor="#f0f0f8">
    5. 

  5. 

  6. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
    7. 

  7. <tr bgcolor="#7799ee">
    8. 

  8. <td valign=bottom>&nbsp;<br>
    9. 

  9. <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>mudsock</strong></big></big></font></td
    10. 

  10. ><td align=right valign=bottom
    11. 

  11. ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br>(built-in)</font></td></tr></table>
    12. 

  12.     <p><tt>Contains&nbsp;the&nbsp;Python&nbsp;wrapper&nbsp;for&nbsp;sockets,&nbsp;and&nbsp;utilities&nbsp;for&nbsp;listing<br>
    13. 

  13. currently&nbsp;connected&nbsp;sockets.</tt></p>
    14. 

  14. <p>
    15. 

  15. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    16. 

  16. <tr bgcolor="#ee77aa">
    17. 

  17. <td colspan=3 valign=bottom>&nbsp;<br>
    18. 

  18. <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
    19. 

  19.     
    20. 

  20. <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    21. 

  21. <td width="100%"><dl>
    22. 

  22. <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
    23. 

  23. </font></dt><dd>
    24. 

  24. <dl>
    25. 

  25. <dt><font face="helvetica, arial"><a href="mudsock.html#Mudsock">Mudsock</a>
    26. 

  26. </font></dt></dl>
    27. 

  27. </dd>
    28. 

  28. </dl>
    29. 

  29.  <p>
    30. 

  30. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    31. 

  31. <tr bgcolor="#ffc8d8">
    32. 

  32. <td colspan=3 valign=bottom>&nbsp;<br>
    33. 

  33. <font color="#000000" face="helvetica, arial"><a name="Mudsock">class <strong>Mudsock</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
    34. 

  34.     
    35. 

  35. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
    36. 

  36. <td colspan=2><tt>Python&nbsp;Socket&nbsp;<a href="__builtin__.html#object">object</a><br>&nbsp;</tt></td></tr>
    37. 

  37. <tr><td>&nbsp;</td>
    38. 

  38. <td width="100%">Methods defined here:<br>
    39. 

  39. <dl><dt><a name="Mudsock-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#Mudsock-__cmp__">__cmp__</a>(y)&nbsp;&lt;==&gt;&nbsp;cmp(x,y)</tt></dd></dl>
    40. 

  40. 

  41. <dl><dt><a name="Mudsock-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Mudsock-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;x.__class__.__doc__&nbsp;for&nbsp;signature</tt></dd></dl>
    42. 

  42. 

  43. <dl><dt><a name="Mudsock-aux"><strong>aux</strong></a>(...)</dt><dd><tt>Alias&nbsp;for&nbsp;mudsock.<a href="#Mudsock">Mudsock</a>.getAuxiliary</tt></dd></dl>
    44. 

  44. 

  45. <dl><dt><a name="Mudsock-bust_prompt"><strong>bust_prompt</strong></a>(...)</dt><dd><tt><a href="#Mudsock-bust_prompt">bust_prompt</a>()<br>
    46. 

  46. &nbsp;<br>
    47. 

  47. Busts&nbsp;the&nbsp;socket's&nbsp;prompt&nbsp;so&nbsp;it&nbsp;will&nbsp;be&nbsp;displayed&nbsp;next&nbsp;pulse.</tt></dd></dl>
    48. 

  48. 

  49. <dl><dt><a name="Mudsock-close"><strong>close</strong></a>(...)</dt><dd><tt><a href="#Mudsock-close">close</a>()<br>
    50. 

  50. &nbsp;<br>
    51. 

  51. Closes&nbsp;the&nbsp;socket's&nbsp;connection.</tt></dd></dl>
    52. 

  52. 

  53. <dl><dt><a name="Mudsock-edit_text"><strong>edit_text</strong></a>(...)</dt><dd><tt><a href="#Mudsock-edit_text">edit_text</a>(dflt_value,&nbsp;on_complete,&nbsp;mode='text')<br>
    54. 

  54. &nbsp;<br>
    55. 

  55. Enter&nbsp;the&nbsp;text&nbsp;editor,&nbsp;and&nbsp;set&nbsp;its&nbsp;default&nbsp;value.&nbsp;When&nbsp;the&nbsp;text&nbsp;editor<br>
    56. 

  56. is&nbsp;edited,&nbsp;call&nbsp;on_complete.&nbsp;This&nbsp;function&nbsp;should&nbsp;take&nbsp;two&nbsp;arguments:<br>
    57. 

  57. the&nbsp;socket&nbsp;doing&nbsp;the&nbsp;editing,&nbsp;and&nbsp;the&nbsp;output&nbsp;of&nbsp;the&nbsp;editor.&nbsp;Mode&nbsp;can<br>
    58. 

  58. be&nbsp;'text'&nbsp;or&nbsp;'script'.</tt></dd></dl>
    59. 

  59. 

  60. <dl><dt><a name="Mudsock-getAuxiliary"><strong>getAuxiliary</strong></a>(...)</dt><dd><tt><a href="#Mudsock-getAuxiliary">getAuxiliary</a>(name)<br>
    61. 

  61. &nbsp;<br>
    62. 

  62. Returns&nbsp;socket's&nbsp;auxiliary&nbsp;data&nbsp;of&nbsp;the&nbsp;specified&nbsp;name.</tt></dd></dl>
    63. 

  63. 

  64. <dl><dt><a name="Mudsock-pop_ih"><strong>pop_ih</strong></a>(...)</dt><dd><tt><a href="#Mudsock-pop_ih">pop_ih</a>()<br>
    65. 

  65. &nbsp;<br>
    66. 

  66. Pops&nbsp;the&nbsp;socket's&nbsp;current&nbsp;input&nbsp;handler&nbsp;from&nbsp;its&nbsp;input&nbsp;handler&nbsp;stack.</tt></dd></dl>
    67. 

  67. 

  68. <dl><dt><a name="Mudsock-push_ih"><strong>push_ih</strong></a>(...)</dt><dd><tt><a href="#Mudsock-push_ih">push_ih</a>(handler_func,&nbsp;prompt_func,&nbsp;state=None)<br>
    69. 

  69. &nbsp;<br>
    70. 

  70. Pushes&nbsp;a&nbsp;new&nbsp;input&nbsp;handler&nbsp;and&nbsp;prompt&nbsp;pair&nbsp;onto&nbsp;the&nbsp;socket's&nbsp;input<br>
    71. 

  71. handler&nbsp;stack.&nbsp;Optionally,&nbsp;a&nbsp;(String)&nbsp;state&nbsp;value&nbsp;can&nbsp;be&nbsp;supplied.<br>
    72. 

  72. Input&nbsp;handlers&nbsp;take&nbsp;two&nbsp;arguments:&nbsp;the&nbsp;socket&nbsp;and&nbsp;a&nbsp;string&nbsp;command.<br>
    73. 

  73. Prompts&nbsp;take&nbsp;one&nbsp;argument:&nbsp;the&nbsp;socket.&nbsp;They&nbsp;should&nbsp;send&nbsp;the&nbsp;relevant<br>
    74. 

  74. text&nbsp;for&nbsp;the&nbsp;prompt&nbsp;to&nbsp;the&nbsp;socket.</tt></dd></dl>
    75. 

  75. 

  76. <dl><dt><a name="Mudsock-replace_ih"><strong>replace_ih</strong></a>(...)</dt><dd><tt>repalce_ih(handler_func,&nbsp;prompt_func,&nbsp;state=None)<br>
    77. 

  77. &nbsp;<br>
    78. 

  78. Calls&nbsp;pop_ih,&nbsp;followed&nbsp;by&nbsp;push_ih.</tt></dd></dl>
    79. 

  79. 

  80. <dl><dt><a name="Mudsock-send"><strong>send</strong></a>(...)</dt><dd><tt><a href="#Mudsock-send">send</a>(mssg,&nbsp;dict&nbsp;=&nbsp;None,&nbsp;newline&nbsp;=&nbsp;True)<br>
    81. 

  81. &nbsp;<br>
    82. 

  82. Sends&nbsp;message&nbsp;to&nbsp;the&nbsp;socket.&nbsp;Messages&nbsp;can&nbsp;have&nbsp;scripts&nbsp;embedded&nbsp;in<br>
    83. 

  83. them,&nbsp;using&nbsp;[&nbsp;and&nbsp;].&nbsp;If&nbsp;so,&nbsp;a&nbsp;variable&nbsp;dictionary&nbsp;must&nbsp;be&nbsp;provided.&nbsp;By<br>
    84. 

  84. default,&nbsp;'me'&nbsp;references&nbsp;the&nbsp;socket&nbsp;being&nbsp;sent&nbsp;the&nbsp;message.</tt></dd></dl>
    85. 

  85. 

  86. <dl><dt><a name="Mudsock-send_raw"><strong>send_raw</strong></a>(...)</dt><dd><tt><a href="#Mudsock-send_raw">send_raw</a>(mssg)<br>
    87. 

  87. &nbsp;<br>
    88. 

  88. Sends&nbsp;text&nbsp;to&nbsp;the&nbsp;socket.&nbsp;No&nbsp;appended&nbsp;newline.</tt></dd></dl>
    89. 

  89. 

  90. <hr>
    91. 

  91. Data descriptors defined here:<br>
    92. 

  92. <dl><dt><strong>account</strong></dt>
    93. 

  93. <dd><tt>The&nbsp;account&nbsp;currently&nbsp;attached&nbsp;to&nbsp;the&nbsp;socket,&nbsp;or&nbsp;None.&nbsp;Immutable.<br>
    94. 

  94. see&nbsp;mudsys.attach_account_socket&nbsp;for&nbsp;connecting&nbsp;sockets&nbsp;and&nbsp;accounts.</tt></dd>
    95. 

  95. </dl>
    96. 

  96. <dl><dt><strong>can_use</strong></dt>
    97. 

  97. <dd><tt>True&nbsp;or&nbsp;False&nbsp;if&nbsp;the&nbsp;socket&nbsp;is&nbsp;ready&nbsp;for&nbsp;use.&nbsp;Socket&nbsp;becomes&nbsp;available<br>
    98. 

  98. after&nbsp;its&nbsp;dns&nbsp;addresss&nbsp;resolves.&nbsp;Immutable.</tt></dd>
    99. 

  99. </dl>
    100. 

  100. <dl><dt><strong>ch</strong></dt>
    101. 

  101. <dd><tt>Alias&nbsp;for&nbsp;mudsock.Mudsock.character.</tt></dd>
    102. 

  102. </dl>
    103. 

  103. <dl><dt><strong>char</strong></dt>
    104. 

  104. <dd><tt>Alias&nbsp;for&nbsp;mudsock.Mudsock.character</tt></dd>
    105. 

  105. </dl>
    106. 

  106. <dl><dt><strong>character</strong></dt>
    107. 

  107. <dd><tt>The&nbsp;character&nbsp;currently&nbsp;attached&nbsp;to&nbsp;the&nbsp;socket,&nbsp;on&nbsp;None.&nbsp;Immutable.<br>
    108. 

  108. see&nbsp;mudsys.attach_char_socket&nbsp;for&nbsp;connecting&nbsp;characters&nbsp;to&nbsp;account.</tt></dd>
    109. 

  109. </dl>
    110. 

  110. <dl><dt><strong>has_input</strong></dt>
    111. 

  111. <dd><tt>True&nbsp;or&nbsp;False&nbsp;if&nbsp;the&nbsp;socket&nbsp;has&nbsp;any&nbsp;input&nbsp;pending.&nbsp;Immutable.</tt></dd>
    112. 

  112. </dl>
    113. 

  113. <dl><dt><strong>hostname</strong></dt>
    114. 

  114. <dd><tt>The&nbsp;dns&nbsp;address&nbsp;that&nbsp;the&nbsp;socket&nbsp;is&nbsp;connected&nbsp;from.&nbsp;Immutable.</tt></dd>
    115. 

  115. </dl>
    116. 

  116. <dl><dt><strong>idle_time</strong></dt>
    117. 

  117. <dd><tt>How&nbsp;long&nbsp;(in&nbsp;seconds)&nbsp;the&nbsp;socket's&nbsp;input&nbsp;handler&nbsp;has&nbsp;been&nbsp;idle&nbsp;for.&nbsp;Immutable.</tt></dd>
    118. 

  118. </dl>
    119. 

  119. <dl><dt><strong>outbound_text</strong></dt>
    120. 

  120. <dd><tt>The&nbsp;socket's&nbsp;outbound&nbsp;text.</tt></dd>
    121. 

  121. </dl>
    122. 

  122. <dl><dt><strong>state</strong></dt>
    123. 

  123. <dd><tt>The&nbsp;state&nbsp;that&nbsp;the&nbsp;socket&nbsp;is&nbsp;in.&nbsp;Immutable.&nbsp;For&nbsp;more&nbsp;on&nbsp;states&nbsp;see<br>
    124. 

  124. mudsock.Mudsock.push_ih</tt></dd>
    125. 

  125. </dl>
    126. 

  126. <dl><dt><strong>uid</strong></dt>
    127. 

  127. <dd><tt>The&nbsp;socket's&nbsp;uid.&nbsp;Immutable.</tt></dd>
    128. 

  128. </dl>
    129. 

  129. <hr>
    130. 

  130. Data and other attributes defined here:<br>
    131. 

  131. <dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object at 0x6f980&gt;<dd><tt>T.<a href="#Mudsock-__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>
    132. 

  132. 

  133. </td></tr></table></td></tr></table><p>
    134. 

  134. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    135. 

  135. <tr bgcolor="#eeaa77">
    136. 

  136. <td colspan=3 valign=bottom>&nbsp;<br>
    137. 

  137. <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
    138. 

  138.     
    139. 

  139. <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    140. 

  140. <td width="100%"><dl><dt><a name="-socket_list"><strong>socket_list</strong></a>(...)</dt><dd><tt><a href="#-socket_list">socket_list</a>()<br>
    141. 

  141. &nbsp;<br>
    142. 

  142. Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;all&nbsp;sockets&nbsp;currently&nbsp;connected.</tt></dd></dl>
    143. 

  143. </td></tr></table>
    144. 

  144. </body></html>
    145.