Thu Apr 16 06:47:09 2015

Asterisk developer's documentation


jabber.h File Reference

AJI - The Asterisk Jabber Interface. More...

#include <iksemel.h>
#include "asterisk/astobj.h"
#include "asterisk/linkedlists.h"

Include dependency graph for jabber.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  aji_buddy
struct  aji_buddy_container
struct  aji_capabilities
struct  aji_client
struct  aji_client::messages
struct  aji_client_container
struct  aji_message
struct  aji_resource
struct  aji_transport_container
struct  aji_version

Defines

#define AJI_MAX_ATTRLEN   256
#define AJI_MAX_JIDLEN   3071
#define AJI_MAX_RESJIDLEN   1023
#define IKS_NET_EXPIRED   12
#define MUC_NS   "http://jabber.org/protocol/muc"
#define NET_IO_BUF_SIZE   4096

Enumerations

enum  { AJI_AUTOPRUNE = (1 << 0), AJI_AUTOREGISTER = (1 << 1), AJI_AUTOACCEPT = (1 << 2) }
enum  { AJI_XEP0248 = (1 << 0), AJI_PUBSUB = (1 << 1), AJI_PUBSUB_AUTOCREATE = (1 << 2) }
enum  aji_btype { AJI_USER = 0, AJI_TRANS = 1, AJI_UTRANS = 2 }
enum  aji_state { AJI_DISCONNECTING, AJI_DISCONNECTED, AJI_CONNECTING, AJI_CONNECTED }

Functions

void ast_aji_buddy_destroy (struct aji_buddy *obj)
int ast_aji_check_roster (void)
void ast_aji_client_destroy (struct aji_client *obj)
int ast_aji_create_chat (struct aji_client *client, char *room, char *server, char *topic)
 create a chatroom.
int ast_aji_disconnect (struct aji_client *client)
 disconnect from jabber server.
struct aji_clientast_aji_get_client (const char *name)
 grab a aji_client structure by label name or JID. Bumps the refcount. (without the resource string)
struct aji_client_containerast_aji_get_clients (void)
void ast_aji_increment_mid (char *mid)
 increments the mid field for messages and other events.
int ast_aji_invite_chat (struct aji_client *client, char *user, char *room, char *message)
 invite to a chatroom.
int ast_aji_join_chat (struct aji_client *client, char *room, char *nick)
 join a chatroom.
int ast_aji_leave_chat (struct aji_client *client, char *room, char *nick)
 leave a chatroom.
int ast_aji_send (struct aji_client *client, iks *x)
 Wraps raw sending.
int ast_aji_send_chat (struct aji_client *client, const char *address, const char *message)
 sends messages.
int ast_aji_send_groupchat (struct aji_client *client, const char *nick, const char *address, const char *message)
 sends message to a groupchat Prior to sending messages to a groupchat, one must be connected to it.


Detailed Description

AJI - The Asterisk Jabber Interface.

Definition in file jabber.h.


Define Documentation

#define AJI_MAX_ATTRLEN   256

Definition at line 75 of file jabber.h.

Referenced by aji_act_hook().

#define AJI_MAX_JIDLEN   3071

#define AJI_MAX_RESJIDLEN   1023

Definition at line 74 of file jabber.h.

Referenced by aji_join_exec(), aji_leave_exec(), and aji_sendgroup_exec().

#define IKS_NET_EXPIRED   12

Definition at line 57 of file jabber.h.

Referenced by aji_recv(), and aji_recv_loop().

#define MUC_NS   "http://jabber.org/protocol/muc"

Definition at line 77 of file jabber.h.

Referenced by aji_set_group_presence().

#define NET_IO_BUF_SIZE   4096

Definition at line 55 of file jabber.h.

Referenced by aji_recv().


Enumeration Type Documentation

anonymous enum

Enumerator:
AJI_AUTOPRUNE 
AJI_AUTOREGISTER 
AJI_AUTOACCEPT 

Definition at line 86 of file jabber.h.

00086      {
00087    AJI_AUTOPRUNE = (1 << 0),
00088    AJI_AUTOREGISTER = (1 << 1),
00089    AJI_AUTOACCEPT = (1 << 2),
00090 };

anonymous enum

Enumerator:
AJI_XEP0248 
AJI_PUBSUB 
AJI_PUBSUB_AUTOCREATE 

