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

Introduction to the Manual
This document is designed to help you understand how the reference manual is organized, how it can be used efficiently, and how to find the information you need.
Target Audience
This Toolkit reference manual is targeted at application developers who would like to add SILC support into their application, and to create new SILC based applications. It is especially aimed at C and C++ programmers, who would like to create SILC client applications, either based on command line interface (CLI) or on graphical user interface (GUI).
Overview
The SILC Toolkit Reference Manual has collected the essential information needed by application developers. The following guide and reference information is included in this manual:
- Describing the documentation conventions
- Describing the Toolkit design
- Describing the SILC Protocol
- Describing the programming conventions and idioms
- Documenting the set of public APIs available for programmers
- Describing the usage of various libraries
  You can download the latest SILC Toolkit from the SILC Project Website, which includes the latest version of the reference manual. The Toolkit package includes the full sources of the Toolkit, and includes several example applications and piece of example codes.
  Using the Reference Manual
  The API references are ogranized by libraries. Each library will include list of interfaces it provides. Each of the interface in the library provides list of public API items. Each of the item in the list is a hyper link that opens the detailed page describing the API item. All API references are automatically generated from the sources and they have a clear structural layout. The references can provide cross links to other references inside the specific interface or the specific library.
  The list of the library interface items can also include links to guides that describe the use of a specific library or interface. These are intended as HOWTOs for programmers describing all aspects of the library or interface. They make the application development easier by also providing small examples.
  All interfaces provided by the reference manual are public, and it does not describe any internal or undocumented interfaces. Since the reference manual is automatically generated, it is constantly evolving. It also may omit some of the interfaces or libraries, that have not yet been documented in the sources.
  Document Layout
  The document layout provides quick links to libraries, interfaces and specific API items by including list of links in the left and/or right side of the page in the web browser. These links can be used to directly access the specific library, interface or API item. The link lists may include other links to guides, and reference links to outside the reference manual as well.
  Reference Conventions
  The structural layout of a API item describes the following information about the item:
- Type. Types that can appear are Variable, Structure, Function. A name that appears without type is constant, usually #define, enum or typedef. Usually the source code of the constants are appended to the reference.
- Name. Describes the name of the item. All functions start with silc_ prefix, macros start with SILC_ prefix, and type names and structures start with Silc prefix.
- Synopsis. Functions also describe the synopsis of the function.
- Description. Each of the item is described in detail of what the item does and how it can be used.
- Notes. Optionally the item may describe additional notes to the detailed description. These usually describe various exeptions or other important notes that the programmer should be aware of.
- Example. Optionally the item may include a piece of source code that give short example of how the item may be used.
- See Also. Optionally the item may include list of links to other items, or some other references that relate to the described item.
- Source. Optionally the item may include the actual source code from the header file where the documentation was automatically generated.
  Note that some of these informations are optional and not all API items include all of these informations.
  Reference Example
  Please refer to this link for short example of the API item reference layout: SILC Example API.

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