Wed Oct 28 11:46:12 2009

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_JIDLEN   3071
#define AJI_MAX_RESJIDLEN   1023
#define IKS_NET_EXPIRED   12
#define NET_IO_BUF_SIZE   4096

Enumerations

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

Functions

int ast_aji_check_roster (void)
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 (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)
 join 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.


Detailed Description

AJI - The Asterisk Jabber Interface.

Definition in file jabber.h.


Define Documentation

#define AJI_MAX_JIDLEN   3071

Definition at line 73 of file jabber.h.

Referenced by gtalk_show_channels(), and jingle_show_channels().

#define AJI_MAX_RESJIDLEN   1023

Definition at line 74 of file jabber.h.

#define IKS_NET_EXPIRED   12

Definition at line 57 of file jabber.h.

Referenced by aji_recv(), and aji_recv_loop().

#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 

Definition at line 83 of file jabber.h.

00083      {
00084    AJI_AUTOPRUNE = (1 << 0),
00085    AJI_AUTOREGISTER = (1 << 1)
00086 };

enum aji_btype

Enumerator:
AJI_USER 
AJI_TRANS 
AJI_UTRANS 

Definition at line 88 of file jabber.h.

00088                {
00089    AJI_USER=0,
00090    AJI_TRANS=1,
00091    AJI_UTRANS=2
00092 };

enum aji_state

Enumerator:
AJI_DISCONNECTING 
AJI_DISCONNECTED 
AJI_CONNECTING 
AJI_CONNECTED 

Definition at line 76 of file jabber.h.

00076                {
00077    AJI_DISCONNECTING,
00078    AJI_DISCONNECTED,
00079    AJI_CONNECTING,
00080    AJI_CONNECTED
00081 };


Function Documentation

int ast_aji_check_roster ( void   ) 

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 1814 of file res_jabber.c.

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

01815 {
01816    int res = 0;
01817    iks *iq = NULL;
01818    iq = iks_new("iq");
01819 
01820    if (iq && client) {
01821       iks_insert_attrib(iq, "type", "get");
01822       iks_insert_attrib(iq, "to", server);
01823       iks_insert_attrib(iq, "id", client->mid);
01824       ast_aji_increment_mid(client->mid);
01825       ast_aji_send(client, iq);
01826    } else 
01827       ast_log(LOG_ERROR, "Out of memory.\n");
01828 
01829    iks_delete(iq);
01830 
01831    return res;
01832 }

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 2300 of file res_jabber.c.

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

Referenced by unload_module().

02301 {
02302    if (client) {
02303       ast_verb(4, "JABBER: Disconnecting\n");
02304 #ifdef HAVE_OPENSSL
02305       if (client->stream_flags & SECURE) {
02306          SSL_shutdown(client->ssl_session);
02307          SSL_CTX_free(client->ssl_context);
02308          SSL_free(client->ssl_session);
02309       }
02310 #endif
02311       iks_disconnect(client->p);
02312       iks_parser_delete(client->p);
02313       ASTOBJ_UNREF(client, aji_client_destroy);
02314    }
02315 
02316    return 1;
02317 }

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

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

Parameters:
name label or JID
Returns:
aji_client.

Definition at line 2922 of file res_jabber.c.

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

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

02923 {
02924    struct aji_client *client = NULL;
02925    char *aux = NULL;
02926 
02927    client = ASTOBJ_CONTAINER_FIND(&clients, name);
02928    if (!client && strchr(name, '@')) {
02929       ASTOBJ_CONTAINER_TRAVERSE(&clients, 1, {
02930          aux = ast_strdupa(iterator->user);
02931          if (strchr(aux, '/')) {
02932             /* strip resource for comparison */
02933             aux = strsep(&aux, "/");
02934          }
02935          if (!strncasecmp(aux, name, strlen(aux))) {
02936             client = iterator;
02937          }           
02938       });
02939    }
02940 
02941    return client;
02942 }

