lm-message

lm-message

Functions

Types and Values

Description

Functions

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.

Parameters

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.

Parameters

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 .

Parameters

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 .

Parameters

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 .

Parameters

message

an LmMessage

 

Returns

an LmMessageNode


lm_message_ref ()

LmMessage *
lm_message_ref (LmMessage *message);

Adds a reference to message .

Parameters

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.

Parameters

message

an LmMessage

 

Types and Values

LmMessage

typedef struct {
	LmMessageNode *node;

	LmMessagePriv *priv;
} LmMessage;

enum LmMessageType

Members

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

Members

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