emil
/
libircclient
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
LibIRCClient 1.10 Used by Probotic
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.
4 Commits
1 Branch
507KB
Branch: master
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'master'
${ noResults }
libircclient/cocoa/doc/html/interface_i_r_c_client_sess...

731 lines
30KB
Raw Permalink Blame History 

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">

  3. <title>IRCClient: IRCClientSession Class Reference</title>

  4. <link href="doxygen.css" rel="stylesheet" type="text/css">

  5. <link href="tabs.css" rel="stylesheet" type="text/css">

  6. </head><body>

  7. <!-- Generated by Doxygen 1.5.7.1 -->

  8. <div class="navigation" id="top">

  9.   <div class="tabs">

  10.     <ul>

  11.       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>

  12.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>

  13.       <li><a href="files.html"><span>Files</span></a></li>

  14.     </ul>

  15.   </div>

  16.   <div class="tabs">

  17.     <ul>

  18.       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>

  19.       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>

  20.       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>

  21.     </ul>

  22.   </div>

  23. </div>

  24. <div class="contents">

  25. <h1>IRCClientSession Class Reference</h1><!-- doxytag: class="IRCClientSession" --><!-- doxytag: inherits="NSObject" -->Represents a connected IRC Session.  

  26. <a href="#_details">More...</a>

  27. <p>

  28. <code>#import &lt;<a class="el" href="_i_r_c_client_session_8h-source.html">IRCClientSession.h</a>&gt;</code>

  29. <p>

  30. <div class="dynheader">

  31. Inheritance diagram for IRCClientSession:</div>

  32. <div class="dynsection">

  33. 

  34. <p><center><img src="interface_i_r_c_client_session.png" usemap="#IRCClientSession_map" border="0" alt=""></center>

  35. <map name="IRCClientSession_map">

  36. </map>

  37. </div>

  38. 

  39. <p>

  40. <a href="class_i_r_c_client_session-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">

  41. <tr><td></td></tr>

  42. <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>

  43. <tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#c9a0b7a41adeb92cf89fc53038ebc00b">connect</a></td></tr>

  44. 

  45. <tr><td class="memItemLeft" nowrap align="right" valign="top">(void)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#9cb82eac49784ccafbd6cf7dd262a766">disconnect</a></td></tr>

  46. 

  47. <tr><td class="memItemLeft" nowrap align="right" valign="top">(bool)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#2295d13bd62cbc7a0bd722953c3f4c64">isConnected</a></td></tr>

  48. 

  49. <tr><td class="memItemLeft" nowrap align="right" valign="top">(void)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#5ba88ff09ef13c00d8b7379b30c9eced">run</a></td></tr>

  50. 

  51. <tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#dcb54b817c20fa3c3beba65a944bca19">sendRawWithFormat:</a></td></tr>

  52. 

  53. <tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#bfa66744f91a4408f40efaf752fe6071">quit:</a></td></tr>

  54. 

  55. <tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#12ce6d4e08abe1ac26d0a1c0e9c5387e">join:key:</a></td></tr>

  56. 

  57. <tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#77e26b8a7488ac2e8298fe01eb1f729c">list:</a></td></tr>

  58. 

  59. <tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#869e09863a186b409d140c8f8161a93a">userMode:</a></td></tr>

  60. 

  61. <tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#608235f250367bdb74c05b8caa404d11">nick:</a></td></tr>

  62. 

  63. <tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#20ded6131f5bf067363a4701d2164907">whois:</a></td></tr>

  64. 

  65. <tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#613d3215bf84eb7f99c088284321eb0d">message:to:</a></td></tr>

  66. 

  67. <tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#c8c975193f7798f195d69b984aaa21fd">action:to:</a></td></tr>

  68. 

  69. <tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#2657fa7a70ddb705819b8b176692e6a0">notice:to:</a></td></tr>

  70. 

  71. <tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#6388c4f1f5cf3ffc14057984e29a4635">ctcpRequest:target:</a></td></tr>

  72. 

  73. <tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#2cef231ee53c6ad6a5d9d96283084996">ctcpReply:target:</a></td></tr>

  74. 

  75. <tr><td colspan="2"><br><h2>Properties</h2></td></tr>

  76. <tr><td class="memItemLeft" nowrap align="right" valign="top">id&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#ff1874c72e785b2097b9ef7ea8856557">delegate</a></td></tr>

  77. 

  78. <tr><td class="memItemLeft" nowrap align="right" valign="top">irc_session_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#7f3f3efa9e35c82bc92d89b2f264ca88">session</a></td></tr>

  79. 

  80. <tr><td class="memItemLeft" nowrap align="right" valign="top">NSString *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#6d2142efde508caf40c8b86e7dd1756c">version</a></td></tr>

  81. 

  82. <tr><td class="memItemLeft" nowrap align="right" valign="top">NSString *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#cb1376cfad37cc503c21fa1235f39fa0">server</a></td></tr>

  83. 

  84. <tr><td class="memItemLeft" nowrap align="right" valign="top">NSString *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#f4d8a5d0747ecb6ed2f55f282582e8cf">port</a></td></tr>

  85. 

  86. <tr><td class="memItemLeft" nowrap align="right" valign="top">NSString *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#6e304e45ddb942ead5b3c044a2b09e0b">password</a></td></tr>

  87. 

  88. <tr><td class="memItemLeft" nowrap align="right" valign="top">NSString *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#4f678f5ad868a7e3d739b1e9ad415249">nickname</a></td></tr>

  89. 

  90. <tr><td class="memItemLeft" nowrap align="right" valign="top">NSString *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#281dfe78f639e87899d3aff71983484e">username</a></td></tr>

  91. 

  92. <tr><td class="memItemLeft" nowrap align="right" valign="top">NSString *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#c124ffbdf87a785981c3e330f5a90088">realname</a></td></tr>

  93. 

  94. <tr><td class="memItemLeft" nowrap align="right" valign="top">NSMutableDictionary *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#fd38f656f1f7b03495e26fe982bb9e2a">channels</a></td></tr>

  95. 

  96. <tr><td class="memItemLeft" nowrap align="right" valign="top">NSStringEncoding&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#2b8b240d57a57acce3186768308c667c">encoding</a></td></tr>

  97. 

  98. </table>

  99. <hr><a name="_details"></a><h2>Detailed Description</h2>

  100. Represents a connected IRC Session. 

  101. <p>

  102. <a class="el" href="interface_i_r_c_client_session.html" title="Represents a connected IRC Session.">IRCClientSession</a> represents a single connection to an IRC server. On initialising the object, and setting the delegate, server, port, password, nickname, username and realname properties, you call the connect: and run: methods to connect to the IRC server and start a new thread.<p>

  103. This thread then sends messages back to the main runloop to the IRC server delegate, or to the <a class="el" href="interface_i_r_c_client_channel.html" title="Represents a connected IRC Channel.">IRCClientChannel</a> delegate as required. <hr><h2>Member Function Documentation</h2>

  104. <a class="anchor" name="c8c975193f7798f195d69b984aaa21fd"></a><!-- doxytag: member="IRCClientSession::action:to:" ref="c8c975193f7798f195d69b984aaa21fd" args="(NSString *action,[to] NSString *target)" -->

  105. <div class="memitem">

  106. <div class="memproto">

  107.       <table class="memname">

  108.         <tr>

  109.           <td class="memname">- (int) action:           </td>

  110.           <td></td>

  111.           <td class="paramtype">(NSString *)&nbsp;</td>

  112.           <td class="paramname"> <em>action</em></td>

  113.         </tr>

  114.         <tr>

  115.           <td class="paramkey">to:</td>

  116.           <td></td>

  117.           <td class="paramtype">(NSString *)&nbsp;</td>

  118.           <td class="paramname"> <em>target</em></td><td>&nbsp;</td>

  119.         </tr>

  120.         <tr>

  121.           <td></td>

  122.           <td></td>

  123.           <td></td><td></td><td></td>

  124.         </tr>

  125.       </table>

  126. </div>

  127. <div class="memdoc">

  128. 

  129. <p>

  130. send a CTCP ACTION to another IRC client<p>

  131. <dl compact><dt><b>Parameters:</b></dt><dd>

  132.   <table border="0" cellspacing="2" cellpadding="0">

  133.     <tr><td valign="top"></td><td valign="top"><em>action</em>&nbsp;</td><td>the action message to send </td></tr>

  134.     <tr><td valign="top"></td><td valign="top"><em>target</em>&nbsp;</td><td>the nickname of the irc client to send the message to. </td></tr>

  135.   </table>

  136. </dl>

  137. 

  138. </div>

  139. </div><p>

  140. <a class="anchor" name="c9a0b7a41adeb92cf89fc53038ebc00b"></a><!-- doxytag: member="IRCClientSession::connect" ref="c9a0b7a41adeb92cf89fc53038ebc00b" args="()" -->

  141. <div class="memitem">

  142. <div class="memproto">

  143.       <table class="memname">

  144.         <tr>

  145.           <td class="memname">- (int) connect           </td>

  146.           <td></td>

  147.           <td class="paramname">          </td>

  148.           <td>&nbsp;</td>

  149.           <td></td>

  150.         </tr>

  151.       </table>

  152. </div>

  153. <div class="memdoc">

  154. 

  155. <p>

  156. Connect to the IRC server.<p>

  157. Note that this performs the initial DNS lookup and the TCP connection, so if there are any problems you will be notified via the return code of the message.<p>

  158. Look at the libircclient documentation for the different return codes. 

  159. </div>

  160. </div><p>

  161. <a class="anchor" name="2cef231ee53c6ad6a5d9d96283084996"></a><!-- doxytag: member="IRCClientSession::ctcpReply:target:" ref="2cef231ee53c6ad6a5d9d96283084996" args="(NSString *reply,[target] NSString *target)" -->

  162. <div class="memitem">

  163. <div class="memproto">

  164.       <table class="memname">

  165.         <tr>

  166.           <td class="memname">- (int) ctcpReply:           </td>

  167.           <td></td>

  168.           <td class="paramtype">(NSString *)&nbsp;</td>

  169.           <td class="paramname"> <em>reply</em></td>

  170.         </tr>

  171.         <tr>

  172.           <td class="paramkey">target:</td>

  173.           <td></td>

  174.           <td class="paramtype">(NSString *)&nbsp;</td>

  175.           <td class="paramname"> <em>target</em></td><td>&nbsp;</td>

  176.         </tr>

  177.         <tr>

  178.           <td></td>

  179.           <td></td>

  180.           <td></td><td></td><td></td>

  181.         </tr>

  182.       </table>

  183. </div>

  184. <div class="memdoc">

  185. 

  186. <p>

  187. send a CTCP reply to another IRC client<p>

  188. <dl compact><dt><b>Parameters:</b></dt><dd>

  189.   <table border="0" cellspacing="2" cellpadding="0">

  190.     <tr><td valign="top"></td><td valign="top"><em>reply</em>&nbsp;</td><td>the CTCP reply string to send </td></tr>

  191.     <tr><td valign="top"></td><td valign="top"><em>target</em>&nbsp;</td><td>the nickname of the IRC client to send the reply to. </td></tr>

  192.   </table>

  193. </dl>

  194. 

  195. </div>

  196. </div><p>

  197. <a class="anchor" name="6388c4f1f5cf3ffc14057984e29a4635"></a><!-- doxytag: member="IRCClientSession::ctcpRequest:target:" ref="6388c4f1f5cf3ffc14057984e29a4635" args="(NSString *request,[target] NSString *target)" -->

  198. <div class="memitem">

  199. <div class="memproto">

  200.       <table class="memname">

  201.         <tr>

  202.           <td class="memname">- (int) ctcpRequest:           </td>

  203.           <td></td>

  204.           <td class="paramtype">(NSString *)&nbsp;</td>

  205.           <td class="paramname"> <em>request</em></td>

  206.         </tr>

  207.         <tr>

  208.           <td class="paramkey">target:</td>

  209.           <td></td>

  210.           <td class="paramtype">(NSString *)&nbsp;</td>

  211.           <td class="paramname"> <em>target</em></td><td>&nbsp;</td>

  212.         </tr>

  213.         <tr>

  214.           <td></td>

  215.           <td></td>

  216.           <td></td><td></td><td></td>

  217.         </tr>

  218.       </table>

  219. </div>

  220. <div class="memdoc">

  221. 

  222. <p>

  223. send a CTCP request to another IRC client<p>

  224. <dl compact><dt><b>Parameters:</b></dt><dd>

  225.   <table border="0" cellspacing="2" cellpadding="0">

  226.     <tr><td valign="top"></td><td valign="top"><em>request</em>&nbsp;</td><td>the CTCP request string to send </td></tr>

  227.     <tr><td valign="top"></td><td valign="top"><em>target</em>&nbsp;</td><td>the nickname of the IRC client to send the request to. </td></tr>

  228.   </table>

  229. </dl>

  230. 

  231. </div>

  232. </div><p>

  233. <a class="anchor" name="9cb82eac49784ccafbd6cf7dd262a766"></a><!-- doxytag: member="IRCClientSession::disconnect" ref="9cb82eac49784ccafbd6cf7dd262a766" args="()" -->

  234. <div class="memitem">

  235. <div class="memproto">

  236.       <table class="memname">

  237.         <tr>

  238.           <td class="memname">- (void) disconnect           </td>

  239.           <td></td>

  240.           <td class="paramname">          </td>

  241.           <td>&nbsp;</td>

  242.           <td></td>

  243.         </tr>

  244.       </table>

  245. </div>

  246. <div class="memdoc">

  247. 

  248. <p>

  249. Disconnect from the IRC server.<p>

  250. This always works, as it simply shuts down the socket. If you want to disconnect in a friendly way, you should use the quit: message. 

  251. </div>

  252. </div><p>

  253. <a class="anchor" name="2295d13bd62cbc7a0bd722953c3f4c64"></a><!-- doxytag: member="IRCClientSession::isConnected" ref="2295d13bd62cbc7a0bd722953c3f4c64" args="()" -->

  254. <div class="memitem">

  255. <div class="memproto">

  256.       <table class="memname">

  257.         <tr>

  258.           <td class="memname">- (bool) isConnected           </td>

  259.           <td></td>

  260.           <td class="paramname">          </td>

  261.           <td>&nbsp;</td>

  262.           <td></td>

  263.         </tr>

  264.       </table>

  265. </div>

  266. <div class="memdoc">

  267. 

  268. <p>

  269. returns YES if the server is currently connected successfully, and NO if it is not. 

  270. </div>

  271. </div><p>

  272. <a class="anchor" name="12ce6d4e08abe1ac26d0a1c0e9c5387e"></a><!-- doxytag: member="IRCClientSession::join:key:" ref="12ce6d4e08abe1ac26d0a1c0e9c5387e" args="(NSString *channel,[key] NSString *key)" -->

  273. <div class="memitem">

  274. <div class="memproto">

  275.       <table class="memname">

  276.         <tr>

  277.           <td class="memname">- (int) join:           </td>

  278.           <td></td>

  279.           <td class="paramtype">(NSString *)&nbsp;</td>

  280.           <td class="paramname"> <em>channel</em></td>

  281.         </tr>

  282.         <tr>

  283.           <td class="paramkey">key:</td>

  284.           <td></td>

  285.           <td class="paramtype">(NSString *)&nbsp;</td>

  286.           <td class="paramname"> <em>key</em></td><td>&nbsp;</td>

  287.         </tr>

  288.         <tr>

  289.           <td></td>

  290.           <td></td>

  291.           <td></td><td></td><td></td>

  292.         </tr>

  293.       </table>

  294. </div>

  295. <div class="memdoc">

  296. 

  297. <p>

  298. Joins a channel with a given name and key<p>

  299. <dl compact><dt><b>Parameters:</b></dt><dd>

  300.   <table border="0" cellspacing="2" cellpadding="0">

  301.     <tr><td valign="top"></td><td valign="top"><em>channel</em>&nbsp;</td><td>the channel to join </td></tr>

  302.     <tr><td valign="top"></td><td valign="top"><em>key</em>&nbsp;</td><td>they key for the channel (may be nil) </td></tr>

  303.   </table>

  304. </dl>

  305. 

  306. </div>

  307. </div><p>

  308. <a class="anchor" name="77e26b8a7488ac2e8298fe01eb1f729c"></a><!-- doxytag: member="IRCClientSession::list:" ref="77e26b8a7488ac2e8298fe01eb1f729c" args="(NSString *channel)" -->

  309. <div class="memitem">

  310. <div class="memproto">

  311.       <table class="memname">

  312.         <tr>

  313.           <td class="memname">- (int) list:           </td>

  314.           <td></td>

  315.           <td class="paramtype">(NSString *)&nbsp;</td>

  316.           <td class="paramname"> <em>channel</em>          </td>

  317.           <td>&nbsp;</td>

  318.           <td></td>

  319.         </tr>

  320.       </table>

  321. </div>

  322. <div class="memdoc">

  323. 

  324. <p>

  325. lists channels on the IRC server.<p>

  326. <dl compact><dt><b>Parameters:</b></dt><dd>

  327.   <table border="0" cellspacing="2" cellpadding="0">

  328.     <tr><td valign="top"></td><td valign="top"><em>channel</em>&nbsp;</td><td>a channel name or string to pass to the LIST command. Implementation specific. </td></tr>

  329.   </table>

  330. </dl>

  331. 

  332. </div>

  333. </div><p>

  334. <a class="anchor" name="613d3215bf84eb7f99c088284321eb0d"></a><!-- doxytag: member="IRCClientSession::message:to:" ref="613d3215bf84eb7f99c088284321eb0d" args="(NSString *message,[to] NSString *target)" -->

  335. <div class="memitem">

  336. <div class="memproto">

  337.       <table class="memname">

  338.         <tr>

  339.           <td class="memname">- (int) message:           </td>

  340.           <td></td>

  341.           <td class="paramtype">(NSString *)&nbsp;</td>

  342.           <td class="paramname"> <em>message</em></td>

  343.         </tr>

  344.         <tr>

  345.           <td class="paramkey">to:</td>

  346.           <td></td>

  347.           <td class="paramtype">(NSString *)&nbsp;</td>

  348.           <td class="paramname"> <em>target</em></td><td>&nbsp;</td>

  349.         </tr>

  350.         <tr>

  351.           <td></td>

  352.           <td></td>

  353.           <td></td><td></td><td></td>

  354.         </tr>

  355.       </table>

  356. </div>

  357. <div class="memdoc">

  358. 

  359. <p>

  360. send a PRIVMSG to another IRC client<p>

  361. <dl compact><dt><b>Parameters:</b></dt><dd>

  362.   <table border="0" cellspacing="2" cellpadding="0">

  363.     <tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>message to send </td></tr>

  364.     <tr><td valign="top"></td><td valign="top"><em>target</em>&nbsp;</td><td>the other IRC client to send the message to. </td></tr>

  365.   </table>

  366. </dl>

  367. 

  368. </div>

  369. </div><p>

  370. <a class="anchor" name="608235f250367bdb74c05b8caa404d11"></a><!-- doxytag: member="IRCClientSession::nick:" ref="608235f250367bdb74c05b8caa404d11" args="(NSString *newnick)" -->

  371. <div class="memitem">

  372. <div class="memproto">

  373.       <table class="memname">

  374.         <tr>

  375.           <td class="memname">- (int) nick:           </td>

  376.           <td></td>

  377.           <td class="paramtype">(NSString *)&nbsp;</td>

  378.           <td class="paramname"> <em>newnick</em>          </td>

  379.           <td>&nbsp;</td>

  380.           <td></td>

  381.         </tr>

  382.       </table>

  383. </div>

  384. <div class="memdoc">

  385. 

  386. <p>

  387. sets the IRC client nickname. On success, an onNick event will be sent to the delegate<p>

  388. <dl compact><dt><b>Parameters:</b></dt><dd>

  389.   <table border="0" cellspacing="2" cellpadding="0">

  390.     <tr><td valign="top"></td><td valign="top"><em>newnick</em>&nbsp;</td><td>new nickname to set. </td></tr>

  391.   </table>

  392. </dl>

  393. 

  394. </div>

  395. </div><p>

  396. <a class="anchor" name="2657fa7a70ddb705819b8b176692e6a0"></a><!-- doxytag: member="IRCClientSession::notice:to:" ref="2657fa7a70ddb705819b8b176692e6a0" args="(NSString *notice,[to] NSString *target)" -->

  397. <div class="memitem">

  398. <div class="memproto">

  399.       <table class="memname">

  400.         <tr>

  401.           <td class="memname">- (int) notice:           </td>

  402.           <td></td>

  403.           <td class="paramtype">(NSString *)&nbsp;</td>

  404.           <td class="paramname"> <em>notice</em></td>

  405.         </tr>

  406.         <tr>

  407.           <td class="paramkey">to:</td>

  408.           <td></td>

  409.           <td class="paramtype">(NSString *)&nbsp;</td>

  410.           <td class="paramname"> <em>target</em></td><td>&nbsp;</td>

  411.         </tr>

  412.         <tr>

  413.           <td></td>

  414.           <td></td>

  415.           <td></td><td></td><td></td>

  416.         </tr>

  417.       </table>

  418. </div>

  419. <div class="memdoc">

  420. 

  421. <p>

  422. send a NOTICE to another IRC client<p>

  423. <dl compact><dt><b>Parameters:</b></dt><dd>

  424.   <table border="0" cellspacing="2" cellpadding="0">

  425.     <tr><td valign="top"></td><td valign="top"><em>notice</em>&nbsp;</td><td>the message text to send </td></tr>

  426.     <tr><td valign="top"></td><td valign="top"><em>target</em>&nbsp;</td><td>the nickname of the irc client to send the notice to. </td></tr>

  427.   </table>

  428. </dl>

  429. 

  430. </div>

  431. </div><p>

  432. <a class="anchor" name="bfa66744f91a4408f40efaf752fe6071"></a><!-- doxytag: member="IRCClientSession::quit:" ref="bfa66744f91a4408f40efaf752fe6071" args="(NSString *reason)" -->

  433. <div class="memitem">

  434. <div class="memproto">

  435.       <table class="memname">

  436.         <tr>

  437.           <td class="memname">- (int) quit:           </td>

  438.           <td></td>

  439.           <td class="paramtype">(NSString *)&nbsp;</td>

  440.           <td class="paramname"> <em>reason</em>          </td>

  441.           <td>&nbsp;</td>

  442.           <td></td>

  443.         </tr>

  444.       </table>

  445. </div>

  446. <div class="memdoc">

  447. 

  448. <p>

  449. quits the IRC server with the given reason. On success, an onQuit event will be sent to the <a class="el" href="protocol_i_r_c_client_session_delegate-p.html">IRCClientSessionDelegate</a> with the nickname of the IRC client.<p>

  450. The format is a standard NSString format string, followed by optional arguments. 

  451. </div>

  452. </div><p>

  453. <a class="anchor" name="5ba88ff09ef13c00d8b7379b30c9eced"></a><!-- doxytag: member="IRCClientSession::run" ref="5ba88ff09ef13c00d8b7379b30c9eced" args="()" -->

  454. <div class="memitem">

  455. <div class="memproto">

  456.       <table class="memname">

  457.         <tr>

  458.           <td class="memname">- (void) run           </td>

  459.           <td></td>

  460.           <td class="paramname">          </td>

  461.           <td>&nbsp;</td>

  462.           <td></td>

  463.         </tr>

  464.       </table>

  465. </div>

  466. <div class="memdoc">

  467. 

  468. <p>

  469. Starts a new thread and starts the libircclient runloop, processing events and firing messages back to the main runloop as required. Calling this again will do nothing other than raise a warning in your logs. 

  470. </div>

  471. </div><p>

  472. <a class="anchor" name="dcb54b817c20fa3c3beba65a944bca19"></a><!-- doxytag: member="IRCClientSession::sendRawWithFormat:" ref="dcb54b817c20fa3c3beba65a944bca19" args="(NSString *format,[,]...)" -->

  473. <div class="memitem">

  474. <div class="memproto">

  475.       <table class="memname">

  476.         <tr>

  477.           <td class="memname">- (int) sendRawWithFormat:           </td>

  478.           <td></td>

  479.           <td class="paramtype">(NSString *)&nbsp;</td>

  480.           <td class="paramname"> <em>format</em></td>

  481.         </tr>

  482.         <tr>

  483.           <td class="paramkey">,</td>

  484.           <td></td>

  485.           <td class="paramtype">&nbsp;</td>

  486.           <td class="paramname"> <em>...</em></td><td>&nbsp;</td>

  487.         </tr>

  488.         <tr>

  489.           <td></td>

  490.           <td></td>

  491.           <td></td><td></td><td></td>

  492.         </tr>

  493.       </table>

  494. </div>

  495. <div class="memdoc">

  496. 

  497. <p>

  498. Sends a raw message to the IRC server. Please consult rfc1459 for the format of IRC commands. 

  499. </div>

  500. </div><p>

  501. <a class="anchor" name="869e09863a186b409d140c8f8161a93a"></a><!-- doxytag: member="IRCClientSession::userMode:" ref="869e09863a186b409d140c8f8161a93a" args="(NSString *mode)" -->

  502. <div class="memitem">

  503. <div class="memproto">

  504.       <table class="memname">

  505.         <tr>

  506.           <td class="memname">- (int) userMode:           </td>

  507.           <td></td>

  508.           <td class="paramtype">(NSString *)&nbsp;</td>

  509.           <td class="paramname"> <em>mode</em>          </td>

  510.           <td>&nbsp;</td>

  511.           <td></td>

  512.         </tr>

  513.       </table>

  514. </div>

  515. <div class="memdoc">

  516. 

  517. <p>

  518. sets the user mode for the IRC client<p>

  519. <dl compact><dt><b>Parameters:</b></dt><dd>

  520.   <table border="0" cellspacing="2" cellpadding="0">

  521.     <tr><td valign="top"></td><td valign="top"><em>mode</em>&nbsp;</td><td>string to set </td></tr>

  522.   </table>

  523. </dl>

  524. 

  525. </div>

  526. </div><p>

  527. <a class="anchor" name="20ded6131f5bf067363a4701d2164907"></a><!-- doxytag: member="IRCClientSession::whois:" ref="20ded6131f5bf067363a4701d2164907" args="(NSString *nick)" -->

  528. <div class="memitem">

  529. <div class="memproto">

  530.       <table class="memname">

  531.         <tr>

  532.           <td class="memname">- (int) whois:           </td>

  533.           <td></td>

  534.           <td class="paramtype">(NSString *)&nbsp;</td>

  535.           <td class="paramname"> <em>nick</em>          </td>

  536.           <td>&nbsp;</td>

  537.           <td></td>

  538.         </tr>

  539.       </table>

  540. </div>

  541. <div class="memdoc">

  542. 

  543. <p>

  544. sends a WHOIS request to the IRC server<p>

  545. <dl compact><dt><b>Parameters:</b></dt><dd>

  546.   <table border="0" cellspacing="2" cellpadding="0">

  547.     <tr><td valign="top"></td><td valign="top"><em>nick</em>&nbsp;</td><td>nickname of the irc client to whois. </td></tr>

  548.   </table>

  549. </dl>

  550. 

  551. </div>

  552. </div><p>

  553. <hr><h2>Property Documentation</h2>

  554. <a class="anchor" name="fd38f656f1f7b03495e26fe982bb9e2a"></a><!-- doxytag: member="IRCClientSession::channels" ref="fd38f656f1f7b03495e26fe982bb9e2a" args="" -->

  555. <div class="memitem">

  556. <div class="memproto">

  557.       <table class="memname">

  558.         <tr>

  559.           <td class="memname">- (NSMutableDictionary *) channels<code> [read, assign]</code>          </td>

  560.         </tr>

  561.       </table>

  562. </div>

  563. <div class="memdoc">

  564. 

  565. <p>

  566. An NSMutableDictionary of channels that the client is currently connected to.<p>

  567. You should not modify this. 

  568. </div>

  569. </div><p>

  570. <a class="anchor" name="ff1874c72e785b2097b9ef7ea8856557"></a><!-- doxytag: member="IRCClientSession::delegate" ref="ff1874c72e785b2097b9ef7ea8856557" args="" -->

  571. <div class="memitem">

  572. <div class="memproto">

  573.       <table class="memname">

  574.         <tr>

  575.           <td class="memname">- (id) delegate<code> [read, write, assign]</code>          </td>

  576.         </tr>

  577.       </table>

  578. </div>

  579. <div class="memdoc">

  580. 

  581. <p>

  582. delegate to send events to. 

  583. </div>

  584. </div><p>

  585. <a class="anchor" name="2b8b240d57a57acce3186768308c667c"></a><!-- doxytag: member="IRCClientSession::encoding" ref="2b8b240d57a57acce3186768308c667c" args="" -->

  586. <div class="memitem">

  587. <div class="memproto">

  588.       <table class="memname">

  589.         <tr>

  590.           <td class="memname">- (NSStringEncoding) encoding<code> [read, write, assign]</code>          </td>

  591.         </tr>

  592.       </table>

  593. </div>

  594. <div class="memdoc">

  595. 

  596. <p>

  597. The default text encoding for messages on this server.<p>

  598. This affects messages received via PRIVMSG and NOTICE, and TOPIC in a channel. You may change this at any time. 

  599. </div>

  600. </div><p>

  601. <a class="anchor" name="4f678f5ad868a7e3d739b1e9ad415249"></a><!-- doxytag: member="IRCClientSession::nickname" ref="4f678f5ad868a7e3d739b1e9ad415249" args="" -->

  602. <div class="memitem">

  603. <div class="memproto">

  604.       <table class="memname">

  605.         <tr>

  606.           <td class="memname">- (NSString *) nickname<code> [read, write, copy]</code>          </td>

  607.         </tr>

  608.       </table>

  609. </div>

  610. <div class="memdoc">

  611. 

  612. <p>

  613. Nickname of the connected client. Note that setting this after connection will not result in the client renaming on IRC. You need to send a nick: message instead. 

  614. </div>

  615. </div><p>

  616. <a class="anchor" name="6e304e45ddb942ead5b3c044a2b09e0b"></a><!-- doxytag: member="IRCClientSession::password" ref="6e304e45ddb942ead5b3c044a2b09e0b" args="" -->

  617. <div class="memitem">

  618. <div class="memproto">

  619.       <table class="memname">

  620.         <tr>

  621.           <td class="memname">- (NSString *) password<code> [read, write, copy]</code>          </td>

  622.         </tr>

  623.       </table>

  624. </div>

  625. <div class="memdoc">

  626. 

  627. <p>

  628. Server password to provide on connect (may be left empty or nil) 

  629. </div>

  630. </div><p>

  631. <a class="anchor" name="f4d8a5d0747ecb6ed2f55f282582e8cf"></a><!-- doxytag: member="IRCClientSession::port" ref="f4d8a5d0747ecb6ed2f55f282582e8cf" args="" -->

  632. <div class="memitem">

  633. <div class="memproto">

  634.       <table class="memname">

  635.         <tr>

  636.           <td class="memname">- (NSString *) port<code> [read, write, copy]</code>          </td>

  637.         </tr>

  638.       </table>

  639. </div>

  640. <div class="memdoc">

  641. 

  642. <p>

  643. IRC port to connect to 

  644. </div>

  645. </div><p>

  646. <a class="anchor" name="c124ffbdf87a785981c3e330f5a90088"></a><!-- doxytag: member="IRCClientSession::realname" ref="c124ffbdf87a785981c3e330f5a90088" args="" -->

  647. <div class="memitem">

  648. <div class="memproto">

  649.       <table class="memname">

  650.         <tr>

  651.           <td class="memname">- (NSString *) realname<code> [read, write, copy]</code>          </td>

  652.         </tr>

  653.       </table>

  654. </div>

  655. <div class="memdoc">

  656. 

  657. <p>

  658. Realname of the connected client.<p>

  659. Setting this after connection does nothing. 

  660. </div>

  661. </div><p>

  662. <a class="anchor" name="cb1376cfad37cc503c21fa1235f39fa0"></a><!-- doxytag: member="IRCClientSession::server" ref="cb1376cfad37cc503c21fa1235f39fa0" args="" -->

  663. <div class="memitem">

  664. <div class="memproto">

  665.       <table class="memname">

  666.         <tr>

  667.           <td class="memname">- (NSString *) server<code> [read, write, copy]</code>          </td>

  668.         </tr>

  669.       </table>

  670. </div>

  671. <div class="memdoc">

  672. 

  673. <p>

  674. IRC server to connect to 

  675. </div>

  676. </div><p>

  677. <a class="anchor" name="7f3f3efa9e35c82bc92d89b2f264ca88"></a><!-- doxytag: member="IRCClientSession::session" ref="7f3f3efa9e35c82bc92d89b2f264ca88" args="" -->

  678. <div class="memitem">

  679. <div class="memproto">

  680.       <table class="memname">

  681.         <tr>

  682.           <td class="memname">- (irc_session_t *) session<code> [read, write, assign]</code>          </td>

  683.         </tr>

  684.       </table>

  685. </div>

  686. <div class="memdoc">

  687. 

  688. <p>

  689. The underlying libircclient handle 

  690. </div>

  691. </div><p>

  692. <a class="anchor" name="281dfe78f639e87899d3aff71983484e"></a><!-- doxytag: member="IRCClientSession::username" ref="281dfe78f639e87899d3aff71983484e" args="" -->

  693. <div class="memitem">

  694. <div class="memproto">

  695.       <table class="memname">

  696.         <tr>

  697.           <td class="memname">- (NSString *) username<code> [read, write, copy]</code>          </td>

  698.         </tr>

  699.       </table>

  700. </div>

  701. <div class="memdoc">

  702. 

  703. <p>

  704. Username of the connected client. Also known as the ident.<p>

  705. Setting this after connection does nothing. 

  706. </div>

  707. </div><p>

  708. <a class="anchor" name="6d2142efde508caf40c8b86e7dd1756c"></a><!-- doxytag: member="IRCClientSession::version" ref="6d2142efde508caf40c8b86e7dd1756c" args="" -->

  709. <div class="memitem">

  710. <div class="memproto">

  711.       <table class="memname">

  712.         <tr>

  713.           <td class="memname">- (NSString *) version<code> [read, write, copy]</code>          </td>

  714.         </tr>

  715.       </table>

  716. </div>

  717. <div class="memdoc">

  718. 

  719. <p>

  720. The version string for the client to send back on CTCP VERSION requests 

  721. </div>

  722. </div><p>

  723. <hr>The documentation for this class was generated from the following files:<ul>

  724. <li><a class="el" href="_i_r_c_client_session_8h-source.html">IRCClientSession.h</a><li>IRCClientSession.m</ul>

  725. </div>

  726. <hr size="1"><address style="text-align: right;"><small>Generated on Sat Jan 10 18:10:37 2009 for IRCClient by&nbsp;

  727. <a href="http://www.doxygen.org/index.html">

  728. <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>

  729. </body>

  730. </html>