1 /* Predefined stub functions for the SilcClientOperation callbacks.
2 You can freely use this template in your application. These are
3 the functions that you as an application programmer need to implement
4 for the library. The library may call these functions at any time.
6 At the end of this file SilcClientOperation structure is defined, and
7 it is the one the you will give as an argument to the silc_client_alloc
8 function. See also lib/silcclient/README file, and silcapi.h. */
11 /* Message sent to the application by library. `conn' associates the
12 message to a specific connection. `conn', however, may be NULL.
13 The `type' indicates the type of the message sent by the library.
14 The applicationi can for example filter the message according the
18 silc_say(SilcClient client, SilcClientConnection conn,
19 SilcClientMessageType type, char *msg, ...)
25 /* Message for a channel. The `sender' is the sender of the message
26 The `channel' is the channel. */
29 silc_channel_message(SilcClient client, SilcClientConnection conn,
30 SilcClientEntry sender, SilcChannelEntry channel,
31 SilcMessageFlags flags, char *msg)
37 /* Private message to the client. The `sender' is the sender of the
41 silc_private_message(SilcClient client, SilcClientConnection conn,
42 SilcClientEntry sender, SilcMessageFlags flags, char *msg)
48 /* Notify message to the client. The notify arguments are sent in the
49 same order as servers sends them. The arguments are same as received
50 from the server except for ID's. If ID is received application receives
51 the corresponding entry to the ID. For example, if Client ID is received
52 application receives SilcClientEntry. Also, if the notify type is
53 for channel the channel entry is sent to application (even if server
54 does not send it because client library gets the channel entry from
55 the Channel ID in the packet's header). */
58 silc_notify(SilcClient client, SilcClientConnection conn,
59 SilcNotifyType type, ...)
65 /* Command handler. This function is called always in the command function.
66 If error occurs it will be called as well. `conn' is the associated
67 client connection. `cmd_context' is the command context that was
68 originally sent to the command. `success' is FALSE if error occurred
69 during command. `command' is the command being processed. It must be
70 noted that this is not reply from server. This is merely called just
71 after application has called the command. Just to tell application
72 that the command really was processed. */
75 silc_command(SilcClient client, SilcClientConnection conn,
76 SilcClientCommandContext cmd_context, int success,
83 /* Command reply handler. This function is called always in the command reply
84 function. If error occurs it will be called as well. Normal scenario
85 is that it will be called after the received command data has been parsed
86 and processed. The function is used to pass the received command data to
89 `conn' is the associated client connection. `cmd_payload' is the command
90 payload data received from server and it can be ignored. It is provided
91 if the application would like to re-parse the received command data,
92 however, it must be noted that the data is parsed already by the library
93 thus the payload can be ignored. `success' is FALSE if error occurred.
94 In this case arguments are not sent to the application. The `status' is
95 the command reply status server returned. The `command' is the command
96 reply being processed. The function has variable argument list and each
97 command defines the number and type of arguments it passes to the
98 application (on error they are not sent). */
101 silc_command_reply(SilcClient client, SilcClientConnection conn,
102 SilcCommandPayload cmd_payload, int success,
103 SilcCommand command, SilcCommandStatus status, ...)
109 /* Called to indicate that connection was either successfully established
110 or connecting failed. This is also the first time application receives
111 the SilcClientConnection objecet which it should save somewhere.
112 If the `success' is FALSE the application must always call the function
113 silc_client_close_connection. */
116 silc_connect(SilcClient client, SilcClientConnection conn, int success)
122 /* Called to indicate that connection was disconnected to the server. */
125 silc_disconnect(SilcClient client, SilcClientConnection conn)
131 /* Find authentication method and authentication data by hostname and
132 port. The hostname may be IP address as well. When the authentication
133 method has been resolved the `completion' callback with the found
134 authentication method and authentication data is called. The `conn'
138 silc_get_auth_method(SilcClient client, SilcClientConnection conn,
139 char *hostname, uint16 port, SilcGetAuthMeth completion,
146 /* Verifies received public key. The `conn_type' indicates which entity
147 (server, client etc.) has sent the public key. If user decides to trust
148 the key may be saved as trusted public key for later use. The
149 `completion' must be called after the public key has been verified. */
152 silc_verify_public_key(SilcClient client, SilcClientConnection conn,
153 SilcSocketType conn_type, unsigned char *pk,
154 uint32 pk_len, SilcSKEPKType pk_type,
155 SilcVerifyPublicKey completion, void *context)
161 /* Ask (interact, that is) a passphrase from user. The passphrase is
162 returned to the library by calling the `completion' callback with
166 silc_ask_passphrase(SilcClient client, SilcClientConnection conn,
167 SilcAskPassphrase completion, void *context)
173 /* Notifies application that failure packet was received. This is called
174 if there is some protocol active in the client. The `protocol' is the
175 protocol context. The `failure' is opaque pointer to the failure
176 indication. Note, that the `failure' is protocol dependant and
177 application must explicitly cast it to correct type. Usually `failure'
178 is 32 bit failure type (see protocol specs for all protocol failure
182 silc_failure(SilcClient client, SilcClientConnection conn,
183 SilcProtocol protocol, void *failure)
189 /* Asks whether the user would like to perform the key agreement protocol.
190 This is called after we have received an key agreement packet or an
191 reply to our key agreement packet. This returns TRUE if the user wants
192 the library to perform the key agreement protocol and FALSE if it is not
193 desired (application may start it later by calling the function
194 silc_client_perform_key_agreement). If TRUE is returned also the
195 `completion' and `context' arguments must be set by the application. */
198 silc_key_agreement(SilcClient client, SilcClientConnection conn,
199 SilcClientEntry client_entry, const char *hostname,
200 uint16 port, SilcKeyAgreementCallback *completion,
207 /* Notifies application that file transfer protocol session is being
208 requested by the remote client indicated by the `client_entry' from
209 the `hostname' and `port'. The `session_id' is the file transfer
210 session and it can be used to either accept or reject the file
211 transfer request, by calling the silc_client_file_receive or
212 silc_client_file_close, respectively. */
215 silc_ftp(SilcClient client, SilcClientConnection conn,
216 SilcClientEntry client_entry, uint32 session_id,
217 const char *hostname, uint16 port)
223 /* The SilcClientOperation structure containing the operation functions.
224 You will give this as an argument to silc_client_alloc function. */
225 SilcClientOperations ops = {
227 silc_channel_message,
228 silc_private_message,
234 silc_get_auth_method,
235 silc_verify_public_key,