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_packet_wait">silc_packet_wait</A></FONT></B><BR><BR>
160 <FONT COLOR="#000055">SYNOPSIS
162 <PRE><FONT FACE="courier" size="3">
163 int <B>silc_packet_wait</B>(void *waiter, int timeout,
164 <A HREF="silcpacket-SilcPacket.html">SilcPacket</A> *return_packet)
166 </FONT></PRE><FONT SIZE="+1"><B>
167 <FONT COLOR="#000055">DESCRIPTION
169 <PRE><FONT FACE="Helvetiva,Arial,Sans-serif">
170 A special function that can be used to wait for a packet to arrive.
171 This function will block the calling process or thread until either
172 a packet is received into the `return_packet' pointer or the specified
173 timeout value `timeout', which is in milliseconds, will expire. If
174 the timeout is 0, no timeout exist. Before calling this function the
175 <A HREF="silcpacket-silc_packet_wait_init.html">silc_packet_wait_init</A> must be called. The caller is responsible for
176 freeing the returned packet with <A HREF="silcpacket-silc_packet_free.html">silc_packet_free</A>.
178 This function can be used for example from a thread that wants to
179 block until SILC packet has been received.
181 Returns 1 when packet was received, 0 if timeout occurred and -1 if
184 </FONT></PRE><FONT SIZE="+1"><B>
185 <FONT COLOR="#000055">EXAMPLE
187 <PRE><FONT FACE="courier" size="3">
188 static int foo_read_data(FooContext c)
190 <A HREF="silcpacket-SilcPacket.html">SilcPacket</A> packet;
194 // Will wait for private message packets
195 if (c->initialized == <A HREF="silctypes-FALSE.html">FALSE</A>) {
196 waiter = <A HREF="silcpacket-silc_packet_wait_init.html">silc_packet_wait_init</A>(stream,
197 SILC_PACKET_PRIVATE_MESSAGE, -1);
198 c->initialized = <A HREF="silctypes-TRUE.html">TRUE</A>;
202 // Wait here until private message packet is received
203 if ((<B>silc_packet_wait</B>(waiter, 0, &packet)) < 0)
206 ... process packet ...
212 <br /><br /><br /><br />
217 <td bgcolor="#cccccc" background="dot.gif">
218 <img src="space.gif" width="1" height="1" border="0" alt=""></td>
220 <td width="180" bgcolor="#f0f0f0">
221 <img src="space.gif" width="1" height="1" border="0" alt="">
222 <table width="100%" cellpadding="4" cellspacing="0">
223 <tr valign="top"><td>
225 <font face="Helvetica,Arial,Sans-serif" size="1">
226 <A HREF="silcpacket.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SILC Packet Engine Interface</A><BR>
227 <A HREF="silcpacket-SilcPacketType.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcPacketType</A><BR>
228 <A HREF="silcpacket-SilcPacketFlags.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcPacketFlags</A><BR>
229 <A HREF="silcpacket-SilcPacketEngine.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcPacketEngine</A><BR>
230 <A HREF="silcpacket-SilcPacketStream.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcPacketStream</A><BR>
231 <A HREF="silcpacket-SilcPacket.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcPacket</A><BR>
232 <A HREF="silcpacket-SilcPacketError.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcPacketError</A><BR>
233 <A HREF="silcpacket-SilcPacketReceiveCb.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcPacketReceiveCb</A><BR>
234 <A HREF="silcpacket-SilcPacketEosCb.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcPacketEosCb</A><BR>
235 <A HREF="silcpacket-SilcPacketErrorCb.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcPacketErrorCb</A><BR>
236 <A HREF="silcpacket-SilcPacketCallbacks.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcPacketCallbacks</A><BR>
237 <A HREF="silcpacket-silc_packet_engine_start.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_engine_start</A><BR>
238 <A HREF="silcpacket-silc_packet_engine_stop.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_engine_stop</A><BR>
239 <A HREF="silcpacket-silc_packet_error_string.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_error_string</A><BR>
240 <A HREF="silcpacket-silc_packet_engine_get_streams.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_engine_get_streams</A><BR>
241 <A HREF="silcpacket-silc_packet_engine_free_streams_list.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_engine_free_streams_list</A><BR>
242 <A HREF="silcpacket-silc_packet_stream_create.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_stream_create</A><BR>
243 <A HREF="silcpacket-silc_packet_stream_add_remote.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_stream_add_remote</A><BR>
244 <A HREF="silcpacket-silc_packet_stream_inject.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_stream_inject</A><BR>
245 <A HREF="silcpacket-silc_packet_stream_destroy.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_stream_destroy</A><BR>
246 <A HREF="silcpacket-silc_packet_stream_is_valid.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_stream_is_valid</A><BR>
247 <A HREF="silcpacket-silc_packet_stream_set_router.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_stream_set_router</A><BR>
248 <A HREF="silcpacket-silc_packet_stream_set_iv_included.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_stream_set_iv_included</A><BR>
249 <A HREF="silcpacket-silc_packet_stream_set_stream.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_stream_set_stream</A><BR>
250 <A HREF="silcpacket-silc_packet_stream_get_stream.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_stream_get_stream</A><BR>
251 <A HREF="silcpacket-silc_packet_stream_link.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_stream_link</A><BR>
252 <A HREF="silcpacket-silc_packet_stream_unlink.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_stream_unlink</A><BR>
253 <A HREF="silcpacket-SilcPacketWrapCoder.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">SilcPacketWrapCoder</A><BR>
254 <A HREF="silcpacket-silc_packet_stream_wrap.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_stream_wrap</A><BR>
255 <A HREF="silcpacket-silc_packet_stream_is_udp.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_stream_is_udp</A><BR>
256 <A HREF="silcpacket-silc_packet_get_sender.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_get_sender</A><BR>
257 <A HREF="silcpacket-silc_packet_stream_ref.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_stream_ref</A><BR>
258 <A HREF="silcpacket-silc_packet_stream_unref.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_stream_unref</A><BR>
259 <A HREF="silcpacket-silc_packet_get_engine.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_get_engine</A><BR>
260 <A HREF="silcpacket-silc_packet_set_context.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_set_context</A><BR>
261 <A HREF="silcpacket-silc_packet_get_context.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_get_context</A><BR>
262 <A HREF="silcpacket-silc_packet_set_keys.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_set_keys</A><BR>
263 <A HREF="silcpacket-silc_packet_get_keys.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_get_keys</A><BR>
264 <A HREF="silcpacket-silc_packet_set_ids.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_set_ids</A><BR>
265 <A HREF="silcpacket-silc_packet_get_ids.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_get_ids</A><BR>
266 <A HREF="silcpacket-silc_packet_set_sid.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_set_sid</A><BR>
267 <A HREF="silcpacket-silc_packet_send.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_send</A><BR>
268 <A HREF="silcpacket-silc_packet_send_ext.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_send_ext</A><BR>
269 <A HREF="silcpacket-silc_packet_send_va.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_send_va</A><BR>
270 <A HREF="silcpacket-silc_packet_send_va_ext.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_send_va_ext</A><BR>
271 <A HREF="silcpacket-silc_packet_wait_init.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_wait_init</A><BR>
272 <A HREF="silcpacket-silc_packet_wait_uninit.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_wait_uninit</A><BR>
273 <A HREF="silcpacket-silc_packet_wait.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_wait</A><BR>
274 <A HREF="silcpacket-silc_packet_free.html"><IMG SRC="index_pic.gif" BORDER="0" ALT="">silc_packet_free</A><BR>
277 <br /><br /><br /><br />
284 <table border="0" cellspacing="0" cellpadding="0" width="100%">
285 <tr bgcolor="#444444"><td><img src="space.gif" width="1" height="1"border="0" alt="" ></td></tr>
287 <table border="0" cellspacing="0" cellpadding="6" width="100%">
288 <tr valign="top" bgcolor="#dddddd">
289 <td><small>Copyright © 2001 - 2007 SILC Project<br />
290 <a href="http://silcnet.org">SILC Project Website</a></small></td>
291 <td align="right"><small>
292 <a href="index.html">SILC Toolkit Reference Manual</a><br />
293 <a href="toolkit_index.html">Index</a></small></td>