docs/toolkit/manual/silcstream-SilcStreamOps.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>Structure <A NAME="SilcStreamOps">SilcStreamOps</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 struct { ... } <B>SilcStreamOps</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     SILC Stream operations structure.  This structure includes callback
 170     functions to the actual stream implementation.  Any stream that
 171     use SILC Stream abstraction must fill this structure with the actual
 172     stream implementation.
 173
 174     Each stream implementation MUST set this structure as the first field
 175     in their stream structure.  As it is that structure that is passed
 176     to the silc_stream_* routines, the SILC Stream API expects that the
 177     <A HREF="silcstream-SilcStream.html">SilcStream</A> context starts with this structure.
 178
 179 </FONT></PRE><FONT SIZE="+1"><B>
 180 <FONT COLOR="#000055">EXAMPLE
 181 </FONT></B></FONT>
 182 <PRE><FONT FACE="courier" size="3">
 183     typedef struct {
 184       const <B>SilcStreamOps</B> *ops;
 185       ... other stuff ...
 186     } *SilcFooStream;
 187
 188     SilcFooStream foo;
 189     <A HREF="silcstream-silc_stream_write.html">silc_stream_write</A>(foo, data, data_len);
 190
 191 </FONT></PRE><FONT SIZE="+1"><B>
 192 <FONT COLOR="#000055">SOURCE
 193 </FONT></B></FONT>
 194 <PRE><FONT FACE="courier" size="3">    typedef struct {
 195       /* This is called to read data from the stream.  This is called when
 196          <A HREF="silcstream-silc_stream_read.html">silc_stream_read</A> function was called. */
 197       int (*read)(<A HREF="silcstream-SilcStream.html">SilcStream</A> stream, unsigned char *buf, <A HREF="silctypes-SilcUInt32.html">SilcUInt32</A> buf_len);
 198
 199       /* This is called when writing data to the stream.  This is called when
 200          <A HREF="silcstream-silc_stream_write.html">silc_stream_write</A> function was called. */
 201       int (*write)(<A HREF="silcstream-SilcStream.html">SilcStream</A> stream, const unsigned char *data,
 202                    <A HREF="silctypes-SilcUInt32.html">SilcUInt32</A> data_len);
 203
 204       /* This is called to close the stream.  This is called when the
 205          <A HREF="silcstream-silc_stream_close.html">silc_stream_close</A> function was called. */
 206       <A HREF="silctypes-SilcBool.html">SilcBool</A> (*close)(<A HREF="silcstream-SilcStream.html">SilcStream</A> stream);
 207
 208       /* This is called to destroy the stream.  This is called when the
 209          <A HREF="silcstream-silc_stream_destroy.html">silc_stream_destroy</A> function was called. */
 210       void (*destroy)(<A HREF="silcstream-SilcStream.html">SilcStream</A> stream);
 211
 212       /* This is called to set a notifier callback to the stream and schedule
 213          the stream.  Stream should not be scheduled before calling this
 214          function.  If stream does not need scheduler then the scheduler can
 215          be ignored.  This is called when <A HREF="silcstream-silc_stream_set_notifier.html">silc_stream_set_notifier</A> was called.
 216          Returns <A HREF="silctypes-FALSE.html">FALSE</A> if the stream could not be scheduled. */
 217       <A HREF="silctypes-SilcBool.html">SilcBool</A> (*notifier)(<A HREF="silcstream-SilcStream.html">SilcStream</A> stream, <A HREF="silcschedule-SilcSchedule.html">SilcSchedule</A> schedule,
 218                            <A HREF="silcstream-SilcStreamNotifier.html">SilcStreamNotifier</A> callback, void *context);
 219
 220       /* This is called to return the associated scheduler, if set.  This is
 221          called when <A HREF="silcstream-silc_stream_get_schedule.html">silc_stream_get_schedule</A> was called. */
 222       <A HREF="silcschedule-SilcSchedule.html">SilcSchedule</A> (*get_schedule)(<A HREF="silcstream-SilcStream.html">SilcStream</A> stream);
 223     } <B>SilcStreamOps</B>;</FONT></PRE>
 224 <br /><br /><br /><br />
 225     </td></tr>
 226    </table>
 227   </td>
 228
 229   <td bgcolor="#cccccc" background="dot.gif">
 230    <img src="space.gif" width="1" height="1" border="0" alt=""></td>
 231
 232   <td width="180" bgcolor="#f0f0f0">
 233     <img src="space.gif" width="1" height="1" border="0" alt="">
 234     <table width="100%" cellpadding="4" cellspacing="0">
 235     <tr valign="top"><td>
 236 <br />
 237 <font face="Helvetica,Arial,Sans-serif" size="1">
 238 <A HREF="silcstream.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC Stream Interface</A><BR>
 239 <A HREF="silcstream-SilcStream.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcStream</A><BR>
 240 <A HREF="silcstream-SilcStreamStatus.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcStreamStatus</A><BR>
 241 <A HREF="silcstream-SilcStreamNotifier.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcStreamNotifier</A><BR>
 242 <A HREF="silcstream-SilcStreamOps.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcStreamOps</A><BR>
 243 <A HREF="silcstream-silc_stream_read.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_stream_read</A><BR>
 244 <A HREF="silcstream-silc_stream_write.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_stream_write</A><BR>
 245 <A HREF="silcstream-silc_stream_close.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_stream_close</A><BR>
 246 <A HREF="silcstream-silc_stream_destroy.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_stream_destroy</A><BR>
 247 <A HREF="silcstream-silc_stream_set_notifier.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_stream_set_notifier</A><BR>
 248 <A HREF="silcstream-silc_stream_get_schedule.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_stream_get_schedule</A><BR>
 249 </font>
 250
 251 <br /><br /><br /><br />
 252     </td></tr>
 253     </table>
 254   </td>
 255 </tr>
 256 </table>
 257
 258 <table border="0" cellspacing="0" cellpadding="0" width="100%">
 259 <tr bgcolor="#444444"><td><img src="space.gif" width="1" height="1"border="0" alt="" ></td></tr>
 260 </table>
 261 <table border="0" cellspacing="0" cellpadding="6" width="100%">
 262  <tr valign="top" bgcolor="#dddddd">
 263   <td><small>Copyright &copy; 2001 - 2007 SILC Project<br />
 264     <a href="http://silcnet.org">SILC Project Website</a></small></td>
 265   <td align="right"><small>
 266    <a href="index.html">SILC Toolkit Reference Manual</a><br />
 267    <a href="toolkit_index.html">Index</a></small></td>
 268    </small></td>
 269  </tr>
 270 </table>
 271
 272 </body>
 273 </html>