annotate libpurple/protocols/msn/slplink.h @ 23671:96e78c0fa32b

Get rid of MsnSlpSession entirely. It only seems to link to MsnSlpCall and then copy some data from it. Fixes #1671.

/**
 * @file slplink.h MSNSLP Link support
 *
 * purple
 *
 * Purple 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 _MSN_SLPLINK_H_
#define _MSN_SLPLINK_H_

typedef struct _MsnSlpLink MsnSlpLink;

#include "directconn.h"
#include "slpcall.h"
#include "slpmsg.h"

#include "switchboard.h"

#include "ft.h"

#include "session.h"

typedef void (*MsnSlpCb)(MsnSlpCall *slpcall,
						 const guchar *data, gsize size);
typedef void (*MsnSlpEndCb)(MsnSlpCall *slpcall, MsnSession *session);

struct _MsnSlpLink
{
	MsnSession *session;
	MsnSwitchBoard *swboard;

	char *local_user;
	char *remote_user;

	int slp_seq_id;

	MsnDirectConn *directconn;

	GList *slp_calls;
	GList *slp_msgs;

	GQueue *slp_msg_queue;
};

void msn_slplink_destroy(MsnSlpLink *slplink);

/**
 * @return An MsnSlpLink for the given user, or NULL if there is no
 *         existing MsnSlpLink.
 */
MsnSlpLink *msn_session_find_slplink(MsnSession *session,
									 const char *who);

/**
 * @return An MsnSlpLink for the given user.  One will be created if
 *         it does not already exist.
 */
MsnSlpLink *msn_session_get_slplink(MsnSession *session, const char *username);

void msn_slplink_add_slpcall(MsnSlpLink *slplink, MsnSlpCall *slpcall);
void msn_slplink_remove_slpcall(MsnSlpLink *slplink, MsnSlpCall *slpcall);
MsnSlpCall *msn_slplink_find_slp_call(MsnSlpLink *slplink,
									  const char *id);
MsnSlpCall *msn_slplink_find_slp_call_with_session_id(MsnSlpLink *slplink, long id);
void msn_slplink_send_msg(MsnSlpLink *slplink, MsnMessage *msg);
void msn_slplink_release_slpmsg(MsnSlpLink *slplink,
								MsnSlpMessage *slpmsg);
void msn_slplink_queue_slpmsg(MsnSlpLink *slplink, MsnSlpMessage *slpmsg);
void msn_slplink_send_slpmsg(MsnSlpLink *slplink,
							 MsnSlpMessage *slpmsg);
void msn_slplink_unleash(MsnSlpLink *slplink);
void msn_slplink_send_ack(MsnSlpLink *slplink, MsnMessage *msg);
void msn_slplink_process_msg(MsnSlpLink *slplink, MsnMessage *msg);
MsnSlpMessage *msn_slplink_message_find(MsnSlpLink *slplink, long session_id, long id);
void msn_slplink_append_slp_msg(MsnSlpLink *slplink, MsnSlpMessage *slpmsg);
void msn_slplink_remove_slp_msg(MsnSlpLink *slplink,
								MsnSlpMessage *slpmsg);
void msn_slplink_request_ft(MsnSlpLink *slplink, PurpleXfer *xfer);

void msn_slplink_request_object(MsnSlpLink *slplink,
								const char *info,
								MsnSlpCb cb,
								MsnSlpEndCb end_cb,
								const MsnObject *obj);

MsnSlpCall *msn_slp_process_msg(MsnSlpLink *slplink, MsnSlpMessage *slpmsg);

#endif /* _MSN_SLPLINK_H_ */