lm-message

lm-message

Synopsis

                    LmMessage;
enum                LmMessageType;
enum                LmMessageSubType;
LmMessage *         lm_message_new                      (const gchar *to,
                                                         LmMessageType type);
LmMessage *         lm_message_new_with_sub_type        (const gchar *to,
                                                         LmMessageType type,
                                                         LmMessageSubType sub_type);
LmMessageType       lm_message_get_type                 (LmMessage *message);
LmMessageSubType    lm_message_get_sub_type             (LmMessage *message);
LmMessageNode *     lm_message_get_node                 (LmMessage *message);
LmMessage *         lm_message_ref                      (LmMessage *message);
void                lm_message_unref                    (LmMessage *message);

Description

Details

LmMessage

typedef struct {
	LmMessageNode *node;

	LmMessagePriv *priv;
} LmMessage;


enum LmMessageType

typedef enum {
	LM_MESSAGE_TYPE_MESSAGE,
	LM_MESSAGE_TYPE_PRESENCE,
	LM_MESSAGE_TYPE_IQ,
	LM_MESSAGE_TYPE_STREAM,
	LM_MESSAGE_TYPE_STREAM_ERROR,
	LM_MESSAGE_TYPE_STREAM_FEATURES,
	LM_MESSAGE_TYPE_AUTH,
	LM_MESSAGE_TYPE_CHALLENGE,
	LM_MESSAGE_TYPE_RESPONSE,
	LM_MESSAGE_TYPE_SUCCESS,
	LM_MESSAGE_TYPE_FAILURE,
	LM_MESSAGE_TYPE_PROCEED,
	LM_MESSAGE_TYPE_STARTTLS,
	LM_MESSAGE_TYPE_UNKNOWN
} LmMessageType;

LM_MESSAGE_TYPE_MESSAGE

LM_MESSAGE_TYPE_PRESENCE

LM_MESSAGE_TYPE_IQ

LM_MESSAGE_TYPE_STREAM

LM_MESSAGE_TYPE_STREAM_ERROR

LM_MESSAGE_TYPE_STREAM_FEATURES

LM_MESSAGE_TYPE_AUTH

LM_MESSAGE_TYPE_CHALLENGE

LM_MESSAGE_TYPE_RESPONSE

LM_MESSAGE_TYPE_SUCCESS

LM_MESSAGE_TYPE_FAILURE

LM_MESSAGE_TYPE_PROCEED

LM_MESSAGE_TYPE_STARTTLS

LM_MESSAGE_TYPE_UNKNOWN


enum LmMessageSubType

typedef enum {
        LM_MESSAGE_SUB_TYPE_NOT_SET = -10,
	LM_MESSAGE_SUB_TYPE_AVAILABLE = -1,
	LM_MESSAGE_SUB_TYPE_NORMAL = 0,
	LM_MESSAGE_SUB_TYPE_CHAT,
        LM_MESSAGE_SUB_TYPE_GROUPCHAT,
        LM_MESSAGE_SUB_TYPE_HEADLINE,
        LM_MESSAGE_SUB_TYPE_UNAVAILABLE,
        LM_MESSAGE_SUB_TYPE_PROBE,
        LM_MESSAGE_SUB_TYPE_SUBSCRIBE,
        LM_MESSAGE_SUB_TYPE_UNSUBSCRIBE,
        LM_MESSAGE_SUB_TYPE_SUBSCRIBED,
        LM_MESSAGE_SUB_TYPE_UNSUBSCRIBED,
	LM_MESSAGE_SUB_TYPE_GET,
	LM_MESSAGE_SUB_TYPE_SET,
	LM_MESSAGE_SUB_TYPE_RESULT,
	LM_MESSAGE_SUB_TYPE_ERROR
} LmMessageSubType;

LM_MESSAGE_SUB_TYPE_NOT_SET

LM_MESSAGE_SUB_TYPE_AVAILABLE

LM_MESSAGE_SUB_TYPE_NORMAL

LM_MESSAGE_SUB_TYPE_CHAT

LM_MESSAGE_SUB_TYPE_GROUPCHAT

LM_MESSAGE_SUB_TYPE_HEADLINE

LM_MESSAGE_SUB_TYPE_UNAVAILABLE

LM_MESSAGE_SUB_TYPE_PROBE

LM_MESSAGE_SUB_TYPE_SUBSCRIBE

LM_MESSAGE_SUB_TYPE_UNSUBSCRIBE

LM_MESSAGE_SUB_TYPE_SUBSCRIBED

LM_MESSAGE_SUB_TYPE_UNSUBSCRIBED

LM_MESSAGE_SUB_TYPE_GET

LM_MESSAGE_SUB_TYPE_SET

LM_MESSAGE_SUB_TYPE_RESULT

LM_MESSAGE_SUB_TYPE_ERROR


lm_message_new ()

LmMessage *         lm_message_new                      (const gchar *to,
                                                         LmMessageType type);

Creates a new LmMessage which can be sent with lm_connection_send() or lm_connection_send_with_reply(). If to is NULL the message is sent to the server. The returned message should be unreferenced with lm_message_unref() when caller is finished with it.

to :

receipient jid

type :

message type

Returns :

a newly created LmMessage

lm_message_new_with_sub_type ()

LmMessage *         lm_message_new_with_sub_type        (const gchar *to,
                                                         LmMessageType type,
                                                         LmMessageSubType sub_type);

Creates a new LmMessage with sub type set. See lm_message_new() for more information.

to :

receipient jid

type :

message type

sub_type :

message sub type

Returns :

a newly created LmMessage

lm_message_get_type ()

LmMessageType       lm_message_get_type                 (LmMessage *message);

Fetches the type of message.

message :

an LmMessage

Returns :

the message type

lm_message_get_sub_type ()

LmMessageSubType    lm_message_get_sub_type             (LmMessage *message);

Fetches the sub type of message.

message :

an LmMessage

Returns :

the message sub type

lm_message_get_node ()

LmMessageNode *     lm_message_get_node                 (LmMessage *message);

Retrieves the root node from message.

message :

an LmMessage

Returns :

an LmMessageNode

lm_message_ref ()

LmMessage *         lm_message_ref                      (LmMessage *message);

Adds a reference to message.

message :

an LmMessage

Returns :

the message

lm_message_unref ()

void                lm_message_unref                    (LmMessage *message);

Removes a reference from message. When no more references are present the message is freed.

message :

an LmMessage