libpurple/purple-gio.h

   1 /*
   2  *
   3  * purple
   4  *
   5  * Purple is the legal property of its developers, whose names are too numerous
   6  * to list here.  Please refer to the COPYRIGHT file distributed with this
   7  * source distribution.
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  22  */
  23
  24 #ifndef _PURPLE_GIO_H
  25 #define _PURPLE_GIO_H
  26 /**
  27  * SECTION:purple-gio
  28  * @section_id: libpurple-purple-gio
  29  * @short_description: Gio helper functions
  30  * @title: Purple Gio API
  31  *
  32  * The Purple Gio API provides helper functions for Gio operations which
  33  * are commonly used within libpurple and its consumers. These contain
  34  * such functions as setting up connections and shutting them down
  35  * gracefully.
  36  */
  37
  38 #include "account.h"
  39
  40 #include <gio/gio.h>
  41
  42 G_BEGIN_DECLS
  43
  44 /**
  45  * purple_gio_graceful_close:
  46  * @stream: A #GIOStream to close
  47  * @input: (nullable): A #GInputStream which wraps @stream's input stream
  48  * @output: (nullable): A #GOutputStream which wraps @stream's output stream
  49  *
  50  * Closes @input, @output, @stream. If there are pending operations, it
  51  * asynchronously waits for the operations to finish before closing the
  52  * arguments. Ensure the Gio callbacks can safely handle this being done
  53  * asynchronously.
  54  */
  55 void
  56 purple_gio_graceful_close(GIOStream *stream,
  57                 GInputStream *input, GOutputStream *output);
  58
  59 /**
  60  * purple_gio_socket_client_new:
  61  * @account: The #PurpleAccount to use for this connection
  62  * @error: Return location for a GError, or NULL
  63  *
  64  * A helper function to simplify creating a #GSocketClient. It's intended
  65  * to be used in protocol plugins.
  66  *
  67  * Returns: (transfer full): A new #GSocketClient with the appropriate
  68  * GProxyResolver, based on the #PurpleAccount settings and
  69  * TLS Certificate handling, or NULL if an error occurred.
  70  */
  71 GSocketClient *
  72 purple_gio_socket_client_new(PurpleAccount *account, GError **error);
  73
  74 G_END_DECLS
  75
  76 #endif /* _PURPLE_GIO_H */