docs/toolkit/manual/silccommand-SilcCommand.html

   1
   2 <html>
   3 <head>
   4  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-a" />
   5  <meta http-equiv="Content-Language" content="en" />
   6  <meta name="description" content="SILC Secure Internet Live Conferencing" />
   7  <meta name="keywords" content="SILC, secure, chat, protocol, cipher, encrypt, SKE" />
   8  <meta content="INDEX, FOLLOW" name="ROBOTS" />
   9  <style type="text/css">
  10   <!--
  11   body { color: #000000; background: #f0f0f0; font-family: Helvetica, Arial, Sans-serif; }
  12   a:link { text-decoration: none; color: #2f488f; }
  13   a:visited { text-decoration: none;color: #2f488f; }
  14   a:active { text-decoration: none; color: #2f488f; }
  15   -->
  16  </style>
  17 </head>
  18
  19 <body topmargin="0" leftmargin="0" marginheight="0" marginwidth="0">
  20
  21 <table border="0" cellspacing="0" cellpadding="6" width="100%">
  22  <tr valign="top" bgcolor="#dddddd">
  23   <td><small>Copyright &copy; 2001 - 2007 SILC Project<br />
  24     <a href="http://silcnet.org">SILC Project Website</a></small></td>
  25   <td align="right"><small>
  26    <a href="index.html">SILC Toolkit Reference Manual</a><br />
  27    <a href="toolkit_index.html">Index</a></small></td>
  28    </small></td>
  29  </tr>
  30 </table>
  31 <table border="0" cellspacing="0" cellpadding="0" width="100%">
  32 <tr bgcolor="#444444"><td><img src="space.gif" width="1" height="1"border="0" alt="" ></td></tr>
  33 </table>
  34
  35 <table cellpadding="0" cellspacing="0" border="0">
  36  <tr valign="top">
  37
  38   <td width="200" bgcolor="#f0f0f0">
  39    <img src="space.gif" width="1" height="1" border="0" alt="">
  40    <table width="100%" cellpadding="2" cellspacing="2" border="0">
  41     <tr valign="top"><td>
  42 <br />
  43 <small>
  44 <!-- Template file for the big index that appears in the Toolkit reference
  45 manual on the left side.  With this file it is possible to add other than
  46 automatically generated links to that list. -->
  47
  48 <a href="index.html"><img src="box.gif" border="0" alt="">SILC Toolkit Reference Manual</a><br />
  49
  50
  51 <a href=silccryptlib.html><img src=box.gif border=0 alt=>SILC Crypto Library</a><br />
  52 &nbsp;&nbsp;&nbsp; <a href=silcrng_intro.html><img src=box2.gif border=0 alt=>Introduction to SILC RNG</a><br />
  53 &nbsp;&nbsp;&nbsp; <a href=silcrng.html><img src=box2.gif border=0 alt=>SILC RNG Interface</a><br />
  54 &nbsp;&nbsp;&nbsp; <a href=silccipher.html><img src=box2.gif border=0 alt=>SILC Cipher API</a><br />
  55 &nbsp;&nbsp;&nbsp; <a href=silcpkcs.html><img src=box2.gif border=0 alt=>SILC PKCS API</a><br />
  56 &nbsp;&nbsp;&nbsp; <a href=silcpk.html><img src=box2.gif border=0 alt=>SILC Public Key API</a><br />
  57 &nbsp;&nbsp;&nbsp; <a href=silcpkcs1.html><img src=box2.gif border=0 alt=>SILC PKCS #1 API</a><br />
  58 &nbsp;&nbsp;&nbsp; <a href=silchash.html><img src=box2.gif border=0 alt=>SILC Hash Interface</a><br />
  59 &nbsp;&nbsp;&nbsp; <a href=silchmac.html><img src=box2.gif border=0 alt=>SILC HMAC Interface</a><br />
  60 <a href=silccorelib.html><img src=box.gif border=0 alt=>SILC Core Library</a><br />
  61 &nbsp;&nbsp;&nbsp; <a href=silcauth.html><img src=box2.gif border=0 alt=>SILC Authentication Interface</a><br />
  62 &nbsp;&nbsp;&nbsp; <a href=silcmessage.html><img src=box2.gif border=0 alt=>SILC Message Interface</a><br />
  63 &nbsp;&nbsp;&nbsp; <a href=silcchannel.html><img src=box2.gif border=0 alt=>SILC Channel Interface</a><br />
  64 &nbsp;&nbsp;&nbsp; <a href=silccommand.html><img src=box2.gif border=0 alt=>SILC Command Interface</a><br />
  65 &nbsp;&nbsp;&nbsp; <a href=silcnotify.html><img src=box2.gif border=0 alt=>SILC Notify Interface</a><br />
  66 &nbsp;&nbsp;&nbsp; <a href=silcstatus.html><img src=box2.gif border=0 alt=>SILC Status Types</a><br />
  67 &nbsp;&nbsp;&nbsp; <a href=silcmode.html><img src=box2.gif border=0 alt=>SILC Modes</a><br />
  68 &nbsp;&nbsp;&nbsp; <a href=silcid.html><img src=box2.gif border=0 alt=>SILC ID Interface</a><br />
  69 &nbsp;&nbsp;&nbsp; <a href=silcargument.html><img src=box2.gif border=0 alt=>SILC Argument Interface</a><br />
  70 &nbsp;&nbsp;&nbsp; <a href=silcattrs.html><img src=box2.gif border=0 alt=>SILC Attributes Interface</a><br />
  71 &nbsp;&nbsp;&nbsp; <a href=silcpacket.html><img src=box2.gif border=0 alt=>Packet Engine Interface</a><br />
  72 &nbsp;&nbsp;&nbsp; <a href=silcpubkey.html><img src=box2.gif border=0 alt=>SILC Public Key Payload Interface</a><br />
  73 <a href=silcskelib.html><img src=box.gif border=0 alt=>SILC Key Exchange Library</a><br />
  74 &nbsp;&nbsp;&nbsp; <a href=silcske.html><img src=box2.gif border=0 alt=>SILC SKE Interface</a><br />
  75 &nbsp;&nbsp;&nbsp; <a href=silcconnauth.html><img src=box2.gif border=0 alt=>SILC Connection Authentication Interface</a><br />
  76 <a href=silcvcardlib.html><img src=box.gif border=0 alt=>SILC VCard Library</a><br />
  77 &nbsp;&nbsp;&nbsp; <a href=silcvcard.html><img src=box2.gif border=0 alt=>SILC VCard Interface</a><br />
  78 <a href=silcmathlib.html><img src=box.gif border=0 alt=>SILC Math Library</a><br />
  79 &nbsp;&nbsp;&nbsp; <a href=silcmp.html><img src=box2.gif border=0 alt=>SILC MP Interface</a><br />
  80 &nbsp;&nbsp;&nbsp; <a href=silcmath.html><img src=box2.gif border=0 alt=>SILC Math Interface</a><br />
  81 <a href=silcclientlib.html><img src=box.gif border=0 alt=>SILC Client Library</a><br />
  82 &nbsp;&nbsp;&nbsp; <a href=silcclient_using.html><img src=box2.gif border=0 alt=>Using SILC Client Library Tutorial</a><br />
  83 &nbsp;&nbsp;&nbsp; <a href=command_reply_args.html><img src=box2.gif border=0 alt=>Arguments for <b>command_reply</b> Client Operation</a><br />
  84 &nbsp;&nbsp;&nbsp; <a href=silcstatus_args.html><img src=box2.gif border=0 alt=>SilcStatus Error Arguments in <b>command_reply</b> Client Operation</a><br />
  85 &nbsp;&nbsp;&nbsp; <a href=notifyargs.html><img src=box2.gif border=0 alt=>Arguments for <b>notify</b> Client Operation</a><br />
  86 &nbsp;&nbsp;&nbsp; <a href=silcclient_unicode.html><img src=box2.gif border=0 alt=>Unicode and UTF-8 Strings in Client Library</a><br />
  87 &nbsp;&nbsp;&nbsp; <a href=silcclient.html><img src=box2.gif border=0 alt=>Client Library Interface Reference</a><br />
  88 &nbsp;&nbsp;&nbsp; <a href=silcclient_entry.html><img src=box2.gif border=0 alt=>Client Entry Interface Reference</a><br />
  89 <a href=silcasn1lib.html><img src=box.gif border=0 alt=>SILC ASN.1 Library</a><br />
  90 &nbsp;&nbsp;&nbsp; <a href=silcasn1.html><img src=box2.gif border=0 alt=>SILC ASN.1 Interface</a><br />
  91 &nbsp;&nbsp;&nbsp; <a href=silcber.html><img src=box2.gif border=0 alt=>SILC BER interface</a><br />
  92 <a href=silchttplib.html><img src=box.gif border=0 alt=>SILC HTTP Library</a><br />
  93 &nbsp;&nbsp;&nbsp; <a href=silchttpserver.html><img src=box2.gif border=0 alt=>SILC HTTP Server Interface</a><br />
  94 &nbsp;&nbsp;&nbsp; <a href=silchttpphp.html><img src=box2.gif border=0 alt=>SILC HTTP PHP Translator</a><br />
  95 <a href=silcutillib.html><img src=box.gif border=0 alt=>SILC Utility Library</a><br />
  96 &nbsp;&nbsp;&nbsp; <a href=silctypes.html><img src=box2.gif border=0 alt=>Basic Types and Definitions</a><br />
  97 &nbsp;&nbsp;&nbsp; <a href=silcbuffer.html><img src=box2.gif border=0 alt=>Data Buffer Interface</a><br />
  98 &nbsp;&nbsp;&nbsp; <a href=silcbuffmt.html><img src=box2.gif border=0 alt=>Data Buffer Format Interface</a><br />
  99 &nbsp;&nbsp;&nbsp; <a href=silchashtable.html><img src=box2.gif border=0 alt=>Hash Table Interface</a><br />
 100 &nbsp;&nbsp;&nbsp; <a href=silcmemory.html><img src=box2.gif border=0 alt=>Memory Allocation Interface</a><br />
 101 &nbsp;&nbsp;&nbsp; <a href=silcstack.html><img src=box2.gif border=0 alt=>Data Stack (memory pool) Interface</a><br />
 102 &nbsp;&nbsp;&nbsp; <a href=silcfsm.html><img src=box2.gif border=0 alt=>Finite State Machine Interface</a><br />
 103 &nbsp;&nbsp;&nbsp; <a href=silcthread.html><img src=box2.gif border=0 alt=>Thread Interface</a><br />
 104 &nbsp;&nbsp;&nbsp; <a href=silcmutex.html><img src=box2.gif border=0 alt=>Mutual Exclusion Lock Interface</a><br />
 105 &nbsp;&nbsp;&nbsp; <a href=silccond.html><img src=box2.gif border=0 alt=>Condition Variable Interface</a><br />
 106 &nbsp;&nbsp;&nbsp; <a href=silcatomic.html><img src=box2.gif border=0 alt=>Atomic Operations Interface</a><br />
 107 &nbsp;&nbsp;&nbsp; <a href=silcnet.html><img src=box2.gif border=0 alt=>Network (TCP and UDP) Interface</a><br />
 108 &nbsp;&nbsp;&nbsp; <a href=silcschedule.html><img src=box2.gif border=0 alt=>Scheduler Interface</a><br />
 109 &nbsp;&nbsp;&nbsp; <a href=silcasync.html><img src=box2.gif border=0 alt=>Asynchronous Operation Interface</a><br />
 110 &nbsp;&nbsp;&nbsp; <a href=silcstream.html><img src=box2.gif border=0 alt=>Abstract Stream Interface</a><br />
 111 &nbsp;&nbsp;&nbsp; <a href=silcsocketstream.html><img src=box2.gif border=0 alt=>Socket Stream Interface</a><br />
 112 &nbsp;&nbsp;&nbsp; <a href=silcfdstream.html><img src=box2.gif border=0 alt=>File Descriptor Stream Interface</a><br />
 113 &nbsp;&nbsp;&nbsp; <a href=silcfileutil.html><img src=box2.gif border=0 alt=>File Utility Functions</a><br />
 114 &nbsp;&nbsp;&nbsp; <a href=silcstrutil.html><img src=box2.gif border=0 alt=>String Utility Interface</a><br />
 115 &nbsp;&nbsp;&nbsp; <a href=silcsnprintf.html><img src=box2.gif border=0 alt=>Snprintf Interface</a><br />
 116 &nbsp;&nbsp;&nbsp; <a href=silcutf8.html><img src=box2.gif border=0 alt=>UTF-8 String Interface</a><br />
 117 &nbsp;&nbsp;&nbsp; <a href=silcstringprep.html><img src=box2.gif border=0 alt=>Stringprep Interface</a><br />
 118 &nbsp;&nbsp;&nbsp; <a href=silcutil.html><img src=box2.gif border=0 alt=>Utility Functions</a><br />
 119 &nbsp;&nbsp;&nbsp; <a href=silclist.html><img src=box2.gif border=0 alt=>List Interface</a><br />
 120 &nbsp;&nbsp;&nbsp; <a href=silcdlist.html><img src=box2.gif border=0 alt=>Dynamic List Interface</a><br />
 121 &nbsp;&nbsp;&nbsp; <a href=silcmime.html><img src=box2.gif border=0 alt=>MIME Interface</a><br />
 122 &nbsp;&nbsp;&nbsp; <a href=silctime.html><img src=box2.gif border=0 alt=>Time Utility Functions</a><br />
 123 &nbsp;&nbsp;&nbsp; <a href=silclog.html><img src=box2.gif border=0 alt=>Logging Interface</a><br />
 124 &nbsp;&nbsp;&nbsp; <a href=silcconfig.html><img src=box2.gif border=0 alt=>Config File Interface</a><br />
 125 <a href=silcskrlib.html><img src=box.gif border=0 alt=>SILC Key Repository Library</a><br />
 126 &nbsp;&nbsp;&nbsp; <a href=silcskr.html><img src=box2.gif border=0 alt=>SILC SKR Interface</a><br />
 127 <a href=silcaputillib.html><img src=box.gif border=0 alt=>SILC Application Utility Library</a><br />
 128 &nbsp;&nbsp;&nbsp; <a href=silcapputil.html><img src=box2.gif border=0 alt=>SILC Application Utilities</a><br />
 129 &nbsp;&nbsp;&nbsp; <a href=silcidcache.html><img src=box2.gif border=0 alt=>SILC ID Cache Interface</a><br />
 130 <a href=silcsftplib.html><img src=box.gif border=0 alt=>SILC SFTP Library</a><br />
 131 &nbsp;&nbsp;&nbsp; <a href=silcsftp.html><img src=box2.gif border=0 alt=>SILC SFTP Interface</a><br />
 132 &nbsp;&nbsp;&nbsp; <a href=silcsftp_fs.html><img src=box2.gif border=0 alt=>SFTP Filesystems Interface</a><br />
 133
 134 <br />
 135 <b>Resource Links</b>
 136 <br />
 137 <a href="http://silcnet.org"><img src="box.gif" border="0" alt="">SILC Project Website</a><br />
 138 <a href="http://silcnet.org/support/documentation/"><img src="box.gif" border="0" alt="">SILC Protocol Documentation</a><br />
 139 <a href="http://silcnet.org/support/documentation/wp/"><img src="box.gif" border="0" alt="">SILC White Paper</a><br />
 140 <a href="http://silcnet.org/support/faq/"><img src="box.gif" border="0" alt="">SILC FAQs</a><br />
 141
 142 </small>
 143 <br /><br /><br /><br />
 144     </td></tr>
 145    </table>
 146   </td>
 147
 148   <td bgcolor="#cccccc" background="dot.gif">
 149    <img src="space.gif" width="1" height="1" border="0" alt=""></td>
 150
 151   <td width="720" bgcolor="#ffffff">
 152    <img src="space.gif" width="1" height="1" border="0" alt="">
 153    <table cellpadding="2" cellspacing="6" width="100%">
 154     <tr><td valign="top">
 155 <br />
 156
 157 <FONT SIZE="+2" COLOR="#000055"><B><A NAME="SilcCommand">SilcCommand</A></FONT></B><BR><BR>
 158
 159 <FONT SIZE="+1"><B>
 160 <FONT COLOR="#000055">NAME
 161 </FONT></B></FONT>
 162 <PRE><FONT FACE="courier" size="3">
 163     typedef <A HREF="silctypes-SilcUInt8.html">SilcUInt8</A> <B>SilcCommand</B>;
 164
 165 </FONT></PRE><FONT SIZE="+1"><B>
 166 <FONT COLOR="#000055">DESCRIPTION
 167 </FONT></B></FONT>
 168 <PRE><FONT FACE="Helvetiva,Arial,Sans-serif">
 169     The <B>SilcCommand</B> type definition and the commands. The commands
 170     listed here are the official SILC Commands and they have client
 171     and server counterparts.
 172
 173 </FONT></PRE><FONT SIZE="+1"><B>
 174 <FONT COLOR="#000055">SOURCE
 175 </FONT></B></FONT>
 176 <PRE><FONT FACE="courier" size="3">    typedef <A HREF="silctypes-SilcUInt8.html">SilcUInt8</A> <B>SilcCommand</B>;
 177
 178     /* All SILC commands. These are commands that have client and server
 179        counterparts. */
 180     #define SILC_COMMAND_NONE               0
 181     #define SILC_COMMAND_WHOIS              1
 182     #define SILC_COMMAND_WHOWAS             2
 183     #define SILC_COMMAND_IDENTIFY           3
 184     #define SILC_COMMAND_NICK               4
 185     #define SILC_COMMAND_LIST               5
 186     #define SILC_COMMAND_TOPIC              6
 187     #define SILC_COMMAND_INVITE             7
 188     #define SILC_COMMAND_QUIT               8
 189     #define SILC_COMMAND_KILL               9
 190     #define SILC_COMMAND_INFO               10
 191     #define SILC_COMMAND_STATS              11
 192     #define SILC_COMMAND_PING               12
 193     #define SILC_COMMAND_OPER               13
 194     #define SILC_COMMAND_JOIN               14
 195     #define SILC_COMMAND_MOTD               15
 196     #define SILC_COMMAND_UMODE              16
 197     #define SILC_COMMAND_CMODE              17
 198     #define SILC_COMMAND_CUMODE             18
 199     #define SILC_COMMAND_KICK               19
 200     #define SILC_COMMAND_BAN                20
 201     #define SILC_COMMAND_DETACH             21
 202     #define SILC_COMMAND_WATCH              22
 203     #define SILC_COMMAND_SILCOPER           23
 204     #define SILC_COMMAND_LEAVE              24
 205     #define SILC_COMMAND_USERS              25
 206     #define SILC_COMMAND_GETKEY             26
 207     #define SILC_COMMAND_SERVICE            27
 208
 209     /* Private range start */
 210     #define SILC_COMMAND_PRIVATE            200
 211     #define SILC_COMMAND_PRIV_CONNECT       200
 212     #define SILC_COMMAND_PRIV_CLOSE         201
 213     #define SILC_COMMAND_PRIV_SHUTDOWN      202
 214
 215     /* Reserved */
 216     #define SILC_COMMAND_RESERVED           255</FONT></PRE>
 217 <br /><br /><br /><br />
 218     </td></tr>
 219    </table>
 220   </td>
 221
 222   <td bgcolor="#cccccc" background="dot.gif">
 223    <img src="space.gif" width="1" height="1" border="0" alt=""></td>
 224
 225   <td width="180" bgcolor="#f0f0f0">
 226     <img src="space.gif" width="1" height="1" border="0" alt="">
 227     <table width="100%" cellpadding="4" cellspacing="0">
 228     <tr valign="top"><td>
 229 <br />
 230 <font face="Helvetica,Arial,Sans-serif" size="1">
 231 <A HREF="silccommand.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC Command Interface</A><BR>
 232 <A HREF="silccommand-SilcCommandCb.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcCommandCb</A><BR>
 233 <A HREF="silccommand-SilcCommandPayload.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcCommandPayload</A><BR>
 234 <A HREF="silccommand-SilcCommandFlags.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcCommandFlags</A><BR>
 235 <A HREF="silccommand-SilcCommand.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcCommand</A><BR>
 236 <A HREF="silccommand-silc_command_payload_parse.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_command_payload_parse</A><BR>
 237 <A HREF="silccommand-silc_command_payload_encode.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_command_payload_encode</A><BR>
 238 <A HREF="silccommand-silc_command_payload_encode_payload.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_command_payload_encode_payload</A><BR>
 239 <A HREF="silccommand-silc_command_payload_encode_va.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_command_payload_encode_va</A><BR>
 240 <A HREF="silccommand-silc_command_payload_encode_vap.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_command_payload_encode_vap</A><BR>
 241 <A HREF="silccommand-silc_command_reply_payload_encode_va.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_command_reply_payload_encode_va</A><BR>
 242 <A HREF="silccommand-silc_command_reply_payload_encode_vap.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_command_reply_payload_encode_vap</A><BR>
 243 <A HREF="silccommand-silc_command_free.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_command_free</A><BR>
 244 <A HREF="silccommand-silc_command_get.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_command_get</A><BR>
 245 <A HREF="silccommand-silc_command_get_args.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_command_get_args</A><BR>
 246 <A HREF="silccommand-silc_command_get_ident.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_command_get_ident</A><BR>
 247 <A HREF="silccommand-silc_command_get_status.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_command_get_status</A><BR>
 248 <A HREF="silccommand-silc_command_set_ident.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_command_set_ident</A><BR>
 249 <A HREF="silccommand-silc_command_set_command.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_command_set_command</A><BR>
 250 </font>
 251
 252 <br /><br /><br /><br />
 253     </td></tr>
 254     </table>
 255   </td>
 256 </tr>
 257 </table>
 258
 259 <table border="0" cellspacing="0" cellpadding="0" width="100%">
 260 <tr bgcolor="#444444"><td><img src="space.gif" width="1" height="1"border="0" alt="" ></td></tr>
 261 </table>
 262 <table border="0" cellspacing="0" cellpadding="6" width="100%">
 263  <tr valign="top" bgcolor="#dddddd">
 264   <td><small>Copyright &copy; 2001 - 2007 SILC Project<br />
 265     <a href="http://silcnet.org">SILC Project Website</a></small></td>
 266   <td align="right"><small>
 267    <a href="index.html">SILC Toolkit Reference Manual</a><br />
 268    <a href="toolkit_index.html">Index</a></small></td>
 269    </small></td>
 270  </tr>
 271 </table>
 272
 273 </body>
 274 </html>