view libpurple/protocols/msn/transaction.h @ 31157:b5793b417705

Remove deprecated (since MSNP13) commands and relevant files.

/**
 * @file transaction.h MSN transaction functions
 *
 * 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_TRANSACTION_H
#define MSN_TRANSACTION_H

typedef struct _MsnTransaction MsnTransaction;

#include "cmdproc.h"
#include "command.h"

typedef void (*MsnTransCb)(MsnCmdProc *cmdproc, MsnCommand *cmd);
typedef void (*MsnTimeoutCb)(MsnCmdProc *cmdproc, MsnTransaction *trans);
typedef void (*MsnErrorCb)(MsnCmdProc *cmdproc, MsnTransaction *trans,
						   int error);

/**
 * A transaction. A sending command that will initiate the transaction.
 */
struct _MsnTransaction
{
	MsnCmdProc *cmdproc;

	gboolean saveable;	/**< Whether to save this transaction in the history */
	unsigned int trId;	/**< The ID of this transaction, if it's being saved */

	char *command;
	char *params;

	guint timer;

	void *data; /**< The data to be used on the different callbacks. */
	GDestroyNotify data_free;  /**< The function to free 'data', or @c NULL */

	GHashTable *callbacks;
	gboolean has_custom_callbacks;
	MsnErrorCb error_cb;
	MsnTimeoutCb timeout_cb;

	char *payload;
	size_t payload_len;

	GQueue *queue;
	MsnCommand *pendent_cmd; /**< The command that is waiting for the result of
							   this transaction. */
};

MsnTransaction *msn_transaction_new(MsnCmdProc *cmdproc, const char *command,
	const char *format, ...) G_GNUC_PRINTF(3, 4);
void msn_transaction_destroy(MsnTransaction *trans);

char *msn_transaction_to_string(MsnTransaction *trans);
void msn_transaction_queue_cmd(MsnTransaction *trans, MsnCommand *cmd);
void msn_transaction_unqueue_cmd(MsnTransaction *trans, MsnCmdProc *cmdproc);
void msn_transaction_set_payload(MsnTransaction *trans,
								 const char *payload, int payload_len);
void msn_transaction_set_data(MsnTransaction *trans, void *data);
void msn_transaction_set_data_free(MsnTransaction *trans, GDestroyNotify fn);
void msn_transaction_set_saveable(MsnTransaction  *trans, gboolean saveable);
void msn_transaction_add_cb(MsnTransaction *trans, char *answer,
							MsnTransCb cb);
void msn_transaction_set_error_cb(MsnTransaction *trans, MsnErrorCb cb);
void msn_transaction_set_timeout_cb(MsnTransaction *trans, MsnTimeoutCb cb);

#endif /* MSN_TRANSACTION_H */