it wants. The library is entirely transparent to the user interface and
it does not include any user interface specific issues such as window
handling or item handling on the screen etc. These does not interest
-the library. The `silcclient.h' also defines the client libary interface
-the application can call. The interface includes for example functions
-for sending channel and private messages, client and channel retrieval
-and other utility functions.
+the library. The `silcclient.h' and `silcclient_entry.h' also defines the
+client libary interface the application can call. The interface includes
+for example functions for sending channel and private messages, client and
+channel retrieval and other utility functions.
<br /> <br /> <br />
<b>Including Library Headers</b>
<br /> <br />
-Your application must include the following includes in your sources to
+Your application must include the following includes in your sources to
get access all SILC Client Library routines:
<br /> <br />
<tt>
-#include "silcincludes.h"<br />
+#include "silc.h"<br />
#include "silcclient.h"
</tt>
manner:
<br /> <br />
-<tt> SilcClient client = silc_client_alloc(&ops, params, context, silc_version_string);</tt>
+<tt> SilcClient client = silc_client_alloc(&ops, params, context, NULL);</tt>
<br /> <br />
`ops' is the static structure of client operations that library will call.
`context' can be some application specific context that will be saved into
the SilcClient object. It is up to the caller to free this context.
SilcClient is always passed to the application thus the application
-specific context can be retrieved from the SilcClient object. See
-`client.h' file for detailed definition of SilcClient object.
-
-<br /> <br />
-The `silc_version_string' is the current protocol version string, and you
-can get it by including `silcversion.h' header in your source code.
+specific context can be retrieved from the SilcClient object.
<br /> <br />
`ops' can be defined for example as follows:
silc_notify,<br />
silc_command,<br />
silc_command_reply,<br />
- silc_connect,<br />
- silc_disconnect,<br />
silc_get_auth_method,<br />
silc_verify_public_key,<br />
silc_ask_passphrase,<br />
- silc_failure,<br />
silc_key_agreement,<br />
+ silc_file_transfer,<br />
};<br />
</tt>
<b>Initializing the Client</b>
<br /> <br />
-The client must be initialized before running. However, there are also
-some other tasks that must be done before initializing the client.
-The following pointers must be set by the application before calling
-the initializing function:
-
-<br /> <br />
-<tt>
- client->username<br />
- client->hostname<br />
- client->realname<br />
- client->pkcs<br />
- client->public_key<br />
- client->private_key
-</tt>
+The client must be initialized before running. The client is initialized
+simply by calling silc_client_init function:
<br /> <br />
-You may also set client->nickname if you want. If it is set then the
-library will change the nickname to that one after the client is connected
-to the server. If not set, then server will initially give the nickname
-which is same as the username.
+<tt> silc_client_init(client, username, hostname, realname,
+ foo_client_running, foo_ctx);</tt>
<br /> <br />
-After setting the pointers one must call:
-
-<br /> <br />
-<tt> silc_client_init(client);</tt>
-
-<br /> <br />
-which then initializes the client library for the `client'. If the
-pointers mentioned above are not initialized the silc_client_init will
-fail. The application should check the return value of the silc_client_init
-function.
+which then initializes the client library for the `client'. The `username'
+and `hostname' pointers are required. The `foo_client_running' with
+`foo_ctx' in this example will be called by the client library after the
+client is up and running. After you receive this callback you may start
+using other API functions, such as creating connection to remote server.
<br /> <br /> <br />
<b>Running the Client in GUI application</b>
<br /> <br />
-Many GUI applications has their own main loop or event loop, which they
-would like to use or are forced to use by the underlaying system. If you
-are developing for example GUI application on Unix system, and you are
-using GTK+ or QT as GUI library you would probably like to use their own
-main loop. SILC Client can be run under external main loop as well. The
-interface provides a function silc_client_run_one which will run the
-client library once, and returns immediately. During that running it can
-process incoming data and send outgoing data, but it is guaranteed that it
+Many GUI applications has their own main loop or event loop, which they
+would like to use or are forced to use by the underlaying system. If you
+are developing for example GUI application on Unix system, and you are
+using GTK+ or QT as GUI library you would probably like to use their own
+main loop. SILC Client can be run under external main loop as well. The
+interface provides a function silc_client_run_one which will run the
+client library once, and returns immediately. During that running it can
+process incoming data and send outgoing data, but it is guaranteed that it
will not block the calling process.
<br /> <br />
-It is suggested that you would call this function as many times in a
-second as possible to provide smooth action for the client library. You
-can use an timeout task, or an idle task provided by your GUI library to
-accomplish this. After you have initialized the client library with
-silc_client_init, you should register the timeout task or idle task that
-will call the silc_client_run_one periodically. In the Toolkit package
-there is GTK-- GUI example in silcer/ directory. That example calls the
-silc_client_run_one every 50 milliseconds, and it should be sufficient for
-smooth working.
+It is suggested that you would call this function as many times in a
+second as possible to provide smooth action for the client library. You
+can use an timeout task, or an idle task provided by your GUI library to
+accomplish this. After you have initialized the client library with
+silc_client_init, you should register the timeout task or idle task that
+will call the silc_client_run_one periodically.
<br /> <br />
-For Win32 the silc_client_run can be used instead of using the Windows's
-own event loop. However, if you would like to use the silc_client_run_one
-also on Win32 systems it is possible.
+For Win32 the silc_client_run can be used instead of using the Windows's
+own event loop. However, if you would like to use the silc_client_run_one
+also on Win32 system it is possible.
<br /> <br /> <br />
<b>Running Client in GTK--</b>
<br /> <br />
-Here is a short example how to run the SILC Client libary under the
+Here is a short example how to run the SILC Client libary under the
Gnome/GTK--'s main loop:
<br /> <br />
</tt>
<br /> <br />
-This will call the function silc_scheduler every 50 millisecconds, which
-on the otherhand will call silc_client_run_one, which will make the SILC
+This will call the function silc_scheduler every 50 millisecconds, which
+on the otherhand will call silc_client_run_one, which will make the SILC
Client library work on the background of the GUI application.
<b>Creating Connection to Server</b>
<br /> <br />
-Connection to remote SILC server is done by calling:
+After your client is up and running you may create connection to remote
+SILC server. It is done simply by calling:
<br /> <br />
-<tt> silc_client_connect_to_server(client, port, hostname, context);</tt>
+<tt> silc_client_connect_to_server(client, ¶ms,
+ public_key, private_key,
+ remote_host, remote_port,
+ foo_connected_cb, foo_ctx);</tt>
<br /> <br />
The function will create the connection asynchronously to the server, ie.
-the function will return before the actual connection is created. After
-the connection is created the client->ops->connect operation is called.
+the function will return before the actual connection is created. The
+`foo_connected_cb' will be called once the connection has been established.
+The `params' may be NULL but it may be used to provide additional parameters
+to the connecting. For example it is possible to set the initial nickname
+you would like to use into the `params'.
+
+
+<br /> <br /> <br />
+<b>Debugging</b>
<br /> <br />
-Generally speaking the connections are associated with windows' on the
-screen. IRC is usually implemented this way, however it is not the
-necessary way to associate the client's connections. SilcClientConnection
-object is provided by the library (and is always passed to the application)
-that can be used in the application to associate the connection from the
-library. Application specific context can be saved to the
-SilcClientConnection object which then can be retrieved in the application,
-thus perhaps associate the connection with what ever object in
-application (window or something else).
+Being able to debug what you have coded is important when troubles occurs
+during coding, and they always do. SILC supports extensive debugging
+capabilities which are also available for client library user. You should
+have compiled the Toolkit with --enable-debug option so that run-time
+debugging is enabled.
+<br /> <br />
+Then, to say in your application you would like to use the debugging use
+the SILC_DEBUG macro. Put this macro to your main header file, or
+some other file that needs the debugging enabled. After using this macro
+you are able to use the debugging routines provided by the SILC Toolkit.
+Note that, the Toolkit library must be compiled with --enable-debug for
+this macro to have any effect.
-<br /> <br /> <br />
-<b>Using Own Connecting</b>
+<br /> <br />
+To turn on the run-time debugging call function silc_log_debug with TRUE
+value. To see packet hexdumps you can call also silc_log_debug_hexdump
+with TRUE value. Hexdumps can create more debug log so not setting it
+to TRUE by default is probably best. To get debug messages out of specific
+modules you can set a debug string with silc_log_set_debug_string function.
+The function takes regex string as argument, for example:
<br /> <br />
-Application might not want to use silc_client_connect_to_server function
-if it wants to perform its own connecting for some reason. In this case
-application must call function silc_client_start_key_exchange after it
-has created the connection by itself. This function starts the key
-exhange protocol between the client and server and the library takes care
-of everything after that.
+<tt>
+ silc_log_debug(TRUE);<br />
+ silc_log_set_debug_string("*");<br />
+</tt>
<br /> <br />
-After connection has been created application must call:
+This piece of code turns on the debugging and sets "*" as debug string. This
+means that all debug messages are printed. To get debugging out of only
+for example SILC Client Library the debug string could be "silc_client*".
+The debug string matches to function names and filenames so it is possible
+to get debugging out of specific files, and specific functions. Other
+examples could be:
<br /> <br />
<tt>
- SilcClientConnection conn;
+ silc_log_set_debug_string("silc_client*,*sock*,*ske*");<br />
+</tt>
<br /> <br />
- /* Add new connection to client */<br />
- conn = silc_client_add_connection(client, hostname, port, context);
+By default, all debug messages are printed to standard error output (stderr).
+If you want to redirect the debug messages somewhere else you can set your
+own debug callback with silc_log_set_debug_callbacks function:
<br /> <br />
- /* Start key exchange and let the library handle everything<br />
- after this point on. */<br />
- silc_client_start_key_exchange(client, conn, sock);
+<tt>
+ silc_log_set_debug_callbacks(my_debug_callback, my_context, my_hexdump_callback, my_context);<br />
</tt>
<br /> <br />
-NOTE: These calls are performed only and only if application did not call
-silc_client_connect_to_server function, but performed the connecting
-process manually.
+See the lib/silcutil/silclog.h for definition of the callbacks. See the
+same file for other logging and debugging information.
+<br /> <br />
+You can also use SILC debugging capabilities in your own application. To
+produce debug messages you can use SILC_LOG_DEBUG and SILC_LOG_HEXDUMP
+macros in your application. The SILC_LOG_DEBUG can print out normal debug
+messages with variable argument list, for example:
-<br /> <br /> <br />
-<b>Example Client</b>
+<br /> <br />
+<tt>
+ SILC_LOG_DEBUG(("Start"));<br />
+ SILC_LOG_DEBUG(("Packet length %d", packet_len));<br />
+ SILC_LOG_DEBUG(("The remote is %s on %d", sock->ip, sock->port));
+</tt>
<br /> <br />
-This section includes an example SILC client implementation in pseudo-like
-C code. It creates and initializes the client and sets up an imaginary
-user interface. The user will use the user interface then to create
-the connections. The SilcClientOperations are expected to be implemented.
+The SILC_LOG_HEXDUMP macro can be used dump data which couldn't be printed
+out otherwise, for example binary data.
<br /> <br />
-<pre>
-#include "silcincludes.h"
-#include "silcclient.h"
+<tt>
+ SILC_LOG_HEXDUMP(("Packet"), packet->data, packet->len);<br />
+ SILC_LOG_HEXDUMP(("Packet, size=%d", size), packet->data, packet->len);
+</tt>
-int main()
-{
- SilcClientOperations ops = {
- silc_say,
- silc_channel_message,
- silc_private_message,
- silc_notify,
- silc_command,
- silc_command_reply,
- silc_connect,
- silc_disconnect,
- silc_get_auth_method,
- silc_verify_public_key,
- silc_ask_passphrase,
- silc_failure,
- silc_key_agreement,
- };
-
- SilcClient client;
-
- /* Allocate SILC client. The `silc_version_string' is defined
- in includes/version.h file. */
- client = silc_client_alloc(&ops, NULL, NULL, silc_version_string);
-
- /* Register default ciphers, pkcs, hash funtions and hmacs. */
- silc_cipher_register_default();
- silc_pkcs_register_default();
- silc_hash_register_default();
- silc_hmac_register_default();
-
- /* Set the mandatory pointers, read public and private key from
- files (or somewhere) and return pointers and PKCS context. */
- client->username = silc_get_username();
- client->hostname = silc_net_localhost();
- client->realname = silc_get_real_name();
- client->pkcs = get_public_and_private_key(&client->public_key,
- &client->private_key);
-
- /* If the keys does not exist, create a key pair since we must
- provide key pair to the library. */
- if (!client->pkcs)
- generate_key_new_key_pair(client);
-
- /* Iinitialize client */
- if (!silc_client_init(client))
- fatal_error("Could not initialize client");
-
- /* Initialize user interface. The user interface can be generally
- initialized at any phase, including before actually allocating
- and initializing the client, if wished. */
- InitUserInterface();
- DoCoolThings();
-
- /* Start the client. This will start the scheduler. At this phase
- the user might have the user interface in front of him already.
- He will use the user interface to create the connection to the
- server for example. When this function returns the program is
- ended. */
- silc_client_run(client);
-
- /* Client is ended */
- return 0;
-}
-</pre>
+<br /> <br />
+Note that the variable arguments in SILC_LOG_HEXDUMP are before the second
+last parenthesis, and the last two arguments are the data, and its length that
+are hexdumped.
projects / silc.git / blobdiff