src/core/sipe-ft.h

   1 /**
   2  * @file sipe-ft.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2010 SIPE Project <http://sipe.sourceforge.net/>
   7  * Copyright (C) 2010 Jakub Adam <jakub.adam@ktknet.cz>
   8  * Copyright (C) 2010 Tomáš Hrabčík <tomas.hrabcik@tieto.com>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  */
  24
  25 /* Forward declarations */
  26 struct sipe_core_private;
  27 struct sipe_file_transfer;
  28
  29
  30 /**
  31  * Deallocate file transfer data structure
  32  */
  33 void sipe_core_ft_deallocate(struct sipe_file_transfer *ft);
  34
  35 /**
  36  * Called when remote peer wants to send a file.
  37  *
  38  * Function initializes libpurple filetransfer API structure and calls
  39  * purple_xfer_request().
  40  *
  41  * @param sipe_private Sipe core private data
  42  * @param dialog       SIP dialog used for the file transfer
  43  * @param body         parsed SIP message body as name-value pairs
  44  */
  45 void sipe_ft_incoming_transfer(struct sipe_core_private *sipe_private,
  46                                struct sip_dialog *dialog,
  47                                const GSList *body);
  48
  49 /**
  50  * Handles incoming filetransfer message with ACCEPT invitation command.
  51  *
  52  * This message is sent during the negotiation phase when parameters of the
  53  * transfer like IP address or TCP port are going to be set up.
  54  *
  55  * @param dialog       SIP dialog used for the file transfer
  56  * @param body         parsed SIP message body as name-value pairs
  57  */
  58 void sipe_ft_incoming_accept(struct sip_dialog *dialog, const GSList *body);
  59
  60 /**
  61  * Called when remote peer cancels ongoing file transfer.
  62  *
  63  * Function dispatches the request to libpurple
  64  *
  65  * @param dialog       SIP dialog used for the file transfer
  66  * @param body         parsed SIP message body as name-value pairs
  67  */
  68 void sipe_ft_incoming_cancel(struct sip_dialog *dialog, const GSList *body);
  69
  70 /**
  71  * Parses file transfer message body and creates a list with name-value pairs
  72  *
  73  * @param body file transfer SIP message body
  74  *
  75  * @return GSList of name-value pairs parsed from message body, NULL if body has
  76  * incorrect format
  77  */
  78 GSList *sipe_ft_parse_msg_body(const gchar *body);