X-Git-Url: http://git.silcnet.org/gitweb/?p=silc.git;a=blobdiff_plain;f=lib%2Fdoc%2Fnotifyargs.html;h=3c9061162a7ed62398c49d11a498994930366da7;hp=ebe124acf2458f8e2a8b1dc377f5cc710d462c88;hb=413da0f8686910f5e627393157566ae729ca99c4;hpb=050bd9d9e5d843220f3f393a18ab5011622237b9 diff --git a/lib/doc/notifyargs.html b/lib/doc/notifyargs.html index ebe124ac..3c906116 100644 --- a/lib/doc/notifyargs.html +++ b/lib/doc/notifyargs.html @@ -23,12 +23,12 @@ SilcNotifyType type, ...);
 
-The first argument 'client' is the SILC Client Library context, the `conn' -is the context for the connection to the remote server, and the `type' is -the notify type enumeration sent by the server. Rest of the arguments are -`type' specific and implementation should handle them by the -SilcNotifyType for example in a switch statement. The notify -types are defined in lib/silccore/silcnotify.h header file. A short +The first argument 'client' is the SILC Client Library context, the `conn' +is the context for the connection to the remote server, and the `type' is +the notify type enumeration sent by the server. Rest of the arguments are +`type' specific and implementation should handle them by the +SilcNotifyType for example in a switch statement. The notify +types are defined in lib/silccore/silcnotify.h header file. A short example:
 
@@ -52,12 +52,12 @@ example: Arguments
 
-The following table describes all notify types and arguments that the -client library sends in the 'notify' client operation to the application. -By default all arguments that the library sends to application are valid -pointers. However, it is possible that some pointers may be NULL. If -this is the case it is separately mentioned that the argument may be NULL. -In this case application must ignore that argument. The SilcNotifyType +The following table describes all notify types and arguments that the +client library sends in the 'notify' client operation to the application. +By default all arguments that the library sends to application are valid +pointers. However, it is possible that some pointers may be NULL. If +this is the case it is separately mentioned that the argument may be NULL. +In this case application must ignore that argument. The SilcNotifyType arguments per notify type is as follows:
 
@@ -82,7 +82,7 @@ The 'message' argument may be NULL. SILC_NOTIFY_TYPE_INVITE -Sent to the client if the user is invited on a channel. The 'channel_name' +Sent to the client if the user is invited on a channel. The 'channel_name' argument may be NULL. SilcClientChannel channel, char *channel_name, @@ -111,9 +111,9 @@ Sent when someone leaves (parts) the channel. 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 +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 @@ -124,8 +124,8 @@ display for example nickname information. 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 +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, @@ -136,10 +136,11 @@ char *topic, SilcChannelEntry channel 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. +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. Note that this notify is not +delivered when user changes its own nickname. SilcClientEntry old_client_entry, SilcClientEntry new_client_entry @@ -150,13 +151,20 @@ SilcClientEntry new_client_entry 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. +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 `cipher_name' is the cipher set for the channel. +The `hmac_name' is the HMAC set for the channel. The `passphrase' +is the passphrase that was set for the channel. The `founder_key' is the +founder's public key when it was set for the channel. The `channel_pubkeys' +is an Argument List Payload where each argument is Public Key Payload +containing one channel public key. The arguments 'cipher_name', 'hmac_name', +'passphrase', 'founder_key' and 'channel_pubkeys' may be NULL. SilcIdType changer_id_type, void *changer_entry, -SilcUInt32 mode, NULL, char *hmac_name, SilcChannelEntry channel +SilcUInt32 mode, char *cipher_name, char *hmac_name, char *passphrase, +SilcPublicKey founder_key, SilcBuffer channel_pubkeys, SilcChannelEntry channel @@ -164,8 +172,8 @@ SilcUInt32 mode, NULL, char *hmac_name, SilcChannelEntry channel 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 +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. @@ -186,9 +194,9 @@ Message of the Day from the server. 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 +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 @@ -198,8 +206,8 @@ safely ignore it when received. 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 +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 @@ -209,8 +217,8 @@ entry is one client signing off from the SILC network. 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 +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, @@ -221,10 +229,10 @@ SilcClientEntry kicker, SilcChannelEntry channel 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 +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, @@ -236,7 +244,7 @@ SilcIdType killer_type, void *killer, SilcChannelEntry channel 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 +from the client. Application usually cannot handle this notify type and may safely ignore it. SilcStatus error @@ -246,13 +254,13 @@ may safely ignore it. 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 -client just changed nickname the 'new_nickname' includes the new nickname. -Otherwise this pointer is NULL. The 'user_mode' is the client's mode in -the SILC network. The 'notification' contains the notify type that -happened for the 'watched_client' (for example +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 +client just changed nickname the 'new_nickname' includes the new nickname. +Otherwise this pointer is NULL. The 'user_mode' is the client's mode in +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, @@ -263,7 +271,7 @@ SilcUInt32 user_mode, SilcNotifyType notification
 
-SILC protocol defines some additional notify types but those notify types -are not delivered to the application. Some of those notify types are only -delivered between servers and routers and clients never receive them. +SILC protocol defines some additional notify types but those notify types +are not delivered to the application. Some of those notify types are only +delivered between servers and routers and clients never receive them. Only the notify types listed above are delivered to application.