Definition at line 92 of file jabber.h.

00092      {
00093    AJI_XEP0248 = (1 << 0),
00094    AJI_PUBSUB = (1 << 1),
00095    AJI_PUBSUB_AUTOCREATE = (1 << 2),
00096 };

enum aji_btype

Enumerator:
AJI_USER 
AJI_TRANS 
AJI_UTRANS 

Definition at line 98 of file jabber.h.

00098                {
00099    AJI_USER = 0,
00100    AJI_TRANS = 1,
00101    AJI_UTRANS = 2,
00102 };

enum aji_state

Enumerator:
AJI_DISCONNECTING 
AJI_DISCONNECTED 
AJI_CONNECTING 
AJI_CONNECTED 

Definition at line 79 of file jabber.h.

00079                {
00080    AJI_DISCONNECTING,
00081    AJI_DISCONNECTED,
00082    AJI_CONNECTING,
00083    AJI_CONNECTED
00084 };


Function Documentation

void ast_aji_buddy_destroy ( struct aji_buddy obj  ) 

Destructor function for buddies to be used with ASTOBJ_UNREF

Definition at line 432 of file res_jabber.c.

References ast_free, aji_resource::description, aji_resource::next, and aji_buddy::resources.

Referenced by acf_jabberstatus_read(), aji_client_info_handler(), aji_create_buddy(), aji_dinfo_handler(), aji_handle_presence(), aji_handle_subscribe(), aji_register_query_handler(), aji_status_exec(), ast_aji_client_destroy(), gtalk_alloc(), and jingle_alloc().

00433 {
00434    struct aji_resource *tmp;
00435 
00436    while ((tmp = obj->resources)) {
00437       obj->resources = obj->resources->next;
00438       ast_free(tmp->description);
00439       ast_free(tmp);
00440    }
00441 
00442    ast_free(obj);
00443 }

int ast_aji_check_roster ( void   ) 

void ast_aji_client_destroy ( struct aji_client obj  ) 

Destructor function for clients to be used with ASTOBJ_UNREF after calls to ast_aji_get_client

Definition at line 410 of file res_jabber.c.

References aji_message_destroy(), ast_aji_buddy_destroy(), ast_free, AST_LIST_HEAD_DESTROY, AST_LIST_LOCK, AST_LIST_REMOVE_HEAD, ASTOBJ_CONTAINER_DESTROY, ASTOBJ_CONTAINER_DESTROYALL, aji_client::buddies, aji_client::f, aji_message::list, aji_client::messages, aji_client::p, and aji_client::stack.

Referenced by acf_jabberreceive_read(), acf_jabberstatus_read(), aji_act_hook(), aji_cli_create_collection(), aji_cli_create_leafnode(), aji_cli_delete_pubsub_node(), aji_cli_list_pubsub_nodes(), aji_cli_purge_pubsub_nodes(), aji_client_connect(), aji_client_info_handler(), aji_create_client(), aji_devstate_cb(), aji_dinfo_handler(), aji_ditems_handler(), aji_handle_pubsub_error(), aji_join_exec(), aji_leave_exec(), aji_log_hook(), aji_mwi_cb(), aji_receive_node_list(), aji_recv_loop(), aji_register_approve_handler(), aji_register_query_handler(), aji_reload(), aji_send_exec(), aji_sendgroup_exec(), aji_status_exec(), ast_aji_disconnect(), gtalk_load_config(), gtalk_newcall(), gtalk_request(), jingle_load_config(), jingle_newcall(), jingle_request(), manager_jabber_send(), and unload_module().

00411 {
00412    struct aji_message *tmp;
00413    ASTOBJ_CONTAINER_DESTROYALL(&obj->buddies, ast_aji_buddy_destroy);
00414    ASTOBJ_CONTAINER_DESTROY(&obj->buddies);
00415    iks_filter_delete(obj->f);
00416    iks_parser_delete(obj->p);
00417    iks_stack_delete(obj->stack);
00418    AST_LIST_LOCK(&obj->messages);
00419    while ((tmp = AST_LIST_REMOVE_HEAD(&obj->messages, list))) {
00420       aji_message_destroy(tmp);
00421    }
00422    AST_LIST_HEAD_DESTROY(&obj->messages);
00423    ast_free(obj);
00424 }

int ast_aji_create_chat ( struct aji_client client,
char *  room,
char *  server,
char *  topic 
)

