Copyright © 2001 - 2005 SILC Project SILC Project Website | SILC Toolkit Reference Manual Index

SILC Toolkit Reference Manual SILC Core Library SILC Authentication Interface SILC Message Interface SILC Channel Interface SILC Command Interface SILC Notify Interface SILC Status Types SILC Modes SILC ID Interface SILC ID Cache Interface SILC Argument Interface SILC Attributes Interface Packet Protocol Interface SILC Utility Library Basic SILC Types SILC Buffer Interface SILC Buffer Format Interface SILC Hash Table Interface SILC Logging Interface SILC Memory Interface SILC Mutex Interface SILC Thread Interface SILC Network Interface SILC Schedule Interface SILC Socket Interface SILC Protocol Interface SILC Config Interface SILC File Util Interface SILC String Util Interface SILC UTF-8 Interface SILC Stringprep Interface SILC Util Interface SILC List Interface SILC Dynamic List Interface SILC VCard Interface SILC Application Utilities SILC Crypto Library Introduction to SILC RNG SILC RNG Interface SILC Cipher API SILC PKCS API SILC PKCS#1 API SILC Hash Interface SILC HMAC Interface SILC SFTP Library SILC SFTP Interface SFTP Filesystems Interface SILC Client Library Using SILC Client Library Tutorial Arguments for command_reply Client Operation SilcStatus Error Arguments in command_reply Client Operation Arguments for notify Client Operation Unicode and UTF-8 Strings in Client Library Client Library Interface Reference SILC Key Exchange Library SILC SKE Interface SKE Status Types SKE Diffie Hellman Groups SKE Payloads SILC Math Library SILC MP Interface SILC Math Interface Resource Links SILC Project Website SILC Protocol Documentation SILC White Paper SILC FAQs
Structure SilcClientParams NAME
        typedef struct { ... } SilcClientParams;
DESCRIPTION
        Client parameters. This can be filled with proper values and
        given as argument to the silc_client_alloc function. The structure
        hold various parameters which affects the function of the client.
SOURCE
        typedef struct {
          /* Number of maximum tasks the client library's scheduler can handle.
             If set to zero, the default value will be used (200). For WIN32
             systems this should be set to 64 as it is the hard limit dictated
             by the WIN32. */
          int task_max;

          /* Rekey timeout in seconds. The client will perform rekey in this
             time interval. If set to zero, the default value will be used. */
          unsigned int rekey_secs;

          /* Connection authentication method request timeout. If server does not
             reply back the current authentication method when we've requested it
             in this time interval we'll assume the reply will not come at all.
             If set to zero, the default value (2 seconds) will be used. */
          unsigned int connauth_request_secs;

          /* Nickname format string. This can be used to order the client library
             to save the nicknames in the library in a certain format. Since
             nicknames are not unique in SILC it is possible to have multiple same
             nicknames. Using this format string it is possible to order the library
             to separate the multiple same nicknames from each other. The format
             types are defined below and they can appear in any order in the format
             string. If this is NULL then default format is used which is the
             default nickname without anything else. The string MUST be NULL
             terminated.

             Following format types are available:

             %n  nickname      - the real nickname returned by the server (mandatory)
             %h  hostname      - the stripped hostname of the client
             %H  full hostname - the full hostname of the client
             %s  server name   - the server name the client is connected
             %S  full server   - the full server name the client is connected
             %a  number        - ascending number in case there are several
                                 same nicknames (fe. nick@host and nick@host2)

             Example format strings: "%n@%h%a"   (fe. nick@host, nick@host2)
                                     "%a!%n@%s"  (fe. nick@server, 2!nick@server)
                                     "%n@%H"     (fe. nick@host.domain.com)

             By default this format is employed to the nicknames by the libary
             only when there appears multiple same nicknames. If the library has
             only one nickname cached the nickname is saved as is and without the
             defined format. If you want always to save the nickname in the defined
             format set the boolean field `nickname_force_format' to value TRUE.
          */
          char nickname_format[32];

          /* If this is set to TRUE then the `nickname_format' is employed to all
             saved nicknames even if there are no multiple same nicknames in the
             cache. By default this is FALSE, which means that the `nickname_format'
             is employed only if the library will receive a nickname that is
             already saved in the cache. It is recommended to leave this to FALSE
             value. */
          bool nickname_force_format;

          /* A callback function provided by the application for the library to
             parse the nickname from the formatted nickname string. Even though
             the libary formats the nicknames the application knows generally the
             format better so this function should be provided for the library
             if the application sets the `nickname_format' field. The library
             will call this to get the true nickname from the provided formatted
             nickname string whenever it needs the true nickname. */
          SilcNicknameFormatParse nickname_parse;

          /* If this is set to TRUE then the client will ignore all incoming
             Requested Attributes queries and does not reply anything back.  This
             usually leads into situation where server does not anymore send
             the queries after seeing that client does not reply anything back.
             If your application does not support Requested Attributes or you do
             not want to use them set this to TRUE.  See SilcAttribute and
             silc_client_attribute_add for more information on attributes. */
          bool ignore_requested_attributes;

          /* If this is set to TRUE, the silcclient library will not register and
             deregister the cipher, pkcs, hash and hmac algorithms. The application
             itself will need to handle that. */
          bool dont_register_crypto_library;

        } SilcClientParams;