struct aji_client_container* ast_aji_get_clients ( void   )  [read]

Definition at line 2944 of file res_jabber.c.

References clients.

Referenced by gtalk_load_config(), and jingle_load_config().

02945 {
02946    return &clients;
02947 }

void ast_aji_increment_mid ( char *  mid  ) 

increments the mid field for messages and other events.

Parameters:
mid char.
Returns:
void.

Definition at line 1958 of file res_jabber.c.

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

01959 {
01960    int i = 0;
01961 
01962    for (i = strlen(mid) - 1; i >= 0; i--) {
01963       if (mid[i] != 'z') {
01964          mid[i] = mid[i] + 1;
01965          i = 0;
01966       } else
01967          mid[i] = 'a';
01968    }
01969 }

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 1871 of file res_jabber.c.

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

01872 {
01873    int res = 0;
01874    iks *invite, *body, *namespace;
01875 
01876    invite = iks_new("message");
01877    body = iks_new("body");
01878    namespace = iks_new("x");
01879    if (client && invite && body && namespace) {
01880       iks_insert_attrib(invite, "to", user);
01881       iks_insert_attrib(invite, "id", client->mid);
01882       ast_aji_increment_mid(client->mid);
01883       iks_insert_cdata(body, message, 0);
01884       iks_insert_attrib(namespace, "xmlns", "jabber:x:conference");
01885       iks_insert_attrib(namespace, "jid", room);
01886       iks_insert_node(invite, body);
01887       iks_insert_node(invite, namespace);
01888       res = ast_aji_send(client, invite);
01889    } else 
01890       ast_log(LOG_ERROR, "Out of memory.\n");
01891 
01892    iks_delete(body);
01893    iks_delete(namespace);
01894    iks_delete(invite);
01895    
01896    return res;
01897 }

int ast_aji_join_chat ( struct aji_client client,
char *  room 
)

join a chatroom.

Join existing Chat session

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

Definition at line 1840 of file res_jabber.c.

References ast_aji_send(), ast_log(), and LOG_ERROR.

01841 {
01842    int res = 0;
01843    iks *presence = NULL, *priority = NULL;
01844    presence = iks_new("presence");
01845    priority = iks_new("priority");
01846    if (presence && priority && client) {
01847       iks_insert_cdata(priority, "0", 1);
01848       iks_insert_attrib(presence, "to", room);
01849       iks_insert_node(presence, priority);
01850       res = ast_aji_send(client, presence);
01851       iks_insert_cdata(priority, "5", 1);
01852       iks_insert_attrib(presence, "to", room);
01853       res = ast_aji_send(client, presence);
01854    } else 
01855       ast_log(LOG_ERROR, "Out of memory.\n");
01856    
01857    iks_delete(presence);
01858    iks_delete(priority);
01859    
01860    return res;
01861 }

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 
Returns:
1.

Definition at line 1787 of file res_jabber.c.

References AJI_CONNECTED, ast_aji_send(), ast_log(), aji_client::jid, LOG_ERROR, LOG_WARNING, and aji_client::state.

Referenced by aji_send_exec(), aji_test(), and manager_jabber_send().

01788 {
01789    int res = 0;
01790    iks *message_packet = NULL;
01791    if (client->state == AJI_CONNECTED) {
01792       message_packet = iks_make_msg(IKS_TYPE_CHAT, address, message);
01793       if (message_packet) {
01794          iks_insert_attrib(message_packet, "from", client->jid->full);
01795          res = ast_aji_send(client, message_packet);
01796       } else {
01797          ast_log(LOG_ERROR, "Out of memory.\n");
01798       }
01799 
01800       iks_delete(message_packet);
01801    } else
01802       ast_log(LOG_WARNING, "JABBER: Not connected can't send\n");
01803    return 1;
01804 }


Generated on Wed Oct 28 11:46:12 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6