create a chatroom.

Open Chat session

Parameters:
client the configured XMPP client we use to connect to a XMPP server
room name of room
server name of server
topic topic for the room.
Returns:
0.

Definition at line 2646 of file res_jabber.c.

References ast_aji_increment_mid(), ast_aji_send(), ast_log(), LOG_ERROR, and aji_client::mid.

02647 {
02648    int res = 0;
02649    iks *iq = NULL;
02650    iq = iks_new("iq");
02651 
02652    if (iq && client) {
02653       iks_insert_attrib(iq, "type", "get");
02654       iks_insert_attrib(iq, "to", server);
02655       iks_insert_attrib(iq, "id", client->mid);
02656       ast_aji_increment_mid(client->mid);
02657       ast_aji_send(client, iq);
02658    } else {
02659       ast_log(LOG_ERROR, "Out of memory.\n");
02660    }
02661 
02662    iks_delete(iq);
02663 
02664    return res;
02665 }

int ast_aji_disconnect ( struct aji_client client  ) 

disconnect from jabber server.

Disconnect jabber client

Parameters:
client the configured XMPP client we use to connect to a XMPP server
Returns:
1.

Definition at line 3153 of file res_jabber.c.

References ast_aji_client_destroy(), ast_verb, ASTOBJ_UNREF, and aji_client::p.

Referenced by unload_module().

03154 {
03155    if (client) {
03156       ast_verb(4, "JABBER: Disconnecting\n");
03157 #ifdef HAVE_OPENSSL
03158       if (client->stream_flags & SECURE) {
03159          SSL_shutdown(client->ssl_session);
03160          SSL_CTX_free(client->ssl_context);
03161          SSL_free(client->ssl_session);
03162       }
03163 #endif
03164       iks_disconnect(client->p);
03165       iks_parser_delete(client->p);
03166       ASTOBJ_UNREF(client, ast_aji_client_destroy);
03167    }
03168 
03169    return 1;
03170 }

struct aji_client* ast_aji_get_client ( const char *  name  )  [read]

grab a aji_client structure by label name or JID. Bumps the refcount. (without the resource string)

Get a client via its name. Increases refcount of client by 1

Parameters:
name label or JID
Returns:
aji_client.

Definition at line 4575 of file res_jabber.c.

References ast_strdupa, ASTOBJ_CONTAINER_FIND, ASTOBJ_CONTAINER_TRAVERSE, ASTOBJ_REF, clients, and strsep().

Referenced by acf_jabberreceive_read(), acf_jabberstatus_read(), aji_join_exec(), aji_leave_exec(), aji_send_exec(), aji_sendgroup_exec(), aji_status_exec(), gtalk_create_member(), gtalk_newcall(), gtalk_request(), jingle_create_member(), jingle_newcall(), jingle_request(), and manager_jabber_send().

04576 {
04577    struct aji_client *client = NULL;
04578    char *aux = NULL;
04579 
04580    client = ASTOBJ_CONTAINER_FIND(&clients, name);
04581    if (!client && strchr(name, '@')) {
04582       ASTOBJ_CONTAINER_TRAVERSE(&clients, 1, {
04583          aux = ast_strdupa(iterator->user);
04584          if (strchr(aux, '/')) {
04585             /* strip resource for comparison */
04586             aux = strsep(&aux, "/");
04587          }
04588          if (!strncasecmp(aux, name, strlen(aux))) {
04589             client = ASTOBJ_REF(iterator);
04590          }
04591       });
04592    }
04593 
04594    return client;
04595 }

struct aji_client_container* ast_aji_get_clients ( void   )  [read]

Definition at line 4597 of file res_jabber.c.

References clients.

Referenced by gtalk_load_config(), and jingle_load_config().

04598 {
04599    return &clients;
04600 }

void ast_aji_increment_mid ( char *  mid  ) 

increments the mid field for messages and other events.

Parameters:
mid char.
Returns:
void.

Definition at line 2790 of file res_jabber.c.

Referenced by aji_act_hook(), aji_handle_presence(), aji_pubsub_iq_create(), aji_register_approve_handler(), ast_aji_create_chat(), ast_aji_invite_chat(), gtalk_action(), gtalk_create_candidates(), gtalk_invite(), jingle_accept_call(), jingle_action(), jingle_create_candidates(), jingle_digit(), and jingle_transmit_invite().

