src/core/sipe-lync-autodiscover.h

   1 /**
   2  * @file sipe-lync-autodiscover.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2016 SIPE Project <http://sipe.sourceforge.net/>
   7  *
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24 /* Forward declarations */
  25 struct sipe_core_private;
  26
  27 /* Lync data determined by autodiscover */
  28 struct sipe_lync_autodiscover_data {
  29     const gchar *server;
  30     guint        port;
  31 };
  32
  33 /**
  34  * Lync autodiscover callback
  35  *
  36  * @param sipe_private  SIPE core private data
  37  * @param servers       list with Lync autodiscover data
  38  * @param callback_data callback data
  39  *
  40  * servers will be @c NULL when request got aborted.
  41  * last entry in the list will be a @c NULL entry.
  42  */
  43 typedef void (sipe_lync_autodiscover_callback)(struct sipe_core_private *sipe_private,
  44                                                GSList *servers,
  45                                                gpointer callback_data);
  46
  47 /**
  48  * Free first callback data entry on the server list
  49  *
  50  * @param servers list given to callback (may be @c NULL)
  51  *
  52  * @return new list header
  53  */
  54 GSList *sipe_lync_autodiscover_pop(GSList *servers);
  55
  56 /**
  57  * Trigger Lync autodiscover
  58  *
  59  * @param sipe_private  SIPE core private data
  60  * @param callback      callback function
  61  * @param callback_data callback data
  62  */
  63 void sipe_lync_autodiscover_start(struct sipe_core_private *sipe_private,
  64                                   sipe_lync_autodiscover_callback *callback,
  65                                   gpointer callback_data);
  66
  67 /**
  68  * Initialize Lync autodiscover data
  69  *
  70  * @param sipe_private SIPE core private data
  71  */
  72 void sipe_lync_autodiscover_init(struct sipe_core_private *sipe_private);
  73
  74 /**
  75  * Free Lync autodiscover data
  76  *
  77  * @param sipe_private SIPE core private data
  78  */
  79 void sipe_lync_autodiscover_free(struct sipe_core_private *sipe_private);