| Wocky Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
WockyStanza; WockyStanzaClass; WockyStanzaPrivate; enum WockyStanzaType; enum WockyStanzaSubType; WockyStanza * wocky_stanza_new (const gchar *name,const gchar *ns); WockyStanza * wocky_stanza_copy (WockyStanza *old); WockyNode * wocky_stanza_get_top_node (WockyStanza *self); WockyStanza * wocky_stanza_build (WockyStanzaType type,WockyStanzaSubType sub_type,const gchar *from,const gchar *to,...); WockyStanza * wocky_stanza_build_to_contact (WockyStanzaType type,WockyStanzaSubType sub_type,const gchar *from,WockyContact *to,...); void wocky_stanza_get_type_info (WockyStanza *stanza,WockyStanzaType *type,WockyStanzaSubType *sub_type); const gchar * wocky_stanza_get_from (WockyStanza *self); const gchar * wocky_stanza_get_to (WockyStanza *self); WockyStanza * wocky_stanza_build_va (WockyStanzaType type,WockyStanzaSubType sub_type,const gchar *from,const gchar *to,va_list ap); WockyStanza * wocky_stanza_build_iq_result (WockyStanza *iq,...); WockyStanza * wocky_stanza_build_iq_result_va (WockyStanza *iq,va_list ap); WockyStanza * wocky_stanza_build_iq_error (WockyStanza *iq,...); WockyStanza * wocky_stanza_build_iq_error_va (WockyStanza *iq,va_list ap); gboolean wocky_stanza_extract_errors (WockyStanza *stanza,WockyXmppErrorType *type,GError **core,GError **specialized,WockyNode **specialized_node); gboolean wocky_stanza_extract_stream_error (WockyStanza *stanza,GError **stream_error); WockyContact * wocky_stanza_get_to_contact (WockyStanza *self); WockyContact * wocky_stanza_get_from_contact (WockyStanza *self); void wocky_stanza_set_to_contact (WockyStanza *self,WockyContact *contact); void wocky_stanza_set_from_contact (WockyStanza *self,WockyContact *contact);
typedef enum
{
WOCKY_STANZA_TYPE_NONE,
WOCKY_STANZA_TYPE_MESSAGE,
WOCKY_STANZA_TYPE_PRESENCE,
WOCKY_STANZA_TYPE_IQ,
WOCKY_STANZA_TYPE_STREAM,
WOCKY_STANZA_TYPE_STREAM_FEATURES,
WOCKY_STANZA_TYPE_AUTH,
WOCKY_STANZA_TYPE_CHALLENGE,
WOCKY_STANZA_TYPE_RESPONSE,
WOCKY_STANZA_TYPE_SUCCESS,
WOCKY_STANZA_TYPE_FAILURE,
WOCKY_STANZA_TYPE_STREAM_ERROR,
WOCKY_STANZA_TYPE_UNKNOWN,
/*< private >*/
NUM_WOCKY_STANZA_TYPE
} WockyStanzaType;
XMPP stanza types.
| no stanza type | |
<message/> stanza
|
|
<presence/> stanza
|
|
<iq/> stanza
|
|
<stream/> stanza
|
|
<stream:features/> stanza
|
|
<auth/> stanza
|
|
<challenge/> stanza
|
|
<response/> stanza
|
|
<success/> stanza
|
|
<failure/> stanza
|
|
<stream:error/> stanza
|
|
| unknown stanza type |
typedef enum
{
WOCKY_STANZA_SUB_TYPE_NONE,
WOCKY_STANZA_SUB_TYPE_AVAILABLE,
WOCKY_STANZA_SUB_TYPE_NORMAL,
WOCKY_STANZA_SUB_TYPE_CHAT,
WOCKY_STANZA_SUB_TYPE_GROUPCHAT,
WOCKY_STANZA_SUB_TYPE_HEADLINE,
WOCKY_STANZA_SUB_TYPE_UNAVAILABLE,
WOCKY_STANZA_SUB_TYPE_PROBE,
WOCKY_STANZA_SUB_TYPE_SUBSCRIBE,
WOCKY_STANZA_SUB_TYPE_UNSUBSCRIBE,
WOCKY_STANZA_SUB_TYPE_SUBSCRIBED,
WOCKY_STANZA_SUB_TYPE_UNSUBSCRIBED,
WOCKY_STANZA_SUB_TYPE_GET,
WOCKY_STANZA_SUB_TYPE_SET,
WOCKY_STANZA_SUB_TYPE_RESULT,
WOCKY_STANZA_SUB_TYPE_ERROR,
WOCKY_STANZA_SUB_TYPE_UNKNOWN,
/*< private >*/
NUM_WOCKY_STANZA_SUB_TYPE
} WockyStanzaSubType;
XMPP stanza sub types.
| no sub type | |
| "available" stanza sub type | |
| "normal" stanza sub type | |
| "chat" stanza sub type | |
| "groupchat" stanza sub type | |
| "headline" stanza sub type | |
| "unavailable" stanza sub type | |
| "probe" stanza sub type | |
| "subscribe" stanza sub type | |
| "unsubscribe" stanza sub type | |
| "subscribed" stanza sub type | |
| "unsubscribed" stanza sub type | |
| "get" stanza sub type | |
| "set" stanza sub type | |
| "result" stanza sub type | |
| "error" stanza sub type | |
| unknown stanza sub type |
WockyStanza * wocky_stanza_new (const gchar *name,const gchar *ns);
|
|
|
|
Returns : |
WockyNode * wocky_stanza_get_top_node (WockyStanza *self);
|
a stanza |
Returns : |
A pointer to the topmost node of the stanza |
WockyStanza * wocky_stanza_build (WockyStanzaType type,WockyStanzaSubType sub_type,const gchar *from,const gchar *to,...);
Build a XMPP stanza from a list of arguments. Example:
You may optionally use mnemonic ASCII characters in place of the build tags, to better reflect the structure of the stanza in C source. For example, the above stanza could be written as:
|
The type of stanza to build |
|
The stanza's subtype; valid values depend on type. (For instance,
WOCKY_STANZA_TYPE_IQ can use WOCKY_STANZA_SUB_TYPE_GET, but not
WOCKY_STANZA_SUB_TYPE_SUBSCRIBED.)
|
|
The sender's JID, or NULL to leave it unspecified.
|
|
The target's JID, or NULL to leave it unspecified.
|
|
the description of the stanza to build,
terminated with NULL
|
Returns : |
a new stanza object |
WockyStanza * wocky_stanza_build_to_contact (WockyStanzaType type,WockyStanzaSubType sub_type,const gchar *from,WockyContact *to,...);
|
|
|
|
|
|
|
|
|
|
Returns : |
void wocky_stanza_get_type_info (WockyStanza *stanza,WockyStanzaType *type,WockyStanzaSubType *sub_type);
|
|
|
|
|
const gchar * wocky_stanza_get_from (WockyStanza *self);
|
a stanza |
Returns : |
The sender of self, or NULL if no sender was specified.
|
const gchar * wocky_stanza_get_to (WockyStanza *self);
|
a stanza |
Returns : |
The recipient of self, or NULL if no recipient was specified.
|
WockyStanza * wocky_stanza_build_va (WockyStanzaType type,WockyStanzaSubType sub_type,const gchar *from,const gchar *to,va_list ap);
|
|
|
|
|
|
|
|
|
|
Returns : |
WockyStanza * wocky_stanza_build_iq_result (WockyStanza *iq,...);
|
|
|
|
Returns : |
WockyStanza * wocky_stanza_build_iq_result_va (WockyStanza *iq,va_list ap);
|
|
|
|
Returns : |
WockyStanza * wocky_stanza_build_iq_error (WockyStanza *iq,...);
Builds an error reply to iq containing the given body. This function also
adds the child element of iq to the reply, as recommended by RFC3920 §9.2.3
‘IQ Semantics’.
No <error/> element is added to the reply. To add a
standard stanza error, plus message, consider using
wocky_stanza_error_to_node(). To add a more complicated error with an
application-specific condition, specify it when calling this function. For
example:
1 |
|
a stanza of type WOCKY_STANZA_TYPE_IQ and sub-type either WOCKY_STANZA_SUB_TYPE_SET or WOCKY_STANZA_SUB_TYPE_GET |
|
a wocky_stanza_build() specification
|
Returns : |
an error reply for iq
|
WockyStanza * wocky_stanza_build_iq_error_va (WockyStanza *iq,va_list ap);
|
|
|
|
Returns : |
gboolean wocky_stanza_extract_errors (WockyStanza *stanza,WockyXmppErrorType *type,GError **core,GError **specialized,WockyNode **specialized_node);
Given a message, iq or presence stanza with type='error', breaks it down
into values describing the error. type and core are guaranteed to be set;
specialized and specialized_node will be set if a recognised
application-specific error is found, and the latter will be set to NULL if
no application-specific error is found.
Any or all of the out parameters may be NULL to ignore the value. The
value stored in specialized_node is borrowed from stanza, and is only
valid as long as the latter is alive.
|
a message/iq/presence stanza |
|
location at which to store the error type |
|
location at which to store an error in the domain WOCKY_XMPP_ERROR |
|
location at which to store an error in an application-specific domain, if one is found |
|
location at which to store the node representing an application-specific error, if one is found |
Returns : |
TRUE if the stanza had type='error'; FALSE otherwise
|
gboolean wocky_stanza_extract_stream_error (WockyStanza *stanza,GError **stream_error);
|
a stanza |
|
location at which to store an error in domain WOCKY_XMPP_STREAM_ERROR, if one is found. |
Returns : |
TRUE and sets stream_error if the stanza was indeed a stream
error.
|
WockyContact * wocky_stanza_get_to_contact (WockyStanza *self);
|
|
Returns : |
WockyContact * wocky_stanza_get_from_contact (WockyStanza *self);
|
|
Returns : |
void wocky_stanza_set_to_contact (WockyStanza *self,WockyContact *contact);
|
|
|
void wocky_stanza_set_from_contact (WockyStanza *self,WockyContact *contact);
|
|
|