Client Library Interface SilcClient SilcClientConnection SilcClientEntry SilcChannelEntry SilcChannelUser SilcServerEntry SilcKeyAgreementStatus SilcKeyAgreementCallback SilcPrivateMessageKeys SilcChannelPrivateKey SilcAskPassphrase SilcVerifyPublicKey SilcGetAuthMeth SilcClientMessageType SilcClientConnectionStatus SilcClientOperations SilcNicknameFormatParse SilcClientParams silc_client_alloc silc_client_free silc_client_init silc_client_run silc_client_run_one silc_client_stop SilcClientConnectionParams silc_client_connect_to_server silc_client_add_connection silc_client_del_connection silc_client_add_socket silc_client_del_socket silc_client_start_key_exchange silc_client_close_connection silc_client_send_channel_message silc_client_send_private_message SilcGetClientCallback silc_client_get_clients silc_client_get_clients_whois silc_client_get_clients_local silc_client_get_clients_by_channel silc_client_get_clients_by_list silc_client_get_client_by_id silc_client_get_client_by_id_resolve silc_client_del_client SilcGetChannelCallback silc_client_get_channel silc_client_get_channel_resolve silc_client_get_channel_by_id silc_client_get_channel_by_id_resolve silc_client_del_channel silc_client_get_server silc_client_get_server_by_id silc_client_del_server silc_client_on_channel silc_client_command_call silc_client_command_send silc_client_command_pending silc_client_add_private_message_key silc_client_add_private_message_key_ske silc_client_del_private_message_key silc_client_list_private_message_keys silc_client_send_private_message_key_request silc_client_free_private_message_keys silc_client_add_channel_private_key silc_client_del_channel_private_keys silc_client_del_channel_private_key silc_client_list_channel_private_keys silc_client_free_channel_private_keys silc_client_current_channel_private_key silc_client_send_key_agreement silc_client_perform_key_agreement silc_client_perform_key_agreement_fd silc_client_abort_key_agreement silc_client_set_away_message SilcConnectionAuthRequest silc_client_request_authentication_method SilcClientMonitorStatus SilcClientFileError SilcClientFileMonitor SilcClientFileName SilcClientFileAskName silc_client_file_send silc_client_file_receive silc_client_file_close silc_client_attribute_add silc_client_attribute_del silc_client_attributes_get silc_client_attributes_request silc_client_send_packet

Copyright © 2001 - 2005 SILC Project SILC Project Website | SILC Toolkit Reference Manual Index