src/core/sipe-dialog.h

   1 /**
   2  * @file sipe-dialog.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2009-11 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         GSList *filetransfers;
  58         int cseq;
  59         /** corresponds to Session-Expires SIP header value */
  60         int expires;
  61         gboolean is_established;
  62         struct transaction *outgoing_invite;
  63 };
  64
  65 /* Forward declaration */
  66 struct sip_session;
  67
  68 /**
  69  * Free dialog structure
  70  *
  71  * @param dialog (in) Dialog to be freed. May be NULL.
  72  */
  73 void sipe_dialog_free(struct sip_dialog *dialog);
  74
  75 /**
  76  * Add a new, empty dialog to a session
  77  *
  78  * @param session (in)
  79  *
  80  * @return dialog the new dialog structure
  81  */
  82 struct sip_dialog *sipe_dialog_add(struct sip_session *session);
  83
  84 /**
  85  * Find a dialog in a session
  86  *
  87  * @param session (in) may be NULL
  88  * @param who (in) dialog identifier. May be NULL
  89  *
  90  * @return dialog the requested dialog or NULL
  91  */
  92 struct sip_dialog *sipe_dialog_find(struct sip_session *session,
  93                                     const gchar *who);
  94
  95 /**
  96  * Remove a dialog from a session
  97  *
  98  * @param session (in) may be NULL
  99  * @param who (in) dialog identifier. May be NULL
 100  */
 101 void sipe_dialog_remove(struct sip_session *session, const gchar *who);
 102
 103 /**
 104  * Remove a dialog from a session
 105  *
 106  * @param session (in) may be NULL
 107  * @param dialog (in) dialog identifier. Should contain Call-ID, to-tag and from-tag
 108  *                    to unambiguously identify dialog. May be NULL
 109  */
 110 void
 111 sipe_dialog_remove_3(struct sip_session *session,
 112                      struct sip_dialog *dialog_in);
 113
 114 /**
 115  * Remove all dialogs from a session
 116  *
 117  * @param session (in)
 118  */
 119 void sipe_dialog_remove_all(struct sip_session *session);
 120
 121 /**
 122  * Does a session have any dialogs?
 123  *
 124  * @param session (in)
 125  */
 126 #define sipe_dialog_any(session) (session->dialogs != NULL)
 127
 128 /**
 129  * Return first dialog of a session
 130  *
 131  * @param session (in)
 132  */
 133 #define sipe_dialog_first(session) ((struct sip_dialog *)session->dialogs->data)
 134
 135 /**
 136  * Fill dialog structure from SIP message
 137  *
 138  * @param dialog   (in,out) dialog to fill
 139  * @param msg      (in)     mesage
 140  * @param outgoing (in)     outgoing or incoming message
 141  */
 142 void sipe_dialog_parse(struct sip_dialog *dialog,
 143                        const struct sipmsg *msg,
 144                        gboolean outgoing);