src/sipe-dialog.h

   1 /**
   2  * @file sipe-dialog.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2009 SIPE Project <http://sipe.sourceforge.net/>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 /* Helper macros to iterate over dialog list in a SIP session */
  24 #define SIPE_DIALOG_FOREACH {                            \
  25         GSList *entry = session->dialogs;                \
  26         while (entry) {                                  \
  27                 struct sip_dialog *dialog = entry->data; \
  28                 entry = entry->next;
  29 #define SIPE_DIALOG_FOREACH_END }}
  30
  31 /* dialog is the new term for call-leg */
  32 struct sip_dialog {
  33         gchar *with; /* URI */
  34         gchar *endpoint_GUID;
  35         /**
  36          *  >0 - pro
  37          *  <0 - contra
  38          *   0 - didn't participate
  39          */
  40         int election_vote;
  41         gchar *ourtag;
  42         gchar *theirtag;
  43         gchar *theirepid;
  44         gchar *callid;
  45         GSList *routes;
  46         gchar *request;
  47         GSList *supported; /* counterparty capabilities */
  48         int cseq;
  49         gboolean is_established;
  50         struct transaction *outgoing_invite;
  51 };
  52
  53 /* Forward declaration */
  54 struct sip_session;
  55
  56 /**
  57  * Free dialog structure
  58  *
  59  * @param dialog (in) Dialog to be freed. May be NULL.
  60  */
  61 void sipe_dialog_free(struct sip_dialog *dialog);
  62
  63 /**
  64  * Add a new, empty dialog to a session
  65  *
  66  * @param session (in)
  67  *
  68  * @return dialog the new dialog structure
  69  */
  70 struct sip_dialog *sipe_dialog_add(struct sip_session *session);
  71
  72 /**
  73  * Find a dialog in a session
  74  *
  75  * @param session (in) may be NULL
  76  * @param who (in) dialog identifier. May be NULL
  77  *
  78  * @return dialog the requested dialog or NULL
  79  */
  80 struct sip_dialog *sipe_dialog_find(struct sip_session *session,
  81                                     const gchar *who);
  82
  83 /**
  84  * Remove a dialog from a session
  85  *
  86  * @param session (in) may be NULL
  87  * @param who (in) dialog identifier. May be NULL
  88  */
  89 void sipe_dialog_remove(struct sip_session *session, const gchar *who);
  90
  91 /**
  92  * Remove all dialogs frome a session
  93  *
  94  * @param session (in)
  95  */
  96 void sipe_dialog_remove_all(struct sip_session *session);
  97
  98 /**
  99  * Does a session have any dialogs?
 100  *
 101  * @param session (in)
 102  */
 103 #define sipe_dialog_any(session) (session->dialogs != NULL)
 104
 105 /**
 106  * Return first dialog of a session
 107  *
 108  * @param session (in)
 109  */
 110 #define sipe_dialog_first(session) ((struct sip_dialog *)session->dialogs->data)
 111
 112 /**
 113  * Fill dialog structure from SIP message
 114  *
 115  * @param msg      (in)     mesage
 116  * @param dialog   (in,out) dialog to fill
 117  * @param outgoing (in)     outgoing or incoming message
 118  */
 119 void sipe_dialog_parse(struct sip_dialog *dialog,
 120                        const struct sipmsg *msg,
 121                        gboolean outgoing);