Mercurial > pidgin
view src/protocols/msn/msg.h @ 8773:1d7416e8db5f
[gaim-migrate @ 9534]
for datallah with love
committer: Tailor Script <tailor@pidgin.im>
author | Ethan Blanton <elb@pidgin.im> |
---|---|
date | Fri, 23 Apr 2004 15:48:21 +0000 |
parents | 1e211dde3cae |
children | c30d81b4dd22 |
line wrap: on
line source
/** * @file msg.h Message functions * * gaim * * Copyright (C) 2003-2004 Christian Hammond <chipx86@gnupdate.org> * * 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_MSG_H_ #define _MSN_MSG_H_ typedef struct _MsnMessage MsnMessage; #include "session.h" #include "user.h" typedef struct { long session_id; long id; long offset_1; long offset_2; long total_size_1; long total_size_2; long length; long flags; long ack_session_id; long ack_unique_id; long ack_length_1; long ack_length_2; } MsnSlpHeader; typedef struct { long app_id; } MsnSlpFooter; /** * A message. */ struct _MsnMessage { size_t ref_count; /**< The reference count. */ gboolean msnslp_message; gboolean msnslp_ack_message; char *passport; unsigned int tid; char flag; size_t size; gboolean bin_content; char *content_type; char *charset; char *body; size_t bin_len; MsnSlpHeader msnslp_header; MsnSlpFooter msnslp_footer; MsnMessage *acked_msg; GHashTable *attr_table; GList *attr_list; }; #define MSN_MESSAGE(msg) ((MsnMessage *)(msg)) /** * Creates a new, empty message. * * @return A new message. */ MsnMessage *msn_message_new(void); /** * Creates a new, empty MSNSLP message. * * @return A new MSNSLP message. */ MsnMessage *msn_message_new_msnslp(void); /** * Creates a MSNSLP ack message. * * @param acked_msg The message to acknowledge. * * @return A new MSNSLP ack message. */ MsnMessage *msn_message_new_msnslp_ack(MsnMessage *acked_msg); /** * Parse the payload of a message. * * @param msg The message. * @param payload The payload. * @param payload_len The length payload. */ void msn_message_parse_payload(MsnMessage *msg, const char *payload, size_t payload_len); /** * Destroys a message. * * @param msg The message to destroy. */ void msn_message_destroy(MsnMessage *msg); /** * Increments the reference count on a message. * * @param msg The message. * * @return @a msg */ MsnMessage *msn_message_ref(MsnMessage *msg); /** * Decrements the reference count on a message. * * This will destroy the structure if the count hits 0. * * @param msg The message. * * @return @a msg, or @c NULL if the new count is 0. */ MsnMessage *msn_message_unref(MsnMessage *msg); /** * Generates the payload data of a message. * * @param msg The message. * @param ret_size The returned size of the payload. * * @return The payload data of the message. */ char *msn_message_gen_payload(const MsnMessage *msg, size_t *ret_size); /** * Sets the flag for an outgoing message. * * @param msg The message. * @param flag The flag. */ void msn_message_set_flag(MsnMessage *msg, char flag); /** * Returns the flag for an outgoing message. * * @param msg The message. * * @return The flag. */ char msn_message_get_flag(const MsnMessage *msg); /** * Sets the body of a message. * * @param msg The message. * @param body The body of the message. */ void msn_message_set_body(MsnMessage *msg, const char *body); /** * Returns the body of the message. * * @param msg The message. * * @return The body of the message. */ const char *msn_message_get_body(const MsnMessage *msg); /** * Sets the binary content of the message. * * @param msg The message. * @param data The binary data. * @param len The length of the data. */ void msn_message_set_bin_data(MsnMessage *msg, const void *data, size_t len); /** * Returns the binary content of the message. * * @param msg The message. * @param len The returned length of the data. * * @return The binary data. */ const void *msn_message_get_bin_data(const MsnMessage *msg, size_t *len); /** * Sets the content type in a message. * * @param msg The message. * @param type The content-type. */ void msn_message_set_content_type(MsnMessage *msg, const char *type); /** * Returns the content type in a message. * * @param msg The message. * * @return The content-type. */ const char *msn_message_get_content_type(const MsnMessage *msg); /** * Sets the charset in a message. * * @param msg The message. * @param charset The charset. */ void msn_message_set_charset(MsnMessage *msg, const char *charset); /** * Returns the charset in a message. * * @param msg The message. * * @return The charset. */ const char *msn_message_get_charset(const MsnMessage *msg); /** * Sets an attribute in a message. * * @param msg The message. * @param attr The attribute name. * @param value The attribute value. */ void msn_message_set_attr(MsnMessage *msg, const char *attr, const char *value); /** * Returns an attribute from a message. * * @param msg The message. * @param attr The attribute. * * @return The value, or @c NULL if not found. */ const char *msn_message_get_attr(const MsnMessage *msg, const char *attr); /** * Parses the body and returns it in the form of a hashtable. * * @param msg The message. * * @return The resulting hashtable. */ GHashTable *msn_message_get_hashtable_from_body(const MsnMessage *msg); #endif /* _MSN_MSG_H_ */