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">
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; }
19 <body topmargin="0" leftmargin="0" marginheight="0" marginwidth="0">
21 <table border="0" cellspacing="0" cellpadding="6" width="100%">
22 <tr valign="top" bgcolor="#dddddd">
23 <td><small>Copyright © 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>
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>
35 <table cellpadding="0" cellspacing="0" border="0">
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">
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. -->
48 <a href="index.html"><img src="box.gif" border="0" alt="">SILC Toolkit Reference Manual</a><br />
51 <a href=silccryptlib.html><img src=box.gif border=0 alt=>SILC Crypto Library</a><br />
52 <a href=silcrng_intro.html><img src=box2.gif border=0 alt=>Introduction to SILC RNG</a><br />
53 <a href=silcrng.html><img src=box2.gif border=0 alt=>SILC RNG Interface</a><br />
54 <a href=silccipher.html><img src=box2.gif border=0 alt=>SILC Cipher API</a><br />
55 <a href=silcpkcs.html><img src=box2.gif border=0 alt=>SILC PKCS API</a><br />
56 <a href=silcpk.html><img src=box2.gif border=0 alt=>SILC Public Key API</a><br />
57 <a href=silcpkcs1.html><img src=box2.gif border=0 alt=>SILC PKCS #1 API</a><br />
58 <a href=silchash.html><img src=box2.gif border=0 alt=>SILC Hash Interface</a><br />
59 <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 <a href=silcauth.html><img src=box2.gif border=0 alt=>SILC Authentication Interface</a><br />
62 <a href=silcmessage.html><img src=box2.gif border=0 alt=>SILC Message Interface</a><br />
63 <a href=silcchannel.html><img src=box2.gif border=0 alt=>SILC Channel Interface</a><br />
64 <a href=silccommand.html><img src=box2.gif border=0 alt=>SILC Command Interface</a><br />
65 <a href=silcnotify.html><img src=box2.gif border=0 alt=>SILC Notify Interface</a><br />
66 <a href=silcstatus.html><img src=box2.gif border=0 alt=>SILC Status Types</a><br />
67 <a href=silcmode.html><img src=box2.gif border=0 alt=>SILC Modes</a><br />
68 <a href=silcid.html><img src=box2.gif border=0 alt=>SILC ID Interface</a><br />
69 <a href=silcargument.html><img src=box2.gif border=0 alt=>SILC Argument Interface</a><br />
70 <a href=silcattrs.html><img src=box2.gif border=0 alt=>SILC Attributes Interface</a><br />
71 <a href=silcpacket.html><img src=box2.gif border=0 alt=>Packet Engine Interface</a><br />
72 <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 <a href=silcske.html><img src=box2.gif border=0 alt=>SILC SKE Interface</a><br />
75 <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 <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 <a href=silcmp.html><img src=box2.gif border=0 alt=>SILC MP Interface</a><br />
80 <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 <a href=silcclient_using.html><img src=box2.gif border=0 alt=>Using SILC Client Library Tutorial</a><br />
83 <a href=command_reply_args.html><img src=box2.gif border=0 alt=>Arguments for <b>command_reply</b> Client Operation</a><br />
84 <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 <a href=notifyargs.html><img src=box2.gif border=0 alt=>Arguments for <b>notify</b> Client Operation</a><br />
86 <a href=silcclient_unicode.html><img src=box2.gif border=0 alt=>Unicode and UTF-8 Strings in Client Library</a><br />
87 <a href=silcclient.html><img src=box2.gif border=0 alt=>Client Library Interface Reference</a><br />
88 <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 <a href=silcasn1.html><img src=box2.gif border=0 alt=>SILC ASN.1 Interface</a><br />
91 <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 <a href=silchttpserver.html><img src=box2.gif border=0 alt=>SILC HTTP Server Interface</a><br />
94 <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 <a href=silctypes.html><img src=box2.gif border=0 alt=>Basic Types and Definitions</a><br />
97 <a href=silcbuffer.html><img src=box2.gif border=0 alt=>Data Buffer Interface</a><br />
98 <a href=silcbuffmt.html><img src=box2.gif border=0 alt=>Data Buffer Format Interface</a><br />
99 <a href=silchashtable.html><img src=box2.gif border=0 alt=>Hash Table Interface</a><br />
100 <a href=silcmemory.html><img src=box2.gif border=0 alt=>Memory Allocation Interface</a><br />
101 <a href=silcstack.html><img src=box2.gif border=0 alt=>Data Stack (memory pool) Interface</a><br />
102 <a href=silcfsm.html><img src=box2.gif border=0 alt=>Finite State Machine Interface</a><br />
103 <a href=silcthread.html><img src=box2.gif border=0 alt=>Thread Interface</a><br />
104 <a href=silcmutex.html><img src=box2.gif border=0 alt=>Mutual Exclusion Lock Interface</a><br />
105 <a href=silccond.html><img src=box2.gif border=0 alt=>Condition Variable Interface</a><br />
106 <a href=silcatomic.html><img src=box2.gif border=0 alt=>Atomic Operations Interface</a><br />
107 <a href=silcnet.html><img src=box2.gif border=0 alt=>Network (TCP and UDP) Interface</a><br />
108 <a href=silcschedule.html><img src=box2.gif border=0 alt=>Scheduler Interface</a><br />
109 <a href=silcasync.html><img src=box2.gif border=0 alt=>Asynchronous Operation Interface</a><br />
110 <a href=silcstream.html><img src=box2.gif border=0 alt=>Abstract Stream Interface</a><br />
111 <a href=silcsocketstream.html><img src=box2.gif border=0 alt=>Socket Stream Interface</a><br />
112 <a href=silcfdstream.html><img src=box2.gif border=0 alt=>File Descriptor Stream Interface</a><br />
113 <a href=silcfileutil.html><img src=box2.gif border=0 alt=>File Utility Functions</a><br />
114 <a href=silcstrutil.html><img src=box2.gif border=0 alt=>String Utility Interface</a><br />
115 <a href=silcsnprintf.html><img src=box2.gif border=0 alt=>Snprintf Interface</a><br />
116 <a href=silcutf8.html><img src=box2.gif border=0 alt=>UTF-8 String Interface</a><br />
117 <a href=silcstringprep.html><img src=box2.gif border=0 alt=>Stringprep Interface</a><br />
118 <a href=silcutil.html><img src=box2.gif border=0 alt=>Utility Functions</a><br />
119 <a href=silclist.html><img src=box2.gif border=0 alt=>List Interface</a><br />
120 <a href=silcdlist.html><img src=box2.gif border=0 alt=>Dynamic List Interface</a><br />
121 <a href=silcmime.html><img src=box2.gif border=0 alt=>MIME Interface</a><br />
122 <a href=silctime.html><img src=box2.gif border=0 alt=>Time Utility Functions</a><br />
123 <a href=silclog.html><img src=box2.gif border=0 alt=>Logging Interface</a><br />
124 <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 <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 <a href=silcapputil.html><img src=box2.gif border=0 alt=>SILC Application Utilities</a><br />
129 <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 <a href=silcsftp.html><img src=box2.gif border=0 alt=>SILC SFTP Interface</a><br />
132 <a href=silcsftp_fs.html><img src=box2.gif border=0 alt=>SFTP Filesystems Interface</a><br />
135 <b>Resource Links</b>
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 />
143 <br /><br /><br /><br />
148 <td bgcolor="#cccccc" background="dot.gif">
149 <img src="space.gif" width="1" height="1" border="0" alt=""></td>
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">
157 <FONT SIZE="+2" COLOR="#000055"><B>Function <A NAME="silc_stack_push">silc_stack_push</A></FONT></B><BR><BR>
160 <FONT COLOR="#000055">SYNOPSIS
162 <PRE><FONT FACE="courier" size="3">
163 <A HREF="silctypes-SilcUInt32.html">SilcUInt32</A> <B>silc_stack_push</B>(<A HREF="silcstack-SilcStack.html">SilcStack</A> stack, <A HREF="silcstack-SilcStackFrame.html">SilcStackFrame</A> *frame);
165 </FONT></PRE><FONT SIZE="+1"><B>
166 <FONT COLOR="#000055">DESCRIPTION
168 <PRE><FONT FACE="Helvetiva,Arial,Sans-serif">
169 Push the top of the stack down which becomes the new top of the stack.
170 For every <B>silc_stack_push</B> call there must be <A HREF="silcstack-silc_stack_pop.html">silc_stack_pop</A> call. All
171 allocations between these two calls will be done from the top of the
172 stack and all allocated memory is freed after the next <A HREF="silcstack-silc_stack_pop.html">silc_stack_pop</A>
173 is called. This returns so called stack pointer for the new stack
174 frame, which the caller may use to check that all calls to
175 <A HREF="silcstack-silc_stack_pop.html">silc_stack_pop</A> has been made. This call may do a small memory
176 allocation in some cases, but usually it does not allocate any memory.
177 If this returns zero (0) the system is out of memory.
179 If the `frame' is non-NULL then that <A HREF="silcstack-SilcStackFrame.html">SilcStackFrame</A> is used as
180 stack frame. Usually `frame' is set to NULL by user. Statically
181 allocated <A HREF="silcstack-SilcStackFrame.html">SilcStackFrame</A> should be used when using <B>silc_stack_push</B>
182 in recursive function and the recursion may become deep. In this
183 case using statically allocated <A HREF="silcstack-SilcStackFrame.html">SilcStackFrame</A> is recommended since
184 it assures that frames never run out and <B>silc_stack_push</B> never
185 allocates any memory. If your routine is not recursive then
186 setting `frame' to NULL is recommended, unless performance is
189 This function is used when a routine is doing frequent allocations
190 from the stack. If the stack is not pushed and later popped all
191 allocations are made from the stack and the stack eventually runs out
192 (it gets enlarged by normal memory allocation). By pushing and then
193 later popping the frequent allocations does not consume the stack.
195 If `stack' is NULL this call has no effect.
197 </FONT></PRE><FONT SIZE="+1"><B>
198 <FONT COLOR="#000055">EXAMPLE
200 <PRE><FONT FACE="courier" size="3">
201 All memory allocations in silc_foo_parse_packet will be done in
202 a fresh stack frame and that data is freed after the parsing is
205 <B>silc_stack_push</B>(stack, NULL);
206 silc_foo_parse_packet(packet, stack);
207 <A HREF="silcstack-silc_stack_pop.html">silc_stack_pop</A>(stack);
209 Another example with recursion and using statically allocated
210 <A HREF="silcstack-SilcStackFrame.html">SilcStackFrame</A>. After popping the statically allocated frame can
211 be reused if necessary.
213 void silc_foo_this_function(<A HREF="silcstack-SilcStack.html">SilcStack</A> stack)
215 <A HREF="silcstack-SilcStackFrame.html">SilcStackFrame</A> frame;
217 <B>silc_stack_push</B>(stack, &frame);
218 silc_foo_this_function(stack); // Call recursively
219 <A HREF="silcstack-silc_stack_pop.html">silc_stack_pop</A>(stack);
224 <br /><br /><br /><br />
229 <td bgcolor="#cccccc" background="dot.gif">
230 <img src="space.gif" width="1" height="1" border="0" alt=""></td>
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>
237 <font face="Helvetica,Arial,Sans-serif" size="1">
238 <A HREF="silcstack.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcStack Interface</A><BR>
239 <A HREF="silcstack-SilcStack.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcStack</A><BR>
240 <A HREF="silcstack-SilcStackFrame.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcStackFrame</A><BR>
241 <A HREF="silcstack-silc_stack_alloc.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_stack_alloc</A><BR>
242 <A HREF="silcstack-silc_stack_free.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_stack_free</A><BR>
243 <A HREF="silcstack-silc_stack_push.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_stack_push</A><BR>
244 <A HREF="silcstack-silc_stack_pop.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_stack_pop</A><BR>
247 <br /><br /><br /><br />
254 <table border="0" cellspacing="0" cellpadding="0" width="100%">
255 <tr bgcolor="#444444"><td><img src="space.gif" width="1" height="1"border="0" alt="" ></td></tr>
257 <table border="0" cellspacing="0" cellpadding="6" width="100%">
258 <tr valign="top" bgcolor="#dddddd">
259 <td><small>Copyright © 2001 - 2007 SILC Project<br />
260 <a href="http://silcnet.org">SILC Project Website</a></small></td>
261 <td align="right"><small>
262 <a href="index.html">SILC Toolkit Reference Manual</a><br />
263 <a href="toolkit_index.html">Index</a></small></td>