annotate src/protocols/msn/servconn.h @ 8583:fc27237783ee

[gaim-migrate @ 9333] Added Felipe Contreras's patch to reorganize and clean up the MSN protocol plugin. Thanks, and once again, apologies for the what must have seemed a never-ending delay. committer: Tailor Script <[e-mail]>

/**
 * @file servconn.h Server connection functions
 *
 * gaim
 *
 * Copyright (C) 2003-2004 Christian Hammond <[e-mail]>
 *
 * 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_SERVCONN_H_
#define _MSN_SERVCONN_H_

#include "proxy.h"

typedef struct _MsnServConn MsnServConn;

#include "msg.h"
#include "httpmethod.h"

typedef gboolean (*MsnServConnCommandCb)(MsnServConn *servconn,
										 const char *cmd, const char **params,
										 size_t param_count);

typedef gboolean (*MsnServConnMsgCb)(MsnServConn *servconn, MsnMessage *msg);

#include "session.h"

typedef enum
{
	MSN_MULTILINE_MSG,
	MSN_MULTILINE_IPG,
	MSN_MULTILINE_NOT

} MsnMultilineType;

struct _MsnServConn
{
	MsnSession *session;

	gboolean connected;

	MsnHttpMethodData *http_data;

#if 0
	/* shx: not used */
	char *host;
	int port;
#endif

	int fd;
	int inpa;

	char *rxqueue;
	int rxlen;

	GSList *msg_queue;

	GSList *txqueue;

	gboolean parsing_multiline;
	MsnMultilineType multiline_type;
	char *msg_passport;
	char *msg_friendly;
	int multiline_len;

	GHashTable *commands;
	GHashTable *msg_types;

	gboolean (*connect_cb)(MsnServConn *servconn);
	void (*disconnect_cb)(MsnServConn *servconn);

	void *data;
};

MsnServConn *msn_servconn_new(MsnSession *session);

void msn_servconn_destroy(MsnServConn *servconn);

gboolean msn_servconn_connect(MsnServConn *servconn, const char *host,
							  int port);
void msn_servconn_disconnect(MsnServConn *servconn);

#if 0
/* shx: not used */
void msn_servconn_set_server(MsnServConn *servconn, const char *server,
							 int port);

const char *msn_servconn_get_server(const MsnServConn *servconn);
int msn_servconn_get_port(const MsnServConn *servconn);
#endif

void msn_servconn_set_connect_cb(MsnServConn *servconn,
		gboolean (*connect_cb)(MsnServConn *servconn));

void msn_servconn_set_disconnect_cb(MsnServConn *servconn,
		void (*disconnect_cb)(MsnServConn *servconn));

size_t msn_servconn_write(MsnServConn *servconn, const char *buf,
						  size_t size);

gboolean msn_servconn_send_command(MsnServConn *servconn, const char *command,
								   const char *params);

void msn_servconn_queue_message(MsnServConn *servconn, const char *command,
								MsnMessage *msg);

void msn_servconn_unqueue_message(MsnServConn *servconn, MsnMessage *msg);

void msn_servconn_register_command(MsnServConn *servconn,
								   const char *command,
								   MsnServConnCommandCb cb);

void msn_servconn_register_msg_type(MsnServConn *servconn,
									const char *content_type,
									MsnServConnMsgCb cb);

void msn_servconn_parse_data(gpointer data, gint source,
							 GaimInputCondition cond);

#endif /* _MSN_SERVCONN_H_ */