src/core/sipe-session.h

   1 /**
   2  * @file sipe-sesion.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 sipe_core_private;
  31 struct sipe_chat_session;
  32
  33 /* Helper macros to iterate over session list in a SIP account */
  34 #define SIPE_SESSION_FOREACH {                             \
  35         GSList *entry = sipe_private->sessions;                    \
  36         while (entry) {                                    \
  37                 struct sip_session *session = entry->data; \
  38                 entry = entry->next;
  39 #define SIPE_SESSION_FOREACH_END }}
  40
  41 /** Correspond to multi-party conversation */
  42 struct sip_session {
  43         /** chat session */
  44         struct sipe_chat_session *chat_session;
  45
  46         gchar *with; /* For IM or call sessions only (not multi-party) . A URI.*/
  47         /** key is user (URI) */
  48         GSList *dialogs;
  49         /** Key is <Call-ID><CSeq><METHOD><To> */
  50         GHashTable *unconfirmed_messages;
  51         GSList *outgoing_message_queue;
  52
  53         /*
  54          * Multiparty conversation related fields
  55          */
  56         /** Call-Id identifying the conversation */
  57         gchar *callid; /* For multiparty conversations */
  58         int bid;
  59         gboolean is_voting_in_progress;
  60         GSList *pending_invite_queue;
  61
  62         /*
  63          * Conference related fields
  64          */
  65         gchar *im_mcu_uri;
  66         gchar *subject;
  67         gboolean locked;
  68         struct sip_dialog *focus_dialog;
  69         /** Key is Message-Id */
  70         GHashTable *conf_unconfirmed_messages;
  71         gchar *audio_video_entity;
  72         guint audio_media_id;
  73
  74         /*
  75          * Media call related fields
  76          */
  77         gboolean is_call;
  78
  79         /*
  80          * Group Chat related fields
  81          */
  82         gboolean is_groupchat;
  83 };
  84
  85 /**
  86  * An item in outgoing message queue.
  87  *
  88  * Messages are put in the queue until a response to initial INVITE is received
  89  * from remote dialog participant.
  90  */
  91 struct queued_message {
  92         /** Body of the message. */
  93         gchar *body;
  94         /**
  95          * Content type of message body, e.g. text/plain for chat messages,
  96          * text/x-msmsgsinvite for filetransfer initialization. Setting this to NULL
  97          * means default value text/plain.
  98          */
  99         gchar *content_type;
 100         guint cseq;
 101 };
 102
 103 /**
 104  * Add a new chat session
 105  *
 106  * @param sipe_private (in) SIPE core data. May be NULL
 107  * @param chat_session (in) non-NULL to rejoin existing chat
 108  * @param multiparty   (in) multiparty or conference
 109  * @param id           (in) new chat session identifier (ignored for rejoin).
 110  *
 111  * @return pointer to new session
 112  */
 113 struct sip_session *
 114 sipe_session_add_chat(struct sipe_core_private *sipe_private,
 115                       struct sipe_chat_session *chat_session,
 116                       gboolean multiparty,
 117                       const gchar *id);
 118
 119 #ifdef HAVE_VV
 120
 121 /**
 122  * Add a new media call session
 123  *
 124  * @param sipe_private (in) SIPE core data.
 125  * @param who (in) remote partner.
 126  *
 127  * @return pointer to new session
 128  */
 129 struct sip_session *
 130 sipe_session_add_call(struct sipe_core_private *sipe_private,
 131                       const gchar *who);
 132
 133 #endif
 134
 135 /**
 136  * Find chat session
 137  *
 138  * @param sipe_private (in) SIPE core data. May be NULL
 139  * @param chat_session (in) chat session data. May be NULL
 140  *
 141  * @return pointer to session or NULL
 142  */
 143 struct sip_session *
 144 sipe_session_find_chat(struct sipe_core_private *sipe_private,
 145                        struct sipe_chat_session *chat_session);
 146
 147 /**
 148  * Find chat session by Call ID
 149  *
 150  * @param sipe_private (in) SIPE core data. May be NULL
 151  * @param callid (in) Call ID. May be NULL
 152  *
 153  * @return pointer to session or NULL
 154  */
 155 struct sip_session *
 156 sipe_session_find_chat_by_callid(struct sipe_core_private *sipe_private,
 157                                  const gchar *callid);
 158
 159 /**
 160  * Find Conference session
 161  *
 162  * @param sipe_private (in) SIPE core data. May be NULL
 163  * @param focus_uri (in) URI of conference focus. May be NULL
 164  *
 165  * @return pointer to session or NULL
 166  */
 167 struct sip_session *
 168 sipe_session_find_conference(struct sipe_core_private *sipe_private,
 169                              const gchar *focus_uri);
 170
 171 /**
 172  * Find IM session
 173  *
 174  * @param sipe_private (in) SIPE core data. May be NULL
 175  * @param who (in) remote partner. May be NULL
 176  *
 177  * @return pointer to session or NULL
 178  */
 179 struct sip_session *
 180 sipe_session_find_im(struct sipe_core_private *sipe_private,
 181                      const gchar *who);
 182
 183 /**
 184  * Find or add new IM session
 185  *
 186  * @param sipe_private (in) SIPE core data
 187  * @param who (in) remote partner
 188  *
 189  * @return pointer to session
 190  */
 191 struct sip_session *
 192 sipe_session_find_or_add_im(struct sipe_core_private *sipe_private,
 193                             const gchar *who);
 194
 195 /**
 196  * Find Chat by Call ID or IM session
 197  *
 198  * @param sipe_private (in) SIPE core data. May be NULL
 199  * @param callid (in) Call ID. May be NULL
 200  * @param who (in) remote partner. May be NULL
 201  *
 202  * @return pointer to session or NULL
 203  */
 204 struct sip_session *
 205 sipe_session_find_chat_or_im(struct sipe_core_private *sipe_private,
 206                              const gchar *callid,
 207                              const gchar *who);
 208
 209 /**
 210  * Close a session
 211  *
 212  * @param sipe_private (in) SIPE core data
 213  * @param session (in) pointer to session
 214  */
 215 void
 216 sipe_session_close(struct sipe_core_private *sipe_private,
 217                    struct sip_session *session);
 218
 219 /**
 220  * Remove a session from a SIP account
 221  *
 222  * @param sipe_private (in) SIPE core data
 223  * @param session (in) pointer to session
 224  */
 225 void
 226 sipe_session_remove(struct sipe_core_private *sipe_private,
 227                     struct sip_session *session);
 228
 229 /**
 230  * Add a message to outgoing queue.
 231  *
 232  * @param session (in) SIP session
 233  * @param body (in) message to send
 234  * @param content_type (in) content type of the message body
 235  */
 236 void
 237 sipe_session_enqueue_message(struct sip_session *session,
 238                              const gchar *body, const gchar *content_type);
 239
 240 /**
 241  * Removes and deallocates the first item in outgoing message queue.
 242  *
 243  * @param session (in) SIP session
 244  *
 245  * @return pointer to new message queue head
 246  */
 247 GSList *
 248 sipe_session_dequeue_message(struct sip_session *session);