Frameworks/libpurple.framework/Versions/0.6.2/Headers/httpconn.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/httpconn.h@8b0daad9656c
permissions -rw-r--r--
im.pidgin.adium.1-4 at 267c6165e02e34318a1823960bd04c0639952f73
Evan@653
     1
/**
Evan@653
     2
 * @file httpconn.h HTTP connection
Evan@653
     3
 *
Evan@653
     4
 * purple
Evan@653
     5
 *
Evan@653
     6
 * Purple is the legal property of its developers, whose names are too numerous
Evan@653
     7
 * to list here.  Please refer to the COPYRIGHT file distributed with this
Evan@653
     8
 * source distribution.
Evan@653
     9
 *
Evan@653
    10
 * This program is free software; you can redistribute it and/or modify
Evan@653
    11
 * it under the terms of the GNU General Public License as published by
Evan@653
    12
 * the Free Software Foundation; either version 2 of the License, or
Evan@653
    13
 * (at your option) any later version.
Evan@653
    14
 *
Evan@653
    15
 * This program is distributed in the hope that it will be useful,
Evan@653
    16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Evan@653
    17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Evan@653
    18
 * GNU General Public License for more details.
Evan@653
    19
 *
Evan@653
    20
 * You should have received a copy of the GNU General Public License
Evan@653
    21
 * along with this program; if not, write to the Free Software
Evan@653
    22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
Evan@653
    23
 */
Evan@653
    24
#ifndef _MSN_HTTPCONN_H_
Evan@653
    25
#define _MSN_HTTPCONN_H_
Evan@653
    26
Evan@653
    27
typedef struct _MsnHttpConn MsnHttpConn;
Evan@653
    28
Evan@653
    29
#include "circbuffer.h"
Evan@653
    30
#include "servconn.h"
Evan@653
    31
Evan@653
    32
/**
Evan@653
    33
 * An HTTP Connection.
Evan@653
    34
 */
Evan@653
    35
struct _MsnHttpConn
Evan@653
    36
{
Evan@653
    37
	MsnSession *session; /**< The MSN Session. */
Evan@653
    38
	MsnServConn *servconn; /**< The connection object. */
Evan@653
    39
Evan@653
    40
	PurpleProxyConnectData *connect_data;
Evan@653
    41
Evan@653
    42
	char *full_session_id; /**< The full session id. */
Evan@653
    43
	char *session_id; /**< The trimmed session id. */
Evan@653
    44
Evan@653
    45
	int timer; /**< The timer for polling. */
Evan@653
    46
Evan@653
    47
	gboolean waiting_response; /**< The flag that states if we are waiting
Evan@653
    48
								 a response from the server. */
Evan@653
    49
	gboolean connected;        /**< The flag that states if the connection is on. */
Evan@653
    50
	gboolean virgin;           /**< The flag that states if this connection
Evan@653
    51
								 should specify the host (not gateway) to
Evan@653
    52
								 connect to. */
Evan@653
    53
Evan@653
    54
	char *host; /**< The HTTP gateway host. */
Evan@653
    55
	GList *queue; /**< The queue of data chunks to write. */
Evan@653
    56
Evan@653
    57
	int fd; /**< The connection's file descriptor. */
Evan@653
    58
	guint inpa; /**< The connection's input handler. */
Evan@653
    59
Evan@653
    60
	char *rx_buf; /**< The receive buffer. */
Evan@653
    61
	int rx_len; /**< The receive buffer length. */
Evan@653
    62
Evan@653
    63
	PurpleCircBuffer *tx_buf;
Evan@653
    64
	guint tx_handler;
Evan@653
    65
};
Evan@653
    66
Evan@653
    67
/**
Evan@653
    68
 * Creates a new HTTP connection object.
Evan@653
    69
 *
Evan@653
    70
 * @param servconn The connection object.
Evan@653
    71
 *
Evan@653
    72
 * @return The new object.
Evan@653
    73
 */
Evan@653
    74
MsnHttpConn *msn_httpconn_new(MsnServConn *servconn);
Evan@653
    75
Evan@653
    76
/**
Evan@653
    77
 * Destroys an HTTP connection object.
Evan@653
    78
 *
Evan@653
    79
 * @param httpconn The HTTP connection object.
Evan@653
    80
 */
Evan@653
    81
void msn_httpconn_destroy(MsnHttpConn *httpconn);
Evan@653
    82
Evan@653
    83
/**
Evan@653
    84
 * Writes a chunk of data to the HTTP connection.
Evan@653
    85
 *
Evan@653
    86
 * @param servconn    The server connection.
Evan@653
    87
 * @param data        The data to write.
Evan@653
    88
 * @param data_len    The size of the data to write.
Evan@653
    89
 *
Evan@653
    90
 * @return The number of bytes written.
Evan@653
    91
 */
Evan@653
    92
gssize msn_httpconn_write(MsnHttpConn *httpconn, const char *data, size_t data_len);
Evan@653
    93
Evan@653
    94
/**
Evan@653
    95
 * Connects the HTTP connection object to a host.
Evan@653
    96
 *
Evan@653
    97
 * @param httpconn The HTTP connection object.
Evan@653
    98
 * @param host The host to connect to.
Evan@653
    99
 * @param port The port to connect to.
Evan@653
   100
 */
Evan@653
   101
gboolean msn_httpconn_connect(MsnHttpConn *httpconn,
Evan@653
   102
							  const char *host, int port);
Evan@653
   103
Evan@653
   104
/**
Evan@653
   105
 * Disconnects the HTTP connection object.
Evan@653
   106
 *
Evan@653
   107
 * @param httpconn The HTTP connection object.
Evan@653
   108
 */
Evan@653
   109
void msn_httpconn_disconnect(MsnHttpConn *httpconn);
Evan@653
   110
Evan@653
   111
#endif /* _MSN_HTTPCONN_H_ */