annotate src/protocols/msn/command.h @ 13573:0b2e4a5a8e79

[gaim-migrate @ 15952] Bj??rn pointed out on gaim-i18n that the instructions are not translated. For users who might not speak English (or whatever language the server configuration file is in), it seems worthwhile to flag that text as coming from the server. committer: Tailor Script <[e-mail]>

/**
 * @file command.h MSN command functions
 *
 * 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 _MSN_COMMAND_H
#define _MSN_COMMAND_H

typedef struct _MsnCommand MsnCommand;

#include "cmdproc.h"
#include "transaction.h"

typedef void (*MsnPayloadCb)(MsnCmdProc *cmdproc, MsnCommand *cmd,
							 char *payload, size_t len);

/**
 * A received command.
 */
struct _MsnCommand
{
	unsigned int trId;

	char *command;
	char **params;
	int param_count;

	int ref_count;

	MsnTransaction *trans;

	char *payload;
	size_t payload_len;

	MsnPayloadCb payload_cb;
};

MsnCommand *msn_command_from_string(const char *string);
void msn_command_destroy(MsnCommand *cmd);
MsnCommand *msn_command_ref(MsnCommand *cmd);
MsnCommand *msn_command_unref(MsnCommand *cmd);

#endif /* _MSN_COMMAND_H */