finch/gntsound.h

Mon, 12 Sep 2016 08:55:35 -0500

author
Mike Ruprecht <cmaiku@gmail.com>
date
Mon, 12 Sep 2016 08:55:35 -0500
changeset 38142
1dff6e343f9f
parent 37100
a243a5e7afb3
child 39885
b1b266896ec1
permissions
-rw-r--r--

gg: Protect against issues when closing while connecting

Since the GIOStream is cancelled when data is freed, any cancelled
callbacks are called after such data is freed. This patch guards against
cancelled calls by safely returning without accessing any freed data if
the connection has been cancelled (aka closed).

Futhermore, if GG tries to connect and is quickly disconnected,
ggp_tcpsocket_close() is never called. As far as I can tell, it's an
existing bug, but PurpleSockets both work differently when closing and
are closed by the connection if any leak. So the issue wasn't a major
problem. This patch lessens the issue by guarding against it, but it
should be fixed at some point.

/* finch
 *
 * Finch is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 */

#ifndef _GNT_SOUND_H
#define _GNT_SOUND_H
/**
 * SECTION:gntsound
 * @section_id: finch-gntsound
 * @short_description: <filename>gntsound.h</filename>
 * @title: Sound API
 */

#include "sound.h"

/**********************************************************************/
/* GNT Sound API                                                      */
/**********************************************************************/

/**
 * finch_sound_get_active_profile:
 *
 * Get the name of the active sound profile.
 *
 * Returns: The name of the profile
 */
const char *finch_sound_get_active_profile(void);

/**
 * finch_sound_set_active_profile:
 * @name:  The name of the profile
 *
 * Set the active profile.  If the profile doesn't exist, nothing is changed.
 */
void finch_sound_set_active_profile(const char *name);

/**
 * finch_sound_get_profiles:
 *
 * Get a list of available sound profiles.
 *
 * Returns: (transfer container) (element-type utf8): A list of strings
 *          denoting sound profile names. Caller must free the list
 *          (but not the data).
 */
GList *finch_sound_get_profiles(void);

/**
 * finch_sound_is_enabled:
 *
 * Determine whether any sound will be played or not.
 *
 * Returns: Returns FALSE if preference is set to 'No sound', or if volume is
 *         set to zero.
 */
gboolean finch_sound_is_enabled(void);

/**
 * finch_sound_get_ui_ops:
 *
 * Gets GNT sound UI ops.
 *
 * Returns: The UI operations structure.
 */
PurpleSoundUiOps *finch_sound_get_ui_ops(void);

/**
 * finch_sounds_show_all:
 *
 * Show the sound settings dialog.
 */
void finch_sounds_show_all(void);

#endif

mercurial