updates.
authorPekka Riikonen <priikone@silcnet.org>
Wed, 15 Jan 2003 16:23:49 +0000 (16:23 +0000)
committerPekka Riikonen <priikone@silcnet.org>
Wed, 15 Jan 2003 16:23:49 +0000 (16:23 +0000)
lib/doc/notifyargs.html
lib/silcclient/DIRECTORY

index b36384851acb032f40377d5f9c541bcd8b81faf9..afb89a3ec10f1b90d81be9788955ae28e2e57bfb 100644 (file)
@@ -2,10 +2,11 @@
 
 <br />&nbsp;<br />
 The SILC Client Library 'notify' client operation (which is part of the
-SilcClientOperation callback functions) returns different kind of
+<a href="silcclient-SilcClientOperations.html">
+SilcClientOperation</a> callback functions) returns different kind of
 notifications from the SILC server to the SILC client.  The 'notify'
 client operation implementation has a variable argument list to deliver
-SilcNotifyType type specific arguments to the application.  This document
+<a href="silcnotify-SilcNotifyType.html">SilcNotifyType</a> type specific arguments to the application.  This document
 describes these arguments for all notify types to help SILC client
 software developers to handle the incoming notifications.
 
@@ -60,191 +61,191 @@ In this case application must ignore that argument.  The SilcNotifyType
 arguments per notify type is as follows:
 
 <br />&nbsp;<br />
-<table border="1" width="100%" cellpadding="5">
+<table border="1" width="100%" cellpadding="3" cellspacing="0">
 
 <tr>
-<td>Name</td>
-<td>Description</td>
-<td width="50%">Variable Arguments</td>
+<td><small>Name</td>
+<td><small>Description</td>
+<td width="50%"><small>Variable Arguments</td>
 </tr>
 
 <tr>
-<td>SILC_NOTIFY_TYPE_NONE</td>
-<td>
+<td><small>SILC_NOTIFY_TYPE_NONE</td>
+<td><small>
 A message from server that usually does not include any critical
 information.  Application may ignore this or display it for the user.
 The 'message' argument may be NULL.
 </td>
-<td width="50%">char *message</td>
+<td width="50%"><small>char *message</td>
 </tr>
 
 <tr>
-<td>SILC_NOTIFY_TYPE_INVITE</td>
-<td>
+<td><small>SILC_NOTIFY_TYPE_INVITE</td>
+<td><small>
 Sent to the client if the user is invited on a channel. The 'channel_name' 
 argument may be NULL.
 </td>
-<td width="50%">SilcClientChannel channel, char *channel_name,
+<td width="50%"><small>SilcClientChannel channel, char *channel_name,
 SilcClientEntry inviter
 </td>
 </tr>
 
 <tr>
-<td>SILC_NOTIFY_TYPE_JOIN</td>
-<td>
+<td><small>SILC_NOTIFY_TYPE_JOIN</td>
+<td><small>
 Sent when someone joins to a channel.
 </td>
-<td width="50%">SilcClientEntry joining_client, SilcChannelEntry channel
+<td width="50%"><small>SilcClientEntry joining_client, SilcChannelEntry channel
 </td>
 </tr>
 
 <tr>
-<td>SILC_NOTIFY_TYPE_LEAVE</td>
-<td>
+<td><small>SILC_NOTIFY_TYPE_LEAVE</td>
+<td><small>
 Sent when someone leaves (parts) the channel.
 </td>
-<td width="50%">SilcClientEntry leaving_client, SilcChannelEntry channel
+<td width="50%"><small>SilcClientEntry leaving_client, SilcChannelEntry channel
 </td>
 </tr>
 
 <tr>
-<td>SILC_NOTIFY_TYPE_SIGNOFF</td>
-<td>
+<td><small>SILC_NOTIFY_TYPE_SIGNOFF</td>
+<td><small>
 Sent when someone signoff the SILC network.  The 'signoff_message' may be 
 NULL.  The 'leaving_client' SilcClientEntry may be incomplete and contain 
 NULL pointers, application must check it's pointers before attempting to 
 display for example nickname information.
 </td>
