Added doc/runtime.in/intro.html HTML documentation.
[runtime.git] / doc / runtime.in / intro.html
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3                       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 <html  xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5 <head>
6 <meta http-equiv="Content-Style-Type" content="text/css" />
7 <meta http-equiv="Content-type" content="text/html; charset=ISO-8859-1" />
8 <link rel="stylesheet" href="./runtime.css" type="text/css" />
9 <title>SILC Runtime Toolkit</title>
10 </head>
11 <body>
12
13 <div id="logo">
14 <table border="0" cellspacing="0" cellpadding="6" width="100%">
15  <tr valign="top">
16   <td>Copyright &copy; 2001 - 2008 SILC Project<br />
17     <a href="http://silc.fi">SILC Project Website</a></td>
18   <td align="right">
19    <a href="index.html">SILC Runtime Toolkit Manual</a><br />
20    <a href="masterindex.html">Index</a></small></td>
21  </tr>
22 </table>
23 </div>
24
25 <div id="contentwrapper">
26 <div id="navigation">
27 </div> <!-- navigation -->
28 <div id="content">
29 <h3>Introduction</h3>
30 <p>
31 SILC Runtime Toolkit (SRT) provides useful utility functions for
32 application programmers.  SRT can be used as the sole and main runtime
33 in any application.  It provides application main loop, hash table, lists,
34 atomic operations, threads, locks, queues, file descriptor stream, socket
35 stream, network routines, a finite state machine, memory pool, random
36 number generator, buffers, regular expressions, and many many other
37 features.
38 </p>
39
40 <p>
41 SRT natively supports multiple platforms; Unix/Linux, Windows, Mac OS X
42 and Symbian OS, and all APIs work identically or nearly identically on all
43 support platforms.  The SRT does not have any special third party
44 dependencies.  On most Unix/Linux platforms only external dependency is
45 POSIX threads library.  On Windows and Symbian OS no special dependencies
46 exist.
47  </p>
48
49 <p>
50 SRT and all of its APIs are entirely reentrant as long as different
51 context is used in each thread.  None of the APIs use global or static
52 variables, or access shared data without locking.  Some APIs are also
53 completely thread safe and can be freely used in multithreaded environment
54 without restrictions.  The Toolkit Reference Manual will always specify
55 which API is thread safe.
56 </p>
57
58 </div> <!-- content -->
59
60 </div> <!-- contentwrapper -->
61 <div id="footer">
62 <table border="0" cellspacing="0" cellpadding="6" width="100%">
63  <tr valign="top">
64   <td>Copyright &copy; 2001 - 2008 SILC Project<br />
65     <a href="http://silc.fi">SILC Project Website</a></td>
66   <td align="right">
67    <a href="index.html">SILC Runtime Toolkit Manual</a><br />
68    <a href="masterindex.html">Index</a></small></td>
69  </tr>
70 </table>
71 </div>
72
73 </body>
74 </html>