Copyright © 2001 - 2002 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 Math Library SILC MP Interface SILC Math Interface SILC SFTP Library SILC SFTP Interface SFTP Filesystems 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 Util Interface SILC List Interface SILC Dynamic List Interface SILC VCard Interface SILC Application Utilities SILC Key Exchange Library SILC SKE Interface SKE Status Types SKE Diffie Hellman Groups SKE Payloads 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 Client Library Interface Reference 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 Resource Links SILC Project Website SILC Protocol Documentation SILC White Paper SILC FAQs
Structure SilcProtocol NAME
        typedef struct SilcProtocolStruct { ... } *SilcProtocol;
DESCRIPTION
        The actual protocol object. This is allocated by the silc_protocol_alloc
        and holds the information about the current protocol. Information
        such as the current state, execution callback and final callback.
        The context is freed by silc_protocol_free function.

        Short description of the field following:

        SilcProtocolObject *protocol

          This is the pointer to the SilcProtocolObject and holds the
          protocol specific information.

        SilcProtocolState state

          Protocol state. The state of the protocol can be changed in the
          callback function.

        void *context

          Context to be sent for the callback function. This is usually
          object for either SILC client or server. However, this abstraction
          makes it possible that this pointer could be some other object as
          well. Note that the context is not delivered in any callback
          function. Application can access it through this context.

        SilcProtocolFinalCallback final_callback;

          This is a callback function that is called with timeout _after_ the
          protocol has finished or error occurs. If this is NULL, naturally
          nothing will be executed. Protocol should call this function only at
          SILC_PROTOCOL_STATE_END and SILC_PROTOCOL_STATE_ERROR states.
SILC Protocol Interface SilcProtocolType SilcProtocolState SilcProtocolCallback SilcProtocolFinalCallback SilcProtocolObject SilcProtocol silc_protocol_register silc_protocol_unregister silc_protocol_alloc silc_protocol_free silc_protocol_execute silc_protocol_execute_final silc_protocol_cancel

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