lib/silccore/silcprotocol.h

   1 /*
   2
   3   silcprotocol.h
   4
   5   Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
   6
   7   Copyright (C) 1997 - 2000 Pekka Riikonen
   8
   9   This program is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU General Public License as published by
  11   the Free Software Foundation; either version 2 of the License, or
  12   (at your option) any later version.
  13
  14   This program is distributed in the hope that it will be useful,
  15   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17   GNU General Public License for more details.
  18
  19 */
  20
  21 #ifndef SILCPROTOCOL_H
  22 #define SILCPROTOCOL_H
  23
  24 /* Protocol type definition. */
  25 typedef unsigned char SilcProtocolType;
  26
  27 /* Protocol state definition. */
  28 typedef unsigned char SilcProtocolState;
  29
  30 /* Protocol states. Do NOT change the values of these states, especially
  31    the START state or you break every protocol. */
  32 #define SILC_PROTOCOL_STATE_UNKNOWN 0
  33 #define SILC_PROTOCOL_STATE_START 1
  34 #define SILC_PROTOCOL_STATE_END 253
  35 #define SILC_PROTOCOL_STATE_ERROR 254
  36
  37 /* Connection Authentication protocols' authentication methods */
  38 #define SILC_PROTOCOL_CONN_AUTH_NONE 0
  39 #define SILC_PROTOCOL_CONN_AUTH_PASSWORD 1
  40 #define SILC_PROTOCOL_CONN_AUTH_PUBLIC_KEY 2
  41
  42 /*
  43    SILC Protocol Object.
  44
  45    Short description of the field following:
  46
  47    SilcProtocolType type
  48
  49        Protocol type. This is enumeration.
  50
  51    SilcProtocolCallback callback;
  52
  53        Callback function for the protocol. This is SilcTaskCallback function
  54        pointer as the protocols in SILC are executed as timeout tasks.
  55
  56    The object expands to another structure as well. Short description of
  57    these fields following:
  58
  59    SilcProtocolObject *protocol
  60
  61        This is the pointer to the protocol object defined above.
  62
  63    SilcProtocolState state
  64
  65        Protocol state. This is enumeration. The state of the protocol can
  66        be changed in the callback function.
  67
  68    void *context
  69
  70        Context to be sent for the callback function. This is usually
  71        object for either SILC client or server. However, this abstraction
  72        makes it possible that this pointer could be some other object as well.
  73
  74    SilcProtocolExecute execute;
  75
  76        Executes the protocol and its states. The correct state must be set
  77        before calling this function. The state is usually set in the protocol
  78        specific routines.
  79
  80    SilcProtocolExecute execute_final;
  81
  82        Executes the final callback function of the protocol. Read on.
  83
  84    SilcProtocolFinalCallback final_callback;
  85
  86        This is a callback function that is called with timeout _after_ the
  87        protocol has finished or error occurs. If this is NULL, naturally
  88        nothing will be executed. Protocol should call this function only at
  89        SILC_PROTOCOL_STATE_END and SILC_PROTOCOL_STATE_ERROR states.
  90
  91 */
  92 typedef SilcTaskCallback SilcProtocolCallback;
  93
  94 typedef struct SilcProtocolObjectStruct {
  95   SilcProtocolType type;
  96   SilcProtocolCallback callback;
  97
  98   struct SilcProtocolObjectStruct *next;
  99 } SilcProtocolObject;
 100
 101 typedef SilcTaskCallback SilcProtocolFinalCallback;
 102 typedef SilcTaskCallback SilcProtocolExecute;
 103
 104 typedef struct SilcProtocolStruct {
 105   SilcProtocolObject *protocol;
 106   SilcProtocolState state;
 107   void *context;
 108
 109   //  SilcProtocolExecute execute;
 110   void (*execute)(void *, int, void *, int, long, long);
 111   SilcProtocolExecute execute_final;
 112   SilcProtocolFinalCallback final_callback;
 113 } *SilcProtocol;
 114
 115 /* Prototypes */
 116 void silc_protocol_register(SilcProtocolType type,
 117                             SilcProtocolCallback callback);
 118 void silc_protocol_unregister(SilcProtocolType type,
 119                               SilcProtocolCallback callback);
 120 void silc_protocol_alloc(SilcProtocolType type, SilcProtocol *new_protocol,
 121                          void *context, SilcProtocolFinalCallback callback);
 122 void silc_protocol_free(SilcProtocol protocol);
 123 void silc_protocol_execute(void *qptr, int type,
 124                            void *context, int fd,
 125                            long secs, long usecs);
 126 void silc_protocol_execute_final(void *qptr, int type,
 127                                  void *context, int fd);
 128
 129 #endif