Frameworks/libpurple.framework/Versions/0.6.2/Headers/transaction.h
author Zachary West <zacw@adium.im>
Fri Aug 21 13:25:11 2009 -0700 (2009-08-21)
changeset 2592 e8d15275025e
parent 1739 Frameworks/libpurple.framework/Versions/0.6.0/Headers/transaction.h@8b0daad9656c
permissions -rw-r--r--
im.pidgin.adium.1-4 at 267c6165e02e34318a1823960bd04c0639952f73
     1 /**
     2  * @file transaction.h MSN transaction functions
     3  *
     4  * purple
     5  *
     6  * Purple is the legal property of its developers, whose names are too numerous
     7  * to list here.  Please refer to the COPYRIGHT file distributed with this
     8  * source distribution.
     9  *
    10  * This program is free software; you can redistribute it and/or modify
    11  * it under the terms of the GNU General Public License as published by
    12  * the Free Software Foundation; either version 2 of the License, or
    13  * (at your option) any later version.
    14  *
    15  * This program is distributed in the hope that it will be useful,
    16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    18  * GNU General Public License for more details.
    19  *
    20  * You should have received a copy of the GNU General Public License
    21  * along with this program; if not, write to the Free Software
    22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
    23  */
    24 #ifndef _MSN_TRANSACTION_H
    25 #define _MSN_TRANSACTION_H
    26 
    27 typedef struct _MsnTransaction MsnTransaction;
    28 
    29 #include "command.h"
    30 #include "cmdproc.h"
    31 
    32 typedef void (*MsnTransCb)(MsnCmdProc *cmdproc, MsnCommand *cmd);
    33 typedef void (*MsnTimeoutCb)(MsnCmdProc *cmdproc, MsnTransaction *trans);
    34 typedef void (*MsnErrorCb)(MsnCmdProc *cmdproc, MsnTransaction *trans,
    35 						   int error);
    36 
    37 /**
    38  * A transaction. A sending command that will initiate the transaction.
    39  */
    40 struct _MsnTransaction
    41 {
    42 	MsnCmdProc *cmdproc;
    43 	unsigned int trId;
    44 
    45 	char *command;
    46 	char *params;
    47 
    48 	guint timer;
    49 
    50 	void *data; /**< The data to be used on the different callbacks. */
    51 	GHashTable *callbacks;
    52 	gboolean has_custom_callbacks;
    53 	MsnErrorCb error_cb;
    54 	MsnTimeoutCb timeout_cb;
    55 
    56 	char *payload;
    57 	size_t payload_len;
    58 
    59 	GQueue *queue;
    60 	MsnCommand *pendent_cmd; /**< The command that is waiting for the result of
    61 							   this transaction. */
    62 };
    63 
    64 MsnTransaction *msn_transaction_new(MsnCmdProc *cmdproc, const char *command,
    65 	const char *format, ...) G_GNUC_PRINTF(3, 4);
    66 void msn_transaction_destroy(MsnTransaction *trans);
    67 
    68 char *msn_transaction_to_string(MsnTransaction *trans);
    69 void msn_transaction_queue_cmd(MsnTransaction *trans, MsnCommand *cmd);
    70 void msn_transaction_unqueue_cmd(MsnTransaction *trans, MsnCmdProc *cmdproc);
    71 void msn_transaction_set_payload(MsnTransaction *trans,
    72 								 const char *payload, int payload_len);
    73 void msn_transaction_set_data(MsnTransaction *trans, void *data);
    74 void msn_transaction_add_cb(MsnTransaction *trans, char *answer,
    75 							MsnTransCb cb);
    76 void msn_transaction_set_error_cb(MsnTransaction *trans, MsnErrorCb cb);
    77 void msn_transaction_set_timeout_cb(MsnTransaction *trans, MsnTimeoutCb cb);
    78 
    79 #endif /* _MSN_TRANSACTION_H */