src/core/sipe-conf.h

   1 /**
   2  * @file sipe-conf.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2009-10 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 /* Forward declarations */
  24 struct sipmsg;
  25 struct sip_session;
  26 struct sipe_core_private;
  27
  28 /**
  29  * Obtains conferencing capabilities enabled on the server.
  30  *
  31  * @param sipe_private SIPE core data
  32  */
  33 void
  34 sipe_conf_get_capabilities(struct sipe_core_private *sipe_private);
  35
  36 /**
  37  * Checks whether given Multipoint Control Unit type is supported by the server.
  38  */
  39 gboolean
  40 sipe_conf_supports_mcu_type(struct sipe_core_private *sipe_private,
  41                             const gchar *type);
  42
  43 /**
  44  * Creates conference.
  45  */
  46 void
  47 sipe_conf_add(struct sipe_core_private *sipe_private,
  48               const gchar* who);
  49
  50 /**
  51  * Processes incoming INVITE with
  52  * Content-Type: application/ms-conf-invite+xml
  53  * i.e. invitation to join conference.
  54  *
  55  * Server 2007+ functionality.
  56  */
  57 void
  58 process_incoming_invite_conf(struct sipe_core_private *sipe_private,
  59                              struct sipmsg *msg);
  60
  61 /**
  62  * Create new session with Focus URI
  63  *
  64  * @param chat_session non-NULL if we rejoin a conference
  65  * @param focus_uri    non-NULL if we create a new conference
  66  *
  67  * @return new SIP session
  68  */
  69 struct sip_session *
  70 sipe_conf_create(struct sipe_core_private *sipe_private,
  71                  struct sipe_chat_session *chat_session,
  72                  const gchar *focus_uri);
  73
  74 /**
  75  * Process of conference state
  76  * Content-Type: application/conference-info+xml
  77  */
  78 void
  79 sipe_process_conference(struct sipe_core_private *sipe_private,
  80                         struct sipmsg * msg);
  81
  82 /**
  83  * Invites counterparty to join conference.
  84  */
  85 void
  86 sipe_invite_conf(struct sipe_core_private *sipe_private,
  87                  struct sip_session *session,
  88                  const gchar* who);
  89
  90 /**
  91  * Modify User Role.
  92  * Sends request to Focus.
  93  * INFO method is a carrier of application/cccp+xml
  94  */
  95 void
  96 sipe_conf_modify_user_role(struct sipe_core_private *sipe_private,
  97                            struct sip_session *session,
  98                            const gchar* who);
  99
 100 /**
 101  * Ejects user from conference.
 102  * Sends request to Focus.
 103  * INFO method is a carrier of application/cccp+xml
 104  */
 105 void
 106 sipe_conf_delete_user(struct sipe_core_private *sipe_private,
 107                       struct sip_session *session,
 108                       const gchar* who);
 109
 110 /**
 111  * Notifies conference call participants of our microphone mute state.
 112  */
 113 void
 114 sipe_conf_announce_audio_mute_state(struct sipe_core_private *sipe_private,
 115                                     struct sip_session *session,
 116                                     gboolean is_muted);
 117
 118 /**
 119  * Invokes when we are ejected from conference
 120  * for example or conference has been timed out.
 121  */
 122 void
 123 sipe_conf_immcu_closed(struct sipe_core_private *sipe_private,
 124                        struct sip_session *session);
 125
 126 /**
 127  * Removes a session waiting to be accepted or declined by the user.
 128  *
 129  * @param sipe_private SIPE core data
 130  * @param msg SIP CANCEL message. If NULL is passed, all sessions not accepted
 131  *            will be canceled
 132  */
 133 void
 134 sipe_conf_cancel_unaccepted(struct sipe_core_private *sipe_private,
 135                             struct sipmsg *msg);
 136
 137 /**
 138  * Creates URI for given session type within a conference specified by its
 139  * focus URI.
 140  *
 141  * @param focus_uri conference focus URI
 142  * @param session_type type of session for which to build the URI,
 143  *                     e.g. "audio-video"
 144  */
 145 gchar *
 146 sipe_conf_build_uri(const gchar *focus_uri, const gchar *session_type);
 147
 148 /**
 149  * Invokes when we leave conversation.
 150  * Usually by closing chat wingow.
 151  */
 152 void
 153 conf_session_close(struct sipe_core_private *sipe_private,
 154                    struct sip_session *session);
 155
 156 /**
 157  * Invoked to process message delivery notification
 158  * in conference.
 159  */
 160 void
 161 sipe_process_imdn(struct sipe_core_private *sipe_private,
 162                   struct sipmsg *msg);