docs/toolkit/manual/silcfsm.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 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
 157 <HTML><HEAD>
 158 <TITLE>silcfsm.html</TITLE>
 159 <!-- Source: silcfsm.h -->
 160 <!-- Generated with ROBODoc Version 3.2.3 (May  5 2014) -->
 161 <!-- ROBODoc (c) 1994-2001 by Frans Slothouber and Jacco van Weert. -->
 162 </HEAD><BODY BGCOLOR="#FFFFFF">
 163 <BR>
 164
 165 <FONT SIZE="+2" COLOR="#000055"><B><A NAME="SILC Finite State Machine">SILC Finite State Machine</A></FONT></B><BR><SMALL>Header: silcfsm.h</SMALL><BR><BR>
 166
 167 <FONT SIZE="+1"><B>
 168 <FONT COLOR="#000055">DESCRIPTION
 169 </FONT></B></FONT>
 170 <PRE><FONT FACE="Helvetiva,Arial,Sans-serif">
 171  SILC FSM Interface implements a finite state machine.  The FSM can be
 172  used to implement all kinds of machines and protocols.  The FSM supports
 173  also threads and can be synchronized by using mutex locks.  The FSM
 174  also supports real system threads.  It is possible to create new FSM
 175  thread and then execute in real system thread, if platform supports
 176  threads.
 177
 178  The FSM provides also asynchronous events that can be used to wait for
 179  some events or states to occur.  The FSM events may be used as condition
 180  variables and signallers.  The FSM events can safely be used in FSM
 181  threads that are executed in real system threads.
 182
 183  To synchronize machines that use FSM threads that are executed in real
 184  system threads the SILC Mutex API (silcmutex.h) may be used.  Normal
 185  multi-threaded coding conventions apply when programming with real FSM
 186  threads.  If the FSM threads are not real system threads, synchronization
 187  is not required.
 188
 189 </FONT></PRE><LI><A HREF="silcfsm-SilcFSM.html">SilcFSM</A>
 190 <LI><A HREF="silcfsm-SilcFSMStruct.html">SilcFSMStruct</A>
 191 <LI><A HREF="silcfsm-SilcFSMThread.html">SilcFSMThread</A>
 192 <LI><A HREF="silcfsm-SilcFSMThreadStruct.html">SilcFSMThreadStruct</A>
 193 <LI><A HREF="silcfsm-SILC_FSM_CONTINUE.html">SILC_FSM_CONTINUE</A>
 194 <LI><A HREF="silcfsm-SILC_FSM_YIELD.html">SILC_FSM_YIELD</A>
 195 <LI><A HREF="silcfsm-SILC_FSM_WAIT.html">SILC_FSM_WAIT</A>
 196 <LI><A HREF="silcfsm-SILC_FSM_FINISH.html">SILC_FSM_FINISH</A>
 197 <LI><A HREF="silcfsm-SilcFSMDestructor.html">SilcFSMDestructor</A>
 198 <LI><A HREF="silcfsm-SilcFSMThreadDestructor.html">SilcFSMThreadDestructor</A>
 199 <LI><A HREF="silcfsm-SILC_FSM_STATE.html">SILC_FSM_STATE</A>
 200 <LI><A HREF="silcfsm-SILC_FSM_CALL.html">SILC_FSM_CALL</A>
 201 <LI><A HREF="silcfsm-SILC_FSM_CALL_CONTINUE.html">SILC_FSM_CALL_CONTINUE</A>
 202 <LI><A HREF="silcfsm-SILC_FSM_CALL_CONTINUE_SYNC.html">SILC_FSM_CALL_CONTINUE_SYNC</A>
 203 <LI><A HREF="silcfsm-SILC_FSM_THREAD_WAIT.html">SILC_FSM_THREAD_WAIT</A>
 204 <LI><A HREF="silcfsm-silc_fsm_alloc.html">silc_fsm_alloc</A>
 205 <LI><A HREF="silcfsm-silc_fsm_init.html">silc_fsm_init</A>
 206 <LI><A HREF="silcfsm-silc_fsm_thread_alloc.html">silc_fsm_thread_alloc</A>
 207 <LI><A HREF="silcfsm-silc_fsm_thread_init.html">silc_fsm_thread_init</A>
 208 <LI><A HREF="silcfsm-silc_fsm_free.html">silc_fsm_free</A>
 209 <LI><A HREF="silcfsm-silc_fsm_start.html">silc_fsm_start</A>
 210 <LI><A HREF="silcfsm-silc_fsm_start_sync.html">silc_fsm_start_sync</A>
 211 <LI><A HREF="silcfsm-silc_fsm_next.html">silc_fsm_next</A>
 212 <LI><A HREF="silcfsm-silc_fsm_next_later.html">silc_fsm_next_later</A>
 213 <LI><A HREF="silcfsm-silc_fsm_continue.html">silc_fsm_continue</A>
 214 <LI><A HREF="silcfsm-silc_fsm_continue_sync.html">silc_fsm_continue_sync</A>
 215 <LI><A HREF="silcfsm-silc_fsm_finish.html">silc_fsm_finish</A>
 216 <LI><A HREF="silcfsm-silc_fsm_set_context.html">silc_fsm_set_context</A>
 217 <LI><A HREF="silcfsm-silc_fsm_get_context.html">silc_fsm_get_context</A>
 218 <LI><A HREF="silcfsm-silc_fsm_set_state_context.html">silc_fsm_set_state_context</A>
 219 <LI><A HREF="silcfsm-silc_fsm_get_state_context.html">silc_fsm_get_state_context</A>
 220 <LI><A HREF="silcfsm-silc_fsm_get_schedule.html">silc_fsm_get_schedule</A>
 221 <LI><A HREF="silcfsm-silc_fsm_get_machine.html">silc_fsm_get_machine</A>
 222 <LI><A HREF="silcfsm-silc_fsm_is_started.html">silc_fsm_is_started</A>
 223 <LI><A HREF="silcfsm-SilcFSMEvent.html">SilcFSMEvent</A>
 224 <LI><A HREF="silcfsm-SilcFSMEventStruct.html">SilcFSMEventStruct</A>
 225 <LI><A HREF="silcfsm-silc_fsm_event_alloc.html">silc_fsm_event_alloc</A>
 226 <LI><A HREF="silcfsm-silc_fsm_event_init.html">silc_fsm_event_init</A>
 227 <LI><A HREF="silcfsm-silc_fsm_event_free.html">silc_fsm_event_free</A>
 228 <LI><A HREF="silcfsm-SILC_FSM_EVENT_WAIT.html">SILC_FSM_EVENT_WAIT</A>
 229 <LI><A HREF="silcfsm-SILC_FSM_EVENT_TIMEDWAIT.html">SILC_FSM_EVENT_TIMEDWAIT</A>
 230 <LI><A HREF="silcfsm-SILC_FSM_EVENT_SIGNAL.html">SILC_FSM_EVENT_SIGNAL</A>
 231 </BODY></HTML>
 232 <br /><br /><br /><br />
 233     </td></tr>
 234    </table>
 235   </td>
 236
 237   <td bgcolor="#cccccc" background="dot.gif">
 238    <img src="space.gif" width="1" height="1" border="0" alt=""></td>
 239
 240   <td width="180" bgcolor="#f0f0f0">
 241     <img src="space.gif" width="1" height="1" border="0" alt="">
 242     <table width="100%" cellpadding="4" cellspacing="0">
 243     <tr valign="top"><td>
 244 <br />
 245 <font face="Helvetica,Arial,Sans-serif" size="1">
 246 </font>
 247
 248 <br /><br /><br /><br />
 249     </td></tr>
 250     </table>
 251   </td>
 252 </tr>
 253 </table>
 254
 255 <table border="0" cellspacing="0" cellpadding="0" width="100%">
 256 <tr bgcolor="#444444"><td><img src="space.gif" width="1" height="1"border="0" alt="" ></td></tr>
 257 </table>
 258 <table border="0" cellspacing="0" cellpadding="6" width="100%">
 259  <tr valign="top" bgcolor="#dddddd">
 260   <td><small>Copyright &copy; 2001 - 2007 SILC Project<br />
 261     <a href="http://silcnet.org">SILC Project Website</a></small></td>
 262   <td align="right"><small>
 263    <a href="index.html">SILC Toolkit Reference Manual</a><br />
 264    <a href="toolkit_index.html">Index</a></small></td>
 265    </small></td>
 266  </tr>
 267 </table>
 268
 269 </body>
 270 </html>