From: Pekka Riikonen Date: Wed, 15 Jan 2003 16:23:49 +0000 (+0000) Subject: updates. X-Git-Tag: silc.client.0.9.11.1~7 X-Git-Url: http://git.silcnet.org/gitweb/?p=silc.git;a=commitdiff_plain;h=7a12ee8363913e5283902611809d31aacbfefbd0 updates. --- diff --git a/lib/doc/notifyargs.html b/lib/doc/notifyargs.html index b3638485..afb89a3e 100644 --- a/lib/doc/notifyargs.html +++ b/lib/doc/notifyargs.html @@ -2,10 +2,11 @@
 
The SILC Client Library 'notify' client operation (which is part of the -SilcClientOperation callback functions) returns different kind of + +SilcClientOperation 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 +SilcNotifyType 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:
 
- +
- - - + + + - - + - + - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - diff --git a/lib/silcclient/DIRECTORY b/lib/silcclient/DIRECTORY index 631fee27..f4626167 100644 --- a/lib/silcclient/DIRECTORY +++ b/lib/silcclient/DIRECTORY @@ -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 -->
NameDescriptionVariable ArgumentsNameDescriptionVariable Arguments
SILC_NOTIFY_TYPE_NONE +SILC_NOTIFY_TYPE_NONE 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. char *messagechar *message
SILC_NOTIFY_TYPE_INVITE +SILC_NOTIFY_TYPE_INVITE Sent to the client if the user is invited on a channel. The 'channel_name' argument may be NULL. SilcClientChannel channel, char *channel_name, +SilcClientChannel channel, char *channel_name, SilcClientEntry inviter
SILC_NOTIFY_TYPE_JOIN +SILC_NOTIFY_TYPE_JOIN Sent when someone joins to a channel. SilcClientEntry joining_client, SilcChannelEntry channel +SilcClientEntry joining_client, SilcChannelEntry channel
SILC_NOTIFY_TYPE_LEAVE +SILC_NOTIFY_TYPE_LEAVE Sent when someone leaves (parts) the channel. SilcClientEntry leaving_client, SilcChannelEntry channel +SilcClientEntry leaving_client, SilcChannelEntry channel
SILC_NOTIFY_TYPE_SIGNOFF +SILC_NOTIFY_TYPE_SIGNOFF 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. SilcClientEntry signoff_client, char *signoff_message +SilcClientEntry signoff_client, char *signoff_message
SILC_NOTIFY_TYPE_TOPIC_SET +SILC_NOTIFY_TYPE_TOPIC_SET 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. SilcIdType setter_id_type, void *setter_entry, +SilcIdType setter_id_type, void *setter_entry, char *topic, SilcChannelEntry channel
SILC_NOTIFY_TYPE_NICK_CHANGE +SILC_NOTIFY_TYPE_NICK_CHANGE 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. SilcClientEntry old_client_entry, +SilcClientEntry old_client_entry, SilcClientEntry new_client_entry
SILC_NOTIFY_TYPE_CMODE_CHANGE +SILC_NOTIFY_TYPE_CMODE_CHANGE 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. SilcIdType changer_id_type, void *changer_entry, +SilcIdType changer_id_type, void *changer_entry, SilcUInt32 mode, NULL, char *hmac_name, SilcChannelEntry channel
SILC_NOTIFY_TYPE_CUMODE_CHANGE +SILC_NOTIFY_TYPE_CUMODE_CHANGE 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. SilcIdType changer_id_type, void *changer_entry, +SilcIdType changer_id_type, void *changer_entry, SilcUInt32 mode, SilcClientEntry target_client, SilcChannelEntry channel
SILC_NOTIFY_TYPE_MOTD +SILC_NOTIFY_TYPE_MOTD Message of the Day from the server. char *motd +char *motd
SILC_NOTIFY_TYPE_CHANNEL_CHANGE +SILC_NOTIFY_TYPE_CHANNEL_CHANGE 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. SilcChannelEntry channel +SilcChannelEntry channel
SILC_NOTIFY_TYPE_SERVER_SIGNOFF +SILC_NOTIFY_TYPE_SERVER_SIGNOFF 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. NULL, SilcClientEntry *clients, SilcUInt32 clients_count +NULL, SilcClientEntry *clients, SilcUInt32 clients_count
SILC_NOTIFY_TYPE_KICKED +SILC_NOTIFY_TYPE_KICKED 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. SilcClientEntry kicked, char *kick_message, +SilcClientEntry kicked, char *kick_message, SilcClientEntry kicker, SilcChannelEntry channel
SILC_NOTIFY_TYPE_KILLED +SILC_NOTIFY_TYPE_KILLED 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. SilcClientEntry killed, char *kill_message, +SilcClientEntry killed, char *kill_message, SilcIdType killer_type, void *killer, SilcChannelEntry channel
SILC_NOTIFY_TYPE_ERROR +SILC_NOTIFY_TYPE_ERROR 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. SilcStatus error +SilcStatus error
SILC_NOTIFY_TYPE_WATCH +SILC_NOTIFY_TYPE_WATCH 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). SilcClientEntry watched_client, char *new_nickname, +SilcClientEntry watched_client, char *new_nickname, SilcUInt32 user_mode, SilcNotifyType notification