188 lines
6.9 KiB
C
188 lines
6.9 KiB
C
/*
|
|
* mod_rayo for FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application
|
|
* Copyright (C) 2013, Grasshopper
|
|
*
|
|
* Version: MPL 1.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is mod_rayo for FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application
|
|
*
|
|
* The Initial Developer of the Original Code is Grasshopper
|
|
* Portions created by the Initial Developer are Copyright (C)
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Chris Rienzo <chris.rienzo@grasshopper.com>
|
|
*
|
|
* mod_rayo.h -- Rayo server / node implementation. Allows MxN clustering of FreeSWITCH and Rayo Clients (like Adhearsion)
|
|
*
|
|
*/
|
|
#ifndef MOD_RAYO_H
|
|
#define MOD_RAYO_H
|
|
|
|
#include <switch.h>
|
|
#include <iksemel.h>
|
|
|
|
#include "iks_helpers.h"
|
|
|
|
#define RAYO_VERSION "1"
|
|
#define RAYO_BASE "urn:xmpp:rayo:"
|
|
|
|
#define RAYO_NS RAYO_BASE RAYO_VERSION
|
|
#define RAYO_CLIENT_NS RAYO_BASE "client:" RAYO_VERSION
|
|
#define RAYO_CALL_NS RAYO_BASE "call:" RAYO_VERSION
|
|
#define RAYO_MIXER_NS RAYO_BASE "mixer:" RAYO_VERSION
|
|
|
|
#define RAYO_CPA_BASE RAYO_BASE "cpa:"
|
|
#define RAYO_CPA_NS RAYO_CPA_BASE RAYO_VERSION
|
|
|
|
#define RAT_CALL "CALL"
|
|
#define RAT_COMPONENT "COMPONENT"
|
|
#define RAT_CALL_COMPONENT RAT_COMPONENT"_CALL"
|
|
#define RAT_MIXER "MIXER"
|
|
#define RAT_MIXER_COMPONENT RAT_COMPONENT"_MIXER"
|
|
#define RAT_SERVER "SERVER"
|
|
#define RAT_PEER_SERVER "PEER_SERVER"
|
|
#define RAT_CLIENT "CLIENT"
|
|
|
|
struct rayo_actor;
|
|
struct rayo_call;
|
|
struct rayo_mixer;
|
|
struct rayo_component;
|
|
|
|
/**
|
|
* A message sent to an actor
|
|
*/
|
|
struct rayo_message {
|
|
iks *payload;
|
|
char *to_jid;
|
|
iksid *to;
|
|
char *from_jid;
|
|
iksid *from;
|
|
char *from_type;
|
|
char *from_subtype;
|
|
int is_reply;
|
|
char *file;
|
|
int line;
|
|
};
|
|
|
|
typedef void (* rayo_actor_cleanup_fn)(struct rayo_actor *);
|
|
typedef void (* rayo_actor_send_fn)(struct rayo_actor *, struct rayo_message *);
|
|
|
|
/**
|
|
* A rayo actor - this is an entity that can be controlled by a rayo client
|
|
*/
|
|
struct rayo_actor {
|
|
/** Type of actor */
|
|
char *type;
|
|
/** Sub-type of actor */
|
|
char *subtype;
|
|
/** domain part of JID */
|
|
char *domain;
|
|
/** Internal ID */
|
|
char *id;
|
|
/** actor JID */
|
|
char *jid;
|
|
/** Actor pool */
|
|
switch_memory_pool_t *pool;
|
|
/** synchronizes access to this actor */
|
|
switch_mutex_t *mutex;
|
|
/** an atomically incrementing sequence for this actor */
|
|
int seq;
|
|
/** number of users of this actor */
|
|
int ref_count;
|
|
/** destroy flag */
|
|
int destroy;
|
|
/** XMPP message handling function */
|
|
rayo_actor_send_fn send_fn;
|
|
/** optional cleanup */
|
|
rayo_actor_cleanup_fn cleanup_fn;
|
|
/** optional parent */
|
|
struct rayo_actor *parent;
|
|
};
|
|
|
|
/**
|
|
* A Rayo component
|
|
*/
|
|
struct rayo_component {
|
|
/** base actor class */
|
|
struct rayo_actor base;
|
|
/** owning client JID */
|
|
const char *client_jid;
|
|
/** external ref */
|
|
const char *ref;
|
|
/** true if component has completed */
|
|
int complete;
|
|
};
|
|
|
|
#define RAYO_ACTOR(x) ((struct rayo_actor *)x)
|
|
#define RAYO_COMPONENT(x) ((struct rayo_component *)x)
|
|
#define RAYO_CALL(x) ((struct rayo_call *)x)
|
|
#define RAYO_MIXER(x) ((struct rayo_mixer *)x)
|
|
|
|
extern void rayo_message_send(struct rayo_actor *from, const char *to, iks *payload, int dup, int reply, const char *file, int line);
|
|
extern void rayo_message_destroy(struct rayo_message *msg);
|
|
extern iks *rayo_message_remove_payload(struct rayo_message *msg);
|
|
#define RAYO_SEND_MESSAGE(from, to, payload) rayo_message_send(RAYO_ACTOR(from), to, payload, 0, 0, __FILE__, __LINE__)
|
|
#define RAYO_SEND_MESSAGE_DUP(from, to, payload) rayo_message_send(RAYO_ACTOR(from), to, payload, 1, 0, __FILE__, __LINE__)
|
|
#define RAYO_SEND_REPLY(from, to, payload) rayo_message_send(RAYO_ACTOR(from), to, payload, 0, 1, __FILE__, __LINE__)
|
|
#define RAYO_SEND_REPLY_DUP(from, to, payload) rayo_message_send(RAYO_ACTOR(from), to, payload, 1, 1, __FILE__, __LINE__)
|
|
|
|
extern struct rayo_actor *rayo_actor_locate(const char *jid, const char *file, int line);
|
|
extern struct rayo_actor *rayo_actor_locate_by_id(const char *id, const char *file, int line);
|
|
extern int rayo_actor_seq_next(struct rayo_actor *actor);
|
|
extern void rayo_actor_retain(struct rayo_actor *actor, const char *file, int line);
|
|
extern void rayo_actor_release(struct rayo_actor *actor, const char *file, int line);
|
|
extern void rayo_actor_destroy(struct rayo_actor *actor, const char *file, int line);
|
|
|
|
#define RAYO_LOCATE(jid) rayo_actor_locate(jid, __FILE__, __LINE__)
|
|
#define RAYO_LOCATE_BY_ID(id) rayo_actor_locate_by_id(id, __FILE__, __LINE__)
|
|
#define RAYO_SET_EVENT_FN(actor, event) rayo_actor_set_event_fn(RAYO_ACTOR(actor), event)
|
|
#define RAYO_DOMAIN(x) RAYO_ACTOR(x)->domain
|
|
#define RAYO_JID(x) RAYO_ACTOR(x)->jid
|
|
#define RAYO_ID(x) RAYO_ACTOR(x)->id
|
|
#define RAYO_POOL(x) RAYO_ACTOR(x)->pool
|
|
#define RAYO_RETAIN(x) rayo_actor_retain(RAYO_ACTOR(x), __FILE__, __LINE__)
|
|
#define RAYO_RELEASE(x) rayo_actor_release(RAYO_ACTOR(x), __FILE__, __LINE__)
|
|
#define RAYO_DESTROY(x) rayo_actor_destroy(RAYO_ACTOR(x), __FILE__, __LINE__)
|
|
#define RAYO_SEQ_NEXT(x) rayo_actor_seq_next(RAYO_ACTOR(x))
|
|
|
|
extern int rayo_call_is_joined(struct rayo_call *call);
|
|
extern int rayo_call_is_faxing(struct rayo_call *call);
|
|
extern void rayo_call_set_faxing(struct rayo_call *call, int faxing);
|
|
extern const char *rayo_call_get_dcp_jid(struct rayo_call *call);
|
|
|
|
#define rayo_mixer_get_name(mixer) RAYO_ID(mixer)
|
|
|
|
#define rayo_component_init(component, pool, type, subtype, id, parent, client_jid) _rayo_component_init(component, pool, type, subtype, id, parent, client_jid, NULL, __FILE__, __LINE__)
|
|
#define rayo_component_init_cleanup(component, pool, type, subtype, id, parent, client_jid, cleanup) _rayo_component_init(component, pool, type, subtype, id, parent, client_jid, cleanup, __FILE__, __LINE__)
|
|
extern struct rayo_component *_rayo_component_init(struct rayo_component *component, switch_memory_pool_t *pool, const char *type, const char *subtype, const char *id, struct rayo_actor *parent, const char *client_jid, rayo_actor_cleanup_fn cleanup, const char *file, int line);
|
|
extern switch_bool_t is_component_actor(struct rayo_actor *);
|
|
|
|
typedef iks *(*rayo_actor_xmpp_handler)(struct rayo_actor *, struct rayo_message *, void *);
|
|
extern void rayo_actor_command_handler_add(const char *type, const char *subtype, const char *name, rayo_actor_xmpp_handler fn);
|
|
extern void rayo_actor_event_handler_add(const char *from_type, const char *from_subtype, const char *to_type, const char *to_subtype, const char *name, rayo_actor_xmpp_handler fn);
|
|
|
|
#endif
|
|
|
|
|
|
/* For Emacs:
|
|
* Local Variables:
|
|
* mode:c
|
|
* indent-tabs-mode:t
|
|
* tab-width:4
|
|
* c-basic-offset:4
|
|
* End:
|
|
* For VIM:
|
|
* vim:set softtabstop=4 shiftwidth=4 tabstop=4 noet
|
|
*/
|