X-Git-Url: http://git.silcnet.org/gitweb/?p=website.git;a=blobdiff_plain;f=docs%2Ftoolkit%2Fmanual%2Fsilcclient_entry-SilcClientEntry.html;fp=docs%2Ftoolkit%2Fmanual%2Fsilcclient_entry-SilcClientEntry.html;h=280d773382f7a02d11e68fd7fb0f4b583ce35c4f;hp=0000000000000000000000000000000000000000;hb=80b80cef93d9dff6acc4bc8e3a522c55fcdc3fca;hpb=43e53f529ca5c7d2ddb7cee8e76e273631e6f1e2 diff --git a/docs/toolkit/manual/silcclient_entry-SilcClientEntry.html b/docs/toolkit/manual/silcclient_entry-SilcClientEntry.html new file mode 100644 index 0000000..280d773 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-SilcClientEntry.html @@ -0,0 +1,288 @@ + + + + + + + + + + + + + + + + + + + +
Copyright © 2001 - 2007 SILC Project
+ SILC Project Website
+ SILC Toolkit Reference Manual
+ Index
+ + +
+ + + + + + + + + + + + + + +
+ + + +
+
+ + + +SILC Toolkit Reference Manual
+ + +SILC Crypto Library
+    Introduction to SILC RNG
+    SILC RNG Interface
+    SILC Cipher API
+    SILC PKCS API
+    SILC Public Key API
+    SILC PKCS #1 API
+    SILC Hash Interface
+    SILC HMAC Interface
+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 Argument Interface
+    SILC Attributes Interface
+    Packet Engine Interface
+    SILC Public Key Payload Interface
+SILC Key Exchange Library
+    SILC SKE Interface
+    SILC Connection Authentication Interface
+SILC VCard Library
+    SILC VCard Interface
+SILC Math Library
+    SILC MP Interface
+    SILC Math 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
+    Client Entry Interface Reference
+SILC ASN.1 Library
+    SILC ASN.1 Interface
+    SILC BER interface
+SILC HTTP Library
+    SILC HTTP Server Interface
+    SILC HTTP PHP Translator
+SILC Utility Library
+    Basic Types and Definitions
+    Data Buffer Interface
+    Data Buffer Format Interface
+    Hash Table Interface
+    Memory Allocation Interface
+    Data Stack (memory pool) Interface
+    Finite State Machine Interface
+    Thread Interface
+    Mutual Exclusion Lock Interface
+    Condition Variable Interface
+    Atomic Operations Interface
+    Network (TCP and UDP) Interface
+    Scheduler Interface
+    Asynchronous Operation Interface
+    Abstract Stream Interface
+    Socket Stream Interface
+    File Descriptor Stream Interface
+    File Utility Functions
+    String Utility Interface
+    Snprintf Interface
+    UTF-8 String Interface
+    Stringprep Interface
+    Utility Functions
+    List Interface
+    Dynamic List Interface
+    MIME Interface
+    Time Utility Functions
+    Logging Interface
+    Config File Interface
+SILC Key Repository Library
+    SILC SKR Interface
+SILC Application Utility Library
+    SILC Application Utilities
+    SILC ID Cache Interface
+SILC SFTP Library
+    SILC SFTP Interface
+    SFTP Filesystems Interface
+ +
+Resource Links +
+SILC Project Website
+SILC Protocol Documentation
+SILC White Paper
+SILC FAQs
+ +
+



+
+
+ + + + +
+
+ +Structure SilcClientEntry

+ + +NAME + +

+    typedef struct SilcClientEntryStruct { ... } *SilcClientEntry;
+
+
+DESCRIPTION + +

+    This structure represents a client or a user in the SILC network.
+    The local user has this structure also and it can be accessed from
+    SilcClientConnection structure.  All other users in the SILC network
+    that are accessed using the Client Library routines will have their
+    own SilcClientEntry structure.  For example, when finding users by
+    their nickname the Client Library returns this structure back to
+    the application.  All strings in the structure are UTF-8 encoded.
+
+    Application may store its own pointer into the context pointer in
+    this structure.
+
+
+NOTES + +

+    If application wants to store nickname or any of the other strings
+    it should always duplicated them.
+
+    None of the string arrays are set if the first character is '\0'.
+    All string arrays are always zero ('\0') terminated.
+
+    If application stores the SilcClientEntry it must always take
+    a reference of it by calling silc_client_ref_client function.  The
+    reference must be released after it is not needed anymore by calling
+    silc_client_unref_client function.
+
+
+SOURCE + +
    struct SilcClientEntryStruct {
+      char nickname[256 + 1];            /* Nickname */
+      char username[128 + 1];            /* Username */
+      char hostname[256 + 1];            /* Hostname */
+      char server  [256 + 1];            /* SILC server name */
+      char *realname;                    /* Realname (userinfo) */
+      char *nickname_normalized;         /* Normalized nickname */
+    
+      SilcClientID id;                   /* The Client ID */
+      SilcUInt32 mode;                   /* User mode in SILC, see SilcUserMode */
+      SilcPublicKey public_key;          /* User's public key, may be NULL */
+      SilcHashTable channels;            /* Channels client has joined */
+      SilcDList attrs;                   /* Requested Attributes (maybe NULL) */
+      unsigned char fingerprint[20];     /* SHA-1 fingerprint of the public key */
+    
+      void *context;                     /* Application specific context */
+      SilcClientEntryInternal internal;
+    };
+



+
+
+ + + + +
+
+ +Client Library Interface
+SilcClientEntry
+SilcChannelEntry
+SilcServerEntry
+SilcGetClientCallback
+silc_client_lock_client
+silc_client_unlock_client
+silc_client_ref_client
+silc_client_unref_client
+silc_client_list_free
+silc_client_get_clients
+silc_client_get_clients_whois
+silc_client_get_clients_local
+silc_client_get_client_by_id
+silc_client_get_client_by_id_resolve
+SilcGetChannelCallback
+silc_client_lock_channel
+silc_client_unlock_channel
+silc_client_ref_channel
+silc_client_unref_channel
+silc_client_list_free_channel
+silc_client_get_channel
+silc_client_get_channel_resolve
+silc_client_get_channel_by_id
+silc_client_get_channel_by_id_resolve
+SilcGetServerCallback
+silc_client_lock_server
+silc_client_unlock_server
+silc_client_ref_server
+silc_client_unref_server
+silc_client_list_free_server
+silc_client_get_server
+silc_client_get_server_by_id
+silc_client_get_server_by_id_resolve
+
+ +



+
+
+ + + +
+ + + + + + +
Copyright © 2001 - 2007 SILC Project
+ SILC Project Website
+ SILC Toolkit Reference Manual
+ Index
+ + +