-<td width="50%">SilcClientEntry signoff_client, char *signoff_message
+<td width="50%"><small>SilcClientEntry signoff_client, char *signoff_message
 </td>
 </tr>
 
 <tr>
-<td>SILC_NOTIFY_TYPE_TOPIC_SET</td>
-<td>
+<td><small>SILC_NOTIFY_TYPE_TOPIC_SET</td>
+<td><small>
 Sent when the topic of a channel is set/changed.  The 'setter_id_type'
 is used to check what type of pointer the 'setter_entry' is.  For 
 SILC_ID_CLIENT SilcClientEntry, for SILC_ID_SERVER SilcServerEntry and for 
 SILC_ID_CHANNEL SilcChannelEntry.
 </td>
-<td width="50%">SilcIdType setter_id_type, void *setter_entry,
+<td width="50%"><small>SilcIdType setter_id_type, void *setter_entry,
 char *topic, SilcChannelEntry channel
 </td>
 </tr>
 
 <tr>
-<td>SILC_NOTIFY_TYPE_NICK_CHANGE</td>
-<td>
+<td><small>SILC_NOTIFY_TYPE_NICK_CHANGE</td>
+<td><small>
 Sent when someone changes their nickname.  The 'old_client_entry' includes 
 the old nickname and the 'new_client_entry' includes the new nickname.  
 Application must understand that the 'old_client_entry' pointer becomes 
 invalid after returning from the function.
 </td>
-<td width="50%">SilcClientEntry old_client_entry,
+<td width="50%"><small>SilcClientEntry old_client_entry,
 SilcClientEntry new_client_entry
 </td>
 </tr>
 
 <tr>
-<td>SILC_NOTIFY_TYPE_CMODE_CHANGE</td>
-<td>
+<td><small>SILC_NOTIFY_TYPE_CMODE_CHANGE</td>
+<td><small>
 Sent when channel's mode has changed. The 'changer_id_type'
 is used to check what type of pointer the 'changer_entry' is.  For 
 SILC_ID_CLIENT SilcClientEntry, for SILC_ID_SERVER SilcServerEntry and for 
 SILC_ID_CHANNEL SilcChannelEntry.  The 'mode' is the mode mask after the 
 change.  The 'hmac_name' argument may be NULL.
 </td>
-<td width="50%">SilcIdType changer_id_type, void *changer_entry,
+<td width="50%"><small>SilcIdType changer_id_type, void *changer_entry,
 SilcUInt32 mode, NULL, char *hmac_name, SilcChannelEntry channel
 </td>
 </tr>
 
 <tr>
-<td>SILC_NOTIFY_TYPE_CUMODE_CHANGE</td>
-<td>
+<td><small>SILC_NOTIFY_TYPE_CUMODE_CHANGE</td>
+<td><small>
 Sent when a users mode on a channel has changed. The 'changer_id_type'
 is used to check what type of pointer the 'changer_entry' is.  For 
 SILC_ID_CLIENT SilcClientEntry, for SILC_ID_SERVER SilcServerEntry and for 
 SILC_ID_CHANNEL SilcChannelEntry.  The 'mode' is the mode mask after the
 change.  The 'target_client' is the client whose mode was changed.
 </td>
-<td width="50%">SilcIdType changer_id_type, void *changer_entry,
+<td width="50%"><small>SilcIdType changer_id_type, void *changer_entry,
 SilcUInt32 mode, SilcClientEntry target_client, SilcChannelEntry channel
 </td>
 </tr>
 
 <tr>
-<td>SILC_NOTIFY_TYPE_MOTD</td>
-<td>
+<td><small>SILC_NOTIFY_TYPE_MOTD</td>
+<td><small>
 Message of the Day from the server.
 </td>
-<td width="50%">char *motd
+<td width="50%"><small>char *motd
 </td>
 </tr>
 
 <tr>
-<td>SILC_NOTIFY_TYPE_CHANNEL_CHANGE</td>
-<td>
+<td><small>SILC_NOTIFY_TYPE_CHANNEL_CHANGE</td>
+<td><small>
 Sent when a channel's Channel ID changes.  It is possible that channel's 
 ID changes and this notify is sent by the server when this happens.  
 Usually application does not need to handle this notify type and may 
 safely ignore it when received.
 </td>
