Mercurial > pidgin.yaz
view src/upnp.h @ 11719:109ee3bfeac5
[gaim-migrate @ 14010]
SF Patch #1333770 from corfe83
"Many times in gaim we use the function
g_slist_remove(list,node->data) to remove an element
from a GSList. If we already have the pointer to the
node we want to delete, it is faster to send it the
pointer to the node to delete rather than the data of
the node (we can do this by calling
g_slist_delete_link(list,node)). This change was made
while looking at glib's documentation and the code in
glib's gslist.c.
This is because as the remove/delete function traverses
each node in the list, it doesn't need to spend an
extra memory access to retrieve the data for each
element in the node it is traversing and then compare,
it can simply compare the pointer. In my tests outside
of gaim, this makes a big difference if the node you
are deleting is at a high index in the list. However,
even if you're deleting the first node, it about breaks
even.
So, I've found each case in gaim where we are calling
g_slist_remove, and we already have the pointer to the
appropriate node to delete (this is often the case when
we're doing a for or while loop on a GSList). I've then
replaced it with the appropriate call to
g_slist_delete_link. I, however, didn't do this in
situations where we are explicitly removing the first
element in the list, because in those situations it is
an unnecessary change.
There should be no difference in behavior, but just in
case I've tried running it with valgrind, which reports
the same number of memory leaks after my patch as
before my patch. Of course, I can't guarantee that my
normal behavior on gaim is hitting all the functions
I've changed, but in general testing it Works For Me (tm)."
As with the last patch, this one may not have a practical performance impact (or maybe it does, I have no idea), but it's not worse for any case. Given two ways of doing things where one is always at least as fast and may be faster under some cases, I like to prefer that faster way. This doesn't make the code any uglier, so I'm applying.
committer: Tailor Script <tailor@pidgin.im>
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Sat, 22 Oct 2005 20:48:18 +0000 |
parents | 9563b768e8e2 |
children | 8e3b85fe4a55 |
line wrap: on
line source
/** * @file upnp.h Universal Plug N Play API * @ingroup core * * gaim * * Gaim 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _GAIM_UPNP_H_ #define _GAIM_UPNP_H_ typedef struct { gchar* controlURL; gchar* serviceType; } GaimUPnPControlInfo; #ifdef __cplusplus extern "C" { #endif /**************************************************************************/ /** @name UPnP API */ /**************************************************************************/ /*@{*/ /** * Sends a discovery request to search for a UPnP enabled IGD that * contains the WANIPConnection service that will allow us to recieve the * public IP address of the IGD, and control it for forwarding ports. * * @return The control URL for the IGD we'll use to use the IGD services */ GaimUPnPControlInfo* gaim_upnp_discover(void); /** * Gets the IP address from a UPnP enabled IGD that sits on the local * network, so when getting the network IP, instead of returning the * local network IP, the public IP is retrieved. * * @param controlInfo The control URL retrieved from gaim_upnp_discover. * * @return The IP address of the network, or NULL if something went wrong */ gchar* gaim_upnp_get_public_ip(const GaimUPnPControlInfo* controlInfo); /** * Maps Ports in a UPnP enabled IGD that sits on the local network to * this gaim client. Essentially, this function takes care of the port * forwarding so things like file transfers can work behind NAT firewalls * * @param controlInfo The control URL retrieved from gaim_upnp_discover. * @param portMap The port to map to this client * @param protocol The protocol to map, either "TCP" or "UDP" * * @return TRUE if success, FALSE if something went wrong. */ gboolean gaim_upnp_set_port_mapping(const GaimUPnPControlInfo* controlInfo, unsigned short portMap, const gchar* protocol); /** * Deletes a port mapping in a UPnP enabled IGD that sits on the local network * to this gaim client. Essentially, this function takes care of deleting the * port forwarding after they have completed a connection so another client on * the local network can take advantage of the port forwarding * * @param controlInfo The control URL retrieved from gaim_upnp_discover. * @param portMap The port to delete the mapping for * @param protocol The protocol to map to. Either "TCP" or "UDP" * * @return TRUE if success, FALSE if something went wrong. */ gboolean gaim_upnp_remove_port_mapping(const GaimUPnPControlInfo* controlInfo, unsigned short portMap, const gchar* protocol); /*@}*/ #ifdef __cplusplus } #endif #endif /* _GAIM_UPNP_H_ */