<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>IRCClient: IRCClientSession Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>IRCClientSession Class Reference</h1><!-- doxytag: class="IRCClientSession" --><!-- doxytag: inherits="NSObject" -->Represents a connected IRC Session.
<a href="#_details">More...</a>
<p>
<code>#import <<a class="el" href="_i_r_c_client_session_8h-source.html">IRCClientSession.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for IRCClientSession:</div>
<div class="dynsection">
<p><center><img src="interface_i_r_c_client_session.png" usemap="#IRCClientSession_map" border="0" alt=""></center>
<map name="IRCClientSession_map">
</map>
</div>
<p>
<a href="class_i_r_c_client_session-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#c9a0b7a41adeb92cf89fc53038ebc00b">connect</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#9cb82eac49784ccafbd6cf7dd262a766">disconnect</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(bool) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#2295d13bd62cbc7a0bd722953c3f4c64">isConnected</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#5ba88ff09ef13c00d8b7379b30c9eced">run</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#dcb54b817c20fa3c3beba65a944bca19">sendRawWithFormat:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#bfa66744f91a4408f40efaf752fe6071">quit:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#12ce6d4e08abe1ac26d0a1c0e9c5387e">join:key:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#77e26b8a7488ac2e8298fe01eb1f729c">list:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#869e09863a186b409d140c8f8161a93a">userMode:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#608235f250367bdb74c05b8caa404d11">nick:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#20ded6131f5bf067363a4701d2164907">whois:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#613d3215bf84eb7f99c088284321eb0d">message:to:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#c8c975193f7798f195d69b984aaa21fd">action:to:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#2657fa7a70ddb705819b8b176692e6a0">notice:to:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#6388c4f1f5cf3ffc14057984e29a4635">ctcpRequest:target:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_session.html#2cef231ee53c6ad6a5d9d96283084996">ctcpReply:target:</a></td></tr>
<tr><td colspan="2"><br><h2>Properties</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">id </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#ff1874c72e785b2097b9ef7ea8856557">delegate</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">irc_session_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#7f3f3efa9e35c82bc92d89b2f264ca88">session</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#6d2142efde508caf40c8b86e7dd1756c">version</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#cb1376cfad37cc503c21fa1235f39fa0">server</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#f4d8a5d0747ecb6ed2f55f282582e8cf">port</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#6e304e45ddb942ead5b3c044a2b09e0b">password</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#4f678f5ad868a7e3d739b1e9ad415249">nickname</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#281dfe78f639e87899d3aff71983484e">username</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#c124ffbdf87a785981c3e330f5a90088">realname</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSMutableDictionary * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#fd38f656f1f7b03495e26fe982bb9e2a">channels</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSStringEncoding </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_session.html#2b8b240d57a57acce3186768308c667c">encoding</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Represents a connected IRC Session.
<p>
<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>
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>
<a class="anchor" name="c8c975193f7798f195d69b984aaa21fd"></a><!-- doxytag: member="IRCClientSession::action:to:" ref="c8c975193f7798f195d69b984aaa21fd" args="(NSString *action,[to] NSString *target)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) action: </td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>action</em></td>
</tr>
<tr>
<td class="paramkey">to:</td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>target</em></td><td> </td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
send a CTCP ACTION to another IRC client<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>action</em> </td><td>the action message to send </td></tr>
<tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>the nickname of the irc client to send the message to. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c9a0b7a41adeb92cf89fc53038ebc00b"></a><!-- doxytag: member="IRCClientSession::connect" ref="c9a0b7a41adeb92cf89fc53038ebc00b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) connect </td>
<td></td>
<td class="paramname"> </td>
<td> </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connect to the IRC server.<p>
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>
Look at the libircclient documentation for the different return codes.
</div>
</div><p>
<a class="anchor" name="2cef231ee53c6ad6a5d9d96283084996"></a><!-- doxytag: member="IRCClientSession::ctcpReply:target:" ref="2cef231ee53c6ad6a5d9d96283084996" args="(NSString *reply,[target] NSString *target)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) ctcpReply: </td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>reply</em></td>
</tr>
<tr>
<td class="paramkey">target:</td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>target</em></td><td> </td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
send a CTCP reply to another IRC client<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>reply</em> </td><td>the CTCP reply string to send </td></tr>
<tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>the nickname of the IRC client to send the reply to. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="6388c4f1f5cf3ffc14057984e29a4635"></a><!-- doxytag: member="IRCClientSession::ctcpRequest:target:" ref="6388c4f1f5cf3ffc14057984e29a4635" args="(NSString *request,[target] NSString *target)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) ctcpRequest: </td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>request</em></td>
</tr>
<tr>
<td class="paramkey">target:</td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>target</em></td><td> </td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
send a CTCP request to another IRC client<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>request</em> </td><td>the CTCP request string to send </td></tr>
<tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>the nickname of the IRC client to send the request to. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="9cb82eac49784ccafbd6cf7dd262a766"></a><!-- doxytag: member="IRCClientSession::disconnect" ref="9cb82eac49784ccafbd6cf7dd262a766" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (void) disconnect </td>
<td></td>
<td class="paramname"> </td>
<td> </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Disconnect from the IRC server.<p>
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.
</div>
</div><p>
<a class="anchor" name="2295d13bd62cbc7a0bd722953c3f4c64"></a><!-- doxytag: member="IRCClientSession::isConnected" ref="2295d13bd62cbc7a0bd722953c3f4c64" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (bool) isConnected </td>
<td></td>
<td class="paramname"> </td>
<td> </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
returns YES if the server is currently connected successfully, and NO if it is not.
</div>
</div><p>
<a class="anchor" name="12ce6d4e08abe1ac26d0a1c0e9c5387e"></a><!-- doxytag: member="IRCClientSession::join:key:" ref="12ce6d4e08abe1ac26d0a1c0e9c5387e" args="(NSString *channel,[key] NSString *key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) join: </td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>channel</em></td>
</tr>
<tr>
<td class="paramkey">key:</td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>key</em></td><td> </td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Joins a channel with a given name and key<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>channel</em> </td><td>the channel to join </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>they key for the channel (may be nil) </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="77e26b8a7488ac2e8298fe01eb1f729c"></a><!-- doxytag: member="IRCClientSession::list:" ref="77e26b8a7488ac2e8298fe01eb1f729c" args="(NSString *channel)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) list: </td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>channel</em> </td>
<td> </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
lists channels on the IRC server.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>channel</em> </td><td>a channel name or string to pass to the LIST command. Implementation specific. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="613d3215bf84eb7f99c088284321eb0d"></a><!-- doxytag: member="IRCClientSession::message:to:" ref="613d3215bf84eb7f99c088284321eb0d" args="(NSString *message,[to] NSString *target)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) message: </td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>message</em></td>
</tr>
<tr>
<td class="paramkey">to:</td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>target</em></td><td> </td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
send a PRIVMSG to another IRC client<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>message</em> </td><td>message to send </td></tr>
<tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>the other IRC client to send the message to. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="608235f250367bdb74c05b8caa404d11"></a><!-- doxytag: member="IRCClientSession::nick:" ref="608235f250367bdb74c05b8caa404d11" args="(NSString *newnick)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) nick: </td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>newnick</em> </td>
<td> </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
sets the IRC client nickname. On success, an onNick event will be sent to the delegate<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>newnick</em> </td><td>new nickname to set. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="2657fa7a70ddb705819b8b176692e6a0"></a><!-- doxytag: member="IRCClientSession::notice:to:" ref="2657fa7a70ddb705819b8b176692e6a0" args="(NSString *notice,[to] NSString *target)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) notice: </td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>notice</em></td>
</tr>
<tr>
<td class="paramkey">to:</td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>target</em></td><td> </td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
send a NOTICE to another IRC client<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>notice</em> </td><td>the message text to send </td></tr>
<tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>the nickname of the irc client to send the notice to. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="bfa66744f91a4408f40efaf752fe6071"></a><!-- doxytag: member="IRCClientSession::quit:" ref="bfa66744f91a4408f40efaf752fe6071" args="(NSString *reason)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) quit: </td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>reason</em> </td>
<td> </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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>
The format is a standard NSString format string, followed by optional arguments.
</div>
</div><p>
<a class="anchor" name="5ba88ff09ef13c00d8b7379b30c9eced"></a><!-- doxytag: member="IRCClientSession::run" ref="5ba88ff09ef13c00d8b7379b30c9eced" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (void) run </td>
<td></td>
<td class="paramname"> </td>
<td> </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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.
</div>
</div><p>
<a class="anchor" name="dcb54b817c20fa3c3beba65a944bca19"></a><!-- doxytag: member="IRCClientSession::sendRawWithFormat:" ref="dcb54b817c20fa3c3beba65a944bca19" args="(NSString *format,[,]...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) sendRawWithFormat: </td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>format</em></td>
</tr>
<tr>
<td class="paramkey">,</td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"> <em>...</em></td><td> </td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sends a raw message to the IRC server. Please consult rfc1459 for the format of IRC commands.
</div>
</div><p>
<a class="anchor" name="869e09863a186b409d140c8f8161a93a"></a><!-- doxytag: member="IRCClientSession::userMode:" ref="869e09863a186b409d140c8f8161a93a" args="(NSString *mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) userMode: </td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>mode</em> </td>
<td> </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
sets the user mode for the IRC client<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>string to set </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="20ded6131f5bf067363a4701d2164907"></a><!-- doxytag: member="IRCClientSession::whois:" ref="20ded6131f5bf067363a4701d2164907" args="(NSString *nick)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) whois: </td>
<td></td>
<td class="paramtype">(NSString *) </td>
<td class="paramname"> <em>nick</em> </td>
<td> </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
sends a WHOIS request to the IRC server<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>nick</em> </td><td>nickname of the irc client to whois. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Property Documentation</h2>
<a class="anchor" name="fd38f656f1f7b03495e26fe982bb9e2a"></a><!-- doxytag: member="IRCClientSession::channels" ref="fd38f656f1f7b03495e26fe982bb9e2a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSMutableDictionary *) channels<code> [read, assign]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
An NSMutableDictionary of channels that the client is currently connected to.<p>
You should not modify this.
</div>
</div><p>
<a class="anchor" name="ff1874c72e785b2097b9ef7ea8856557"></a><!-- doxytag: member="IRCClientSession::delegate" ref="ff1874c72e785b2097b9ef7ea8856557" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (id) delegate<code> [read, write, assign]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
delegate to send events to.
</div>
</div><p>
<a class="anchor" name="2b8b240d57a57acce3186768308c667c"></a><!-- doxytag: member="IRCClientSession::encoding" ref="2b8b240d57a57acce3186768308c667c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSStringEncoding) encoding<code> [read, write, assign]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The default text encoding for messages on this server.<p>
This affects messages received via PRIVMSG and NOTICE, and TOPIC in a channel. You may change this at any time.
</div>
</div><p>
<a class="anchor" name="4f678f5ad868a7e3d739b1e9ad415249"></a><!-- doxytag: member="IRCClientSession::nickname" ref="4f678f5ad868a7e3d739b1e9ad415249" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSString *) nickname<code> [read, write, copy]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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.
</div>
</div><p>
<a class="anchor" name="6e304e45ddb942ead5b3c044a2b09e0b"></a><!-- doxytag: member="IRCClientSession::password" ref="6e304e45ddb942ead5b3c044a2b09e0b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSString *) password<code> [read, write, copy]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Server password to provide on connect (may be left empty or nil)
</div>
</div><p>
<a class="anchor" name="f4d8a5d0747ecb6ed2f55f282582e8cf"></a><!-- doxytag: member="IRCClientSession::port" ref="f4d8a5d0747ecb6ed2f55f282582e8cf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSString *) port<code> [read, write, copy]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
IRC port to connect to
</div>
</div><p>
<a class="anchor" name="c124ffbdf87a785981c3e330f5a90088"></a><!-- doxytag: member="IRCClientSession::realname" ref="c124ffbdf87a785981c3e330f5a90088" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSString *) realname<code> [read, write, copy]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Realname of the connected client.<p>
Setting this after connection does nothing.
</div>
</div><p>
<a class="anchor" name="cb1376cfad37cc503c21fa1235f39fa0"></a><!-- doxytag: member="IRCClientSession::server" ref="cb1376cfad37cc503c21fa1235f39fa0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSString *) server<code> [read, write, copy]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
IRC server to connect to
</div>
</div><p>
<a class="anchor" name="7f3f3efa9e35c82bc92d89b2f264ca88"></a><!-- doxytag: member="IRCClientSession::session" ref="7f3f3efa9e35c82bc92d89b2f264ca88" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (irc_session_t *) session<code> [read, write, assign]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The underlying libircclient handle
</div>
</div><p>
<a class="anchor" name="281dfe78f639e87899d3aff71983484e"></a><!-- doxytag: member="IRCClientSession::username" ref="281dfe78f639e87899d3aff71983484e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSString *) username<code> [read, write, copy]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Username of the connected client. Also known as the ident.<p>
Setting this after connection does nothing.
</div>
</div><p>
<a class="anchor" name="6d2142efde508caf40c8b86e7dd1756c"></a><!-- doxytag: member="IRCClientSession::version" ref="6d2142efde508caf40c8b86e7dd1756c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSString *) version<code> [read, write, copy]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The version string for the client to send back on CTCP VERSION requests
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_i_r_c_client_session_8h-source.html">IRCClientSession.h</a><li>IRCClientSession.m</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sat Jan 10 18:10:37 2009 for IRCClient by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>