include/gammu-callback.h

   1 /**
   2  * \file gammu-callback.h
   3  * \author Michal Čihař
   4  *
   5  * Callback handlers.
   6  */
   7 #ifndef __gammu_callback_h
   8 #define __gammu_callback_h
   9
  10 /**
  11  * \defgroup Callback Callback
  12  * Generic state machine callback layer.
  13  */
  14
  15 #include <gammu-types.h>
  16 #include <gammu-message.h>
  17 #include <gammu-call.h>
  18
  19 /**
  20  * Callback for incoming calls.
  21  *
  22  * \ingroup Callback
  23  */
  24 typedef void (*IncomingCallCallback) (GSM_StateMachine * s, GSM_Call *call,
  25                                       void *user_data);
  26
  27 /**
  28  * Callback for incoming SMS.
  29  *
  30  * \ingroup Callback
  31  */
  32 typedef void (*IncomingSMSCallback) (GSM_StateMachine * s, GSM_SMSMessage *sms,
  33                                      void *user_data);
  34
  35 /**
  36  * Callback for incoming cell broadcast.
  37  *
  38  * \ingroup Callback
  39  */
  40 typedef void (*IncomingCBCallback) (GSM_StateMachine * s, GSM_CBMessage *cb,
  41                                     void *user_data);
  42
  43 /**
  44  * Callback for icoming USSD.
  45  *
  46  * \ingroup Callback
  47  */
  48 typedef void (*IncomingUSSDCallback) (GSM_StateMachine * s,
  49                                       GSM_USSDMessage *ussd, void *user_data);
  50
  51 /**
  52  * Callback for sending SMS.
  53  *
  54  * \ingroup Callback
  55  */
  56 typedef void (*SendSMSStatusCallback) (GSM_StateMachine * s, int status,
  57                                        int MessageReference, void *user_data);
  58
  59 /**
  60  * Sets callback for incoming calls.
  61  *
  62  * \param s State machine.
  63  * \param callback Pointer to callback function.
  64  * \param user_data Second parameter which will be passed to callback.
  65  *
  66  * \ingroup Callback
  67  */
  68 void GSM_SetIncomingCallCallback(GSM_StateMachine * s,
  69                                  IncomingCallCallback callback,
  70                                  void *user_data);
  71
  72 /**
  73  * Sets callback for incoming SMSes.
  74  *
  75  * \param s State machine.
  76  * \param callback Pointer to callback function.
  77  * \param user_data Second parameter which will be passed to callback.
  78  *
  79  * \ingroup Callback
  80  */
  81 void GSM_SetIncomingSMSCallback(GSM_StateMachine * s,
  82                                 IncomingSMSCallback callback, void *user_data);
  83
  84 /**
  85  * Sets callback for incoming CB.
  86  *
  87  * \param s State machine.
  88  * \param callback Pointer to callback function.
  89  * \param user_data Second parameter which will be passed to callback.
  90  *
  91  * \ingroup Callback
  92  */
  93 void GSM_SetIncomingCBCallback(GSM_StateMachine * s,
  94                                IncomingCBCallback callback, void *user_data);
  95
  96 /**
  97  * Sets callback for incoming USSD.
  98  *
  99  * \param s State machine.
 100  * \param callback Pointer to callback function.
 101  * \param user_data Second parameter which will be passed to callback.
 102  *
 103  * \ingroup Callback
 104  */
 105 void GSM_SetIncomingUSSDCallback(GSM_StateMachine * s,
 106                                  IncomingUSSDCallback callback,
 107                                  void *user_data);
 108
 109 /**
 110  * Sets callback for sending SMS.
 111  *
 112  * \param s State machine.
 113  * \param callback Pointer to callback function.
 114  * \param user_data Second parameter which will be passed to callback.
 115  *
 116  * \ingroup Callback
 117  */
 118 void GSM_SetSendSMSStatusCallback(GSM_StateMachine * s,
 119                                   SendSMSStatusCallback callback,
 120                                   void *user_data);
 121 #endif
 122
 123 /* Editor configuration
 124  * vim: noexpandtab sw=8 ts=8 sts=8 tw=72:
 125  */