02791 {
02792    int i = 0;
02793 
02794    for (i = strlen(mid) - 1; i >= 0; i--) {
02795       if (mid[i] != 'z') {
02796          mid[i] = mid[i] + 1;
02797          i = 0;
02798       } else
02799          mid[i] = 'a';
02800    }
02801 }

int ast_aji_invite_chat ( struct aji_client client,
char *  user,
char *  room,
char *  message 
)

invite to a chatroom.

Invite to opened Chat session

Parameters:
client the configured XMPP client we use to connect to a XMPP server
user 
room 
message 
Returns:
res.

Definition at line 2698 of file res_jabber.c.

References ast_aji_increment_mid(), ast_aji_send(), ast_log(), LOG_ERROR, and aji_client::mid.

02699 {
02700    int res = 0;
02701    iks *invite, *body, *namespace;
02702 
02703    invite = iks_new("message");
02704    body = iks_new("body");
02705    namespace = iks_new("x");
02706    if (client && invite && body && namespace) {
02707       iks_insert_attrib(invite, "to", user);
02708       iks_insert_attrib(invite, "id", client->mid);
02709       ast_aji_increment_mid(client->mid);
02710       iks_insert_cdata(body, message, 0);
02711       iks_insert_attrib(namespace, "xmlns", "jabber:x:conference");
02712       iks_insert_attrib(namespace, "jid", room);
02713       iks_insert_node(invite, body);
02714       iks_insert_node(invite, namespace);
02715       res = ast_aji_send(client, invite);
02716    } else {
02717       ast_log(LOG_ERROR, "Out of memory.\n");
02718    }
02719 
02720    iks_delete(body);
02721    iks_delete(namespace);
02722    iks_delete(invite);
02723 
02724    return res;
02725 }

int ast_aji_join_chat ( struct aji_client client,
char *  room,
char *  nick 
)

join a chatroom.

Join/leave existing Chat session

Parameters:
client the configured XMPP client we use to connect to a XMPP server
room room to join
nick the nickname to use in this room
Returns:
IKS_OK on success, any other value on failure.

Definition at line 2674 of file res_jabber.c.

References aji_set_group_presence().

Referenced by aji_join_exec().

02675 {
02676    return aji_set_group_presence(client, room, IKS_SHOW_AVAILABLE, nick, NULL);
02677 }

int ast_aji_leave_chat ( struct aji_client client,
char *  room,
char *  nick 
)

leave a chatroom.

Parameters:
client the configured XMPP client we use to connect to a XMPP server
room room to leave
nick the nickname used in this room
Returns:
IKS_OK on success, any other value on failure.

Definition at line 2686 of file res_jabber.c.

References aji_set_group_presence().

Referenced by aji_leave_exec().

02687 {
02688    return aji_set_group_presence(client, room, IKS_SHOW_UNAVAILABLE, nick, NULL);
02689 }

int ast_aji_send ( struct aji_client client,
iks *  x 
)

int ast_aji_send_chat ( struct aji_client client,
const char *  address,
const char *  message 
)

sends messages.

Send jabber chat message from connected client to jabber URI

Parameters:
client the configured XMPP client we use to connect to a XMPP server
address 
message 
Return values:
IKS_OK success
-1 failure

Definition at line 2582 of file res_jabber.c.

References aji_send_raw_chat().

Referenced by aji_send_exec(), gtalk_sendtext(), jingle_sendtext(), and manager_jabber_send().

02583 {
02584    return aji_send_raw_chat(client, 0, NULL, address, message);
02585 }

int ast_aji_send_groupchat ( struct aji_client client,
const char *  nick,
const char *  address,
const char *  message 
)

sends message to a groupchat Prior to sending messages to a groupchat, one must be connected to it.

Send jabber chat message from connected client to a groupchat using a given nickname

Parameters:
client the configured XMPP client we use to connect to a XMPP server
nick the nickname we use in the chatroom
address the user the messages must be sent to
message the message to send
Returns:
IKS_OK on success, any other value on failure

Definition at line 2596 of file res_jabber.c.

References aji_send_raw_chat().

Referenced by aji_sendgroup_exec().

02596                                                                                                                   {
02597    return aji_send_raw_chat(client, 1, nick, address, message);
02598 }


Generated on Thu Apr 16 06:47:09 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6