src/core/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 /*
  24  * Interface dependencies:
  25  *
  26  * <glib.h>
  27  */
  28
  29 /* Forward declarations */
  30 struct sipmsg;
  31
  32 /* Helper macros to iterate over dialog list in a SIP session */
  33 #define SIPE_DIALOG_FOREACH {                            \
  34         GSList *entry = session->dialogs;                \
  35         while (entry) {                                  \
  36                 struct sip_dialog *dialog = entry->data; \
  37                 entry = entry->next;
  38 #define SIPE_DIALOG_FOREACH_END }}
  39
  40 /* dialog is the new term for call-leg */
  41 struct sip_dialog {
  42         gchar *with; /* URI */
  43         gchar *endpoint_GUID;
  44         /**
  45          *  >0 - pro
  46          *  <0 - contra
  47          *   0 - didn't participate
  48          */
  49         int election_vote;
  50         gchar *ourtag;
  51         gchar *theirtag;
  52         gchar *theirepid;
  53         gchar *callid;
  54         GSList *routes;
  55         gchar *request;
  56         GSList *supported; /* counterparty capabilities */
  57         int cseq;
  58         /** corresponds to Session-Expires SIP header value */
  59         int expires;
  60         gboolean is_established;
  61         struct transaction *outgoing_invite;
  62 };
  63
  64 /* RFC3265 subscription */
  65 struct sip_subscription {
  66         struct sip_dialog dialog;
  67         gchar *event;
  68 };
  69
  70 /* Forward declaration */
  71 struct sip_session;
  72
  73 /**
  74  * Free dialog structure
  75  *
  76  * @param dialog (in) Dialog to be freed. May be NULL.
  77  */
  78 void sipe_dialog_free(struct sip_dialog *dialog);
  79
  80 /**
  81  * Free subscription structure
  82  *
  83  * @param subscription (in) Subscription to be freed. May be NULL.
  84  */
  85 void sipe_subscription_free(struct sip_subscription *subscription);
  86
  87 /**
  88  * Add a new, empty dialog to a session
  89  *
  90  * @param session (in)
  91  *
  92  * @return dialog the new dialog structure
  93  */
  94 struct sip_dialog *sipe_dialog_add(struct sip_session *session);
  95
  96 /**
  97  * Find a dialog in a session
  98  *
  99  * @param session (in) may be NULL
 100  * @param who (in) dialog identifier. May be NULL
 101  *
 102  * @return dialog the requested dialog or NULL
 103  */
 104 struct sip_dialog *sipe_dialog_find(struct sip_session *session,
 105                                     const gchar *who);
 106
 107 /**
 108  * Remove a dialog from a session
 109  *
 110  * @param session (in) may be NULL
 111  * @param who (in) dialog identifier. May be NULL
 112  */
 113 void sipe_dialog_remove(struct sip_session *session, const gchar *who);
 114
 115 /**
 116  * Remove a dialog from a session
 117  *
 118  * @param session (in) may be NULL
 119  * @param dialog (in) dialog identifier. Should contain Call-ID, to-tag and from-tag
 120  *                    to unambiguously identify dialog. May be NULL
 121  */
 122 void
 123 sipe_dialog_remove_3(struct sip_session *session,
 124                      struct sip_dialog *dialog_in);
 125
 126 /**
 127  * Remove all dialogs from a session
 128  *
 129  * @param session (in)
 130  */
 131 void sipe_dialog_remove_all(struct sip_session *session);
 132
 133 /**
 134  * Does a session have any dialogs?
 135  *
 136  * @param session (in)
 137  */
 138 #define sipe_dialog_any(session) (session->dialogs != NULL)
 139
 140 /**
 141  * Return first dialog of a session
 142  *
 143  * @param session (in)
 144  */
 145 #define sipe_dialog_first(session) ((struct sip_dialog *)session->dialogs->data)
 146
 147 /**
 148  * Update routes in a dialog from a message
 149  *
 150  * @param dialog   (in,out) dialog to fill
 151  * @param msg      (in)     mesage
 152  * @param outgoing (in)     outgoing or incoming message
 153  */
 154 void sipe_dialog_parse_routes(struct sip_dialog *dialog,
 155                               const struct sipmsg *msg,
 156                               gboolean outgoing);
 157
 158 /**
 159  * Fill dialog structure from SIP message
 160  *
 161  * @param dialog   (in,out) dialog to fill
 162  * @param msg      (in)     mesage
 163  * @param outgoing (in)     outgoing or incoming message
 164  */
 165 void sipe_dialog_parse(struct sip_dialog *dialog,
 166                        const struct sipmsg *msg,
 167                        gboolean outgoing);