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  * Creates conference.
  30  */
  31 void
  32 sipe_conf_add(struct sipe_core_private *sipe_private,
  33               const gchar* who);
  34
  35 /**
  36  * Processes incoming INVITE with
  37  * Content-Type: application/ms-conf-invite+xml
  38  * i.e. invitation to join conference.
  39  *
  40  * Server 2007+ functionality.
  41  */
  42 void
  43 process_incoming_invite_conf(struct sipe_core_private *sipe_private,
  44                              struct sipmsg *msg);
  45
  46 /**
  47  * Create new session with Focus URI
  48  *
  49  * @param chat_session non-NULL if we rejoin a conference
  50  * @param focus_uri    non-NULL if we create a new conference
  51  *
  52  * @return new SIP session
  53  */
  54 struct sip_session *
  55 sipe_conf_create(struct sipe_core_private *sipe_private,
  56                  struct sipe_chat_session *chat_session,
  57                  const gchar *focus_uri);
  58
  59 /**
  60  * Process of conference state
  61  * Content-Type: application/conference-info+xml
  62  */
  63 void
  64 sipe_process_conference(struct sipe_core_private *sipe_private,
  65                         struct sipmsg * msg);
  66
  67 /**
  68  * Invites counterparty to join conference.
  69  */
  70 void
  71 sipe_invite_conf(struct sipe_core_private *sipe_private,
  72                  struct sip_session *session,
  73                  const gchar* who);
  74
  75 /**
  76  * Modify User Role.
  77  * Sends request to Focus.
  78  * INFO method is a carrier of application/cccp+xml
  79  */
  80 void
  81 sipe_conf_modify_user_role(struct sipe_core_private *sipe_private,
  82                            struct sip_session *session,
  83                            const gchar* who);
  84
  85 /**
  86  * Ejects user from conference.
  87  * Sends request to Focus.
  88  * INFO method is a carrier of application/cccp+xml
  89  */
  90 void
  91 sipe_conf_delete_user(struct sipe_core_private *sipe_private,
  92                       struct sip_session *session,
  93                       const gchar* who);
  94
  95 /**
  96  * Invokes when we are ejected from conference
  97  * for example or conference has been timed out.
  98  */
  99 void
 100 sipe_conf_immcu_closed(struct sipe_core_private *sipe_private,
 101                        struct sip_session *session);
 102
 103 /**
 104  * Removes a session waiting to be accepted or declined by the user.
 105  *
 106  * @param sipe_private SIPE core data
 107  * @param msg SIP CANCEL message. If NULL is passed, all sessions not accepted
 108  *            will be canceled
 109  */
 110 void
 111 sipe_conf_cancel_unaccepted(struct sipe_core_private *sipe_private,
 112                             struct sipmsg *msg);
 113
 114 /**
 115  * Invokes when we leave conversation.
 116  * Usually by closing chat wingow.
 117  */
 118 void
 119 conf_session_close(struct sipe_core_private *sipe_private,
 120                    struct sip_session *session);
 121
 122 /**
 123  * Invoked to process message delivery notification
 124  * in conference.
 125  */
 126 void
 127 sipe_process_imdn(struct sipe_core_private *sipe_private,
 128                   struct sipmsg *msg);