-<td width="50%">SilcChannelEntry channel
+<td width="50%"><small>SilcChannelEntry channel
 </td>
 </tr>
 
 <tr>
-<td>SILC_NOTIFY_TYPE_SERVER_SIGNOFF</td>
-<td>
+<td><small>SILC_NOTIFY_TYPE_SERVER_SIGNOFF</td>
+<td><small>
 Sent when a server quits the network.  The 'clients' is an array 
 SilcClientEntry pointers of size of 'clients_count'.  Each client in the 
 entry is one client signing off from the SILC network.
 </td>
-<td width="50%">NULL, SilcClientEntry *clients, SilcUInt32 clients_count
+<td width="50%"><small>NULL, SilcClientEntry *clients, SilcUInt32 clients_count
 </td>
 </tr>
 
 <tr>
-<td>SILC_NOTIFY_TYPE_KICKED</td>
-<td>
+<td><small>SILC_NOTIFY_TYPE_KICKED</td>
+<td><small>
 Sent when a client (possibly our client) is kicked from a channel.  The 
 'kick_message' may be NULL.  If our client was kicked then 'kicked' is our 
 local SilcClientEntry pointer.
 </td>
-<td width="50%">SilcClientEntry kicked, char *kick_message,
+<td width="50%"><small>SilcClientEntry kicked, char *kick_message,
 SilcClientEntry kicker, SilcChannelEntry channel
 </td>
 </tr>
 
 <tr>
-<td>SILC_NOTIFY_TYPE_KILLED</td>
-<td>
+<td><small>SILC_NOTIFY_TYPE_KILLED</td>
+<td><small>
 Sent when a client (possibly our client) is killed from the network.  The 
 'kill_message' may be NULL.  If our client was killed then 'killed' is our 
 local SilcClientEntry pointer.  The 'killer_type' is used to check what 
 type of pointer the 'killer' is.  For SILC_ID_CLIENT SilcClientEntry, for 
 SILC_ID_SERVER SilcServerEntry and for SILC_ID_CHANNEL SilcChannelEntry.
 </td>
-<td width="50%">SilcClientEntry killed, char *kill_message,
+<td width="50%"><small>SilcClientEntry killed, char *kill_message,
 SilcIdType killer_type, void *killer, SilcChannelEntry channel
 </td>
 </tr>
 
 <tr>
-<td>SILC_NOTIFY_TYPE_ERROR</td>
-<td>
+<td><small>SILC_NOTIFY_TYPE_ERROR</td>
+<td><small>
 Sent when an error occurs while handling some operation (except command)
 from the client.  Application usually cannot handle this notify type and 
 may safely ignore it.
 </td>
-<td width="50%">SilcStatus error
+<td width="50%"><small>SilcStatus error
 </td>
 </tr>
 
 <tr>
-<td>SILC_NOTIFY_TYPE_WATCH</td>
-<td>
+<td><small>SILC_NOTIFY_TYPE_WATCH</td>
+<td><small>
 Sent to notify some status change of a client we are wathing.  The 
 SILC_COMMAND_WATCH is used to manage clients we are wathing and this 
 notify type is used to deliver information about that client.  If the 
@@ -254,7 +255,7 @@ the SILC network.  The 'notification' contains the notify type that
 happened for the 'watched_client' (for example 
 SILC_NOTIFY_TYPE_NICK_CHANGE if the client changed their nickname).
 </td>
-<td width="50%">SilcClientEntry watched_client, char *new_nickname,
+<td width="50%"><small>SilcClientEntry watched_client, char *new_nickname,
 SilcUInt32 user_mode, SilcNotifyType notification
 </td>
 </tr>
index 631fee27f5aa5455175e55b14ab4eb596b1ed905..f4626167351542e3eabd0af72a2698f04caadba5 100644 (file)
@@ -2,7 +2,7 @@
 @LIBRARY=SILC Client Library
 @FILENAME=silcclientlib.html
 @LINK=silcclient_using.html:Using SILC Client Library
-@LINK=silcclient_using.html:notify Client Operation Arguments
+@LINK=notifyargs.html:Arguments for notify Client Operation
 @LINK=silcclient.html:Client Library Interface
 -->