Mon Jun 27 16:50:57 2011

Asterisk developer's documentation


sig_ss7.h

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 2010 Digium, Inc.
00005  *
00006  * Richard Mudgett <rmudgett@digium.com>
00007  *
00008  * See http://www.asterisk.org for more information about
00009  * the Asterisk project. Please do not directly contact
00010  * any of the maintainers of this project for assistance;
00011  * the project provides a web site, mailing lists and IRC
00012  * channels for your use.
00013  *
00014  * This program is free software, distributed under the terms of
00015  * the GNU General Public License Version 2. See the LICENSE file
00016  * at the top of the source tree.
00017  */
00018 
00019 /*!
00020  * \file
00021  * \brief Interface header for SS7 signaling module.
00022  *
00023  * \author Matthew Fredrickson <creslin@digium.com>
00024  * \author Richard Mudgett <rmudgett@digium.com>
00025  *
00026  * See Also:
00027  * \arg \ref AstCREDITS
00028  */
00029 
00030 #ifndef _ASTERISK_SIG_SS7_H
00031 #define _ASTERISK_SIG_SS7_H
00032 
00033 #include "asterisk/channel.h"
00034 #include <libss7.h>
00035 
00036 #ifdef __cplusplus
00037 extern "C" {
00038 #endif
00039 
00040 /* ------------------------------------------------------------------- */
00041 
00042 /*! SS7 debug message flags when SS7 debugging is turned on at the command line. */
00043 #define SIG_SS7_DEBUG   \
00044    (SS7_DEBUG_MTP2 | SS7_DEBUG_MTP3 | SS7_DEBUG_ISUP)
00045 
00046 #if 0
00047 /*! SS7 debug message flags set on initial startup. */
00048 #define SIG_SS7_DEBUG_DEFAULT SIG_SS7_DEBUG
00049 #else
00050 /*! SS7 debug message flags set on initial startup. */
00051 #define SIG_SS7_DEBUG_DEFAULT 0
00052 #endif
00053 
00054 /* ------------------------------------------------------------------- */
00055 
00056 #define SIG_SS7_NUM_DCHANS    4     /*!< No more than 4 d-channels */
00057 #define SIG_SS7_MAX_CHANNELS  672      /*!< No more than a DS3 per trunk group */
00058 
00059 #define SIG_SS7      (0x1000000 | DAHDI_SIG_CLEAR)
00060 
00061 #define LINKSTATE_INALARM  (1 << 0)
00062 #define LINKSTATE_STARTING (1 << 1)
00063 #define LINKSTATE_UP    (1 << 2)
00064 #define LINKSTATE_DOWN     (1 << 3)
00065 
00066 #define SS7_NAI_DYNAMIC    -1
00067 
00068 #define LINKSET_FLAG_EXPLICITACM (1 << 0)
00069 
00070 
00071 enum sig_ss7_tone {
00072    SIG_SS7_TONE_RINGTONE = 0,
00073    SIG_SS7_TONE_STUTTER,
00074    SIG_SS7_TONE_CONGESTION,
00075    SIG_SS7_TONE_DIALTONE,
00076    SIG_SS7_TONE_DIALRECALL,
00077    SIG_SS7_TONE_INFO,
00078    SIG_SS7_TONE_BUSY,
00079 };
00080 
00081 enum sig_ss7_law {
00082    SIG_SS7_DEFLAW = 0,
00083    SIG_SS7_ULAW,
00084    SIG_SS7_ALAW
00085 };
00086 
00087 /*! Call establishment life cycle level for simple comparisons. */
00088 enum sig_ss7_call_level {
00089    /*! Call does not exist. */
00090    SIG_SS7_CALL_LEVEL_IDLE,
00091    /*! Call is present but has no response yet. (SETUP) */
00092    SIG_SS7_CALL_LEVEL_SETUP,
00093    /*! Call routing is happening. (PROCEEDING) */
00094    SIG_SS7_CALL_LEVEL_PROCEEDING,
00095    /*! Called party is being alerted of the call. (ALERTING) */
00096    SIG_SS7_CALL_LEVEL_ALERTING,
00097    /*! Call is connected/answered. (CONNECT) */
00098    SIG_SS7_CALL_LEVEL_CONNECT,
00099 };
00100 
00101 struct sig_ss7_linkset;
00102 
00103 struct sig_ss7_callback {
00104    /* Unlock the private in the signaling private structure. */
00105    void (* const unlock_private)(void *pvt);
00106    /* Lock the private in the signaling private structure. */
00107    void (* const lock_private)(void *pvt);
00108 
00109    int (* const set_echocanceller)(void *pvt, int enable);
00110    void (* const set_loopback)(void *pvt, int enable);
00111 
00112    struct ast_channel * (* const new_ast_channel)(void *pvt, int state, enum sig_ss7_law law, char *exten, const struct ast_channel *requestor);
00113    int (* const play_tone)(void *pvt, enum sig_ss7_tone tone);
00114 
00115    void (* const handle_link_exception)(struct sig_ss7_linkset *linkset, int which);
00116    void (* const set_alarm)(void *pvt, int in_alarm);
00117    void (* const set_dialing)(void *pvt, int is_dialing);
00118    void (* const set_digital)(void *pvt, int is_digital);
00119    void (* const set_inservice)(void *pvt, int is_inservice);
00120    void (* const set_locallyblocked)(void *pvt, int is_blocked);
00121    void (* const set_remotelyblocked)(void *pvt, int is_blocked);
00122    void (* const set_callerid)(void *pvt, const struct ast_party_caller *caller);
00123    void (* const set_dnid)(void *pvt, const char *dnid);
00124 
00125    void (* const queue_control)(void *pvt, int subclass);
00126 };
00127 
00128 struct sig_ss7_chan {
00129    struct sig_ss7_callback *calls;
00130    void *chan_pvt;               /*!< Private structure of the user of this module. */
00131    struct sig_ss7_linkset *ss7;
00132    struct ast_channel *owner;
00133 
00134    /*! \brief Opaque libss7 call control structure */
00135    struct isup_call *ss7call;
00136 
00137    /*! Call establishment life cycle level for simple comparisons. */
00138    enum sig_ss7_call_level call_level;
00139 
00140    int channel;               /*!< Channel Number */
00141    int cic;                /*!< CIC associated with channel */
00142    unsigned int dpc;          /*!< CIC's DPC */
00143 
00144    /* Options to be set by user */
00145    /*!
00146     * \brief Number of most significant digits/characters to strip from the dialed number.
00147     * \note Feature is deprecated.  Use dialplan logic.
00148     */
00149    int stripmsd;
00150    /*!
00151     * \brief TRUE if the outgoing caller ID is blocked/hidden.
00152     */
00153    unsigned int hidecallerid:1;
00154    /*! \brief TRUE if caller ID is used on this channel. */
00155    unsigned int use_callerid:1;
00156    /*!
00157     * \brief TRUE if we will use the calling presentation setting
00158     * from the Asterisk channel for outgoing calls.
00159     */
00160    unsigned int use_callingpres:1;
00161    unsigned int immediate:1;     /*!< Answer before getting digits? */
00162 
00163    /*! \brief TRUE if the channel is locally blocked.  Set by user and link. */
00164    unsigned int locallyblocked:1;
00165    /*! \brief TRUE if the channel is remotely blocked.  Set by user and link. */
00166    unsigned int remotelyblocked:1;
00167 
00168    char context[AST_MAX_CONTEXT];
00169    char mohinterpret[MAX_MUSICCLASS];
00170 
00171    /* Options to be checked by user */
00172    int cid_ani2;              /*!< Automatic Number Identification number (Alternate PRI caller ID number) */
00173    int cid_ton;               /*!< Type Of Number (TON) */
00174    int callingpres;           /*!< The value of calling presentation that we're going to use when placing a PRI call */
00175    char cid_num[AST_MAX_EXTENSION];
00176    char cid_subaddr[AST_MAX_EXTENSION];/*!< XXX SS7 may not support. */
00177    char cid_name[AST_MAX_EXTENSION];
00178    char cid_ani[AST_MAX_EXTENSION];
00179    char exten[AST_MAX_EXTENSION];
00180 
00181    /* Options to be checked by user that are stuffed into channel variables. */
00182    char charge_number[50];
00183    char gen_add_number[50];
00184    char gen_dig_number[50];
00185    char orig_called_num[50];
00186    char redirecting_num[50];
00187    char generic_name[50];
00188    unsigned char gen_add_num_plan;
00189    unsigned char gen_add_nai;
00190    unsigned char gen_add_pres_ind;
00191    unsigned char gen_add_type;
00192    unsigned char gen_dig_type;
00193    unsigned char gen_dig_scheme;
00194    char jip_number[50];
00195 #if 0
00196    unsigned char lspi_type;
00197    unsigned char lspi_scheme;
00198    unsigned char lspi_context;
00199 #endif
00200    char lspi_ident[50];
00201    unsigned int call_ref_ident;
00202    unsigned int call_ref_pc;
00203    unsigned char calling_party_cat;
00204 
00205    /*
00206     * Channel status bits.
00207     */
00208    /*! TRUE if channel is associated with a link that is down. */
00209    unsigned int inalarm:1;
00210    /*! TRUE if this channel is being used for an outgoing call. */
00211    unsigned int outgoing:1;
00212    /*! \brief TRUE if the call has seen inband-information progress through the network. */
00213    unsigned int progress:1;
00214    /*! \brief TRUE if the call has already gone/hungup */
00215    unsigned int alreadyhungup:1;
00216    /*! \brief XXX BOOLEAN Purpose??? */
00217    unsigned int rlt:1;
00218    /*! TRUE if this channel is in loopback. */
00219    unsigned int loopedback:1;
00220 };
00221 
00222 struct sig_ss7_linkset {
00223    pthread_t master;             /*!< Thread of master */
00224    ast_mutex_t lock;             /*!< libss7 access lock */
00225    struct sig_ss7_callback *calls;
00226    struct ss7 *ss7;
00227    struct sig_ss7_chan *pvts[SIG_SS7_MAX_CHANNELS];/*!< Member channel pvt structs */
00228    int fds[SIG_SS7_NUM_DCHANS];
00229    int numsigchans;
00230    int linkstate[SIG_SS7_NUM_DCHANS];
00231    int numchans;
00232    int span;                     /*!< span number put into user output messages */
00233    enum {
00234       LINKSET_STATE_DOWN = 0,
00235       LINKSET_STATE_UP
00236    } state;
00237 
00238    /* Options to be set by user */
00239    int flags;                    /*!< Linkset flags (LINKSET_FLAG_EXPLICITACM) */
00240    int type;                     /*!< SS7 type ITU/ANSI. Used for companding selection. */
00241    char called_nai;              /*!< Called Nature of Address Indicator */
00242    char calling_nai;             /*!< Calling Nature of Address Indicator */
00243    char internationalprefix[10];    /*!< country access code ('00' for european dialplans) */
00244    char nationalprefix[10];         /*!< area access code ('0' for european dialplans) */
00245    char subscriberprefix[20];       /*!< area access code + area code ('0'+area code for european dialplans) */
00246    char unknownprefix[20];          /*!< for unknown dialplans */
00247 };
00248 
00249 void sig_ss7_set_alarm(struct sig_ss7_chan *p, int in_alarm);
00250 
00251 void *ss7_linkset(void *data);
00252 
00253 void sig_ss7_link_alarm(struct sig_ss7_linkset *linkset, int which);
00254 void sig_ss7_link_noalarm(struct sig_ss7_linkset *linkset, int which);
00255 int sig_ss7_add_sigchan(struct sig_ss7_linkset *linkset, int which, int ss7type, int transport, int inalarm, int networkindicator, int pointcode, int adjpointcode);
00256 
00257 int sig_ss7_available(struct sig_ss7_chan *p);
00258 int sig_ss7_call(struct sig_ss7_chan *p, struct ast_channel *ast, char *rdest);
00259 int sig_ss7_hangup(struct sig_ss7_chan *p, struct ast_channel *ast);
00260 int sig_ss7_answer(struct sig_ss7_chan *p, struct ast_channel *ast);
00261 void sig_ss7_fixup(struct ast_channel *oldchan, struct ast_channel *newchan, struct sig_ss7_chan *pchan);
00262 int sig_ss7_indicate(struct sig_ss7_chan *p, struct ast_channel *chan, int condition, const void *data, size_t datalen);
00263 struct ast_channel *sig_ss7_request(struct sig_ss7_chan *p, enum sig_ss7_law law, const struct ast_channel *requestor, int transfercapability);
00264 void sig_ss7_chan_delete(struct sig_ss7_chan *doomed);
00265 struct sig_ss7_chan *sig_ss7_chan_new(void *pvt_data, struct sig_ss7_callback *callback, struct sig_ss7_linkset *ss7);
00266 void sig_ss7_init_linkset(struct sig_ss7_linkset *ss7);
00267 
00268 
00269 /* ------------------------------------------------------------------- */
00270 
00271 #ifdef __cplusplus
00272 }
00273 #endif
00274 
00275 #endif   /* _ASTERISK_SIG_SS7_H */
00276 /* ------------------------------------------------------------------- */
00277 /* end sig_ss7.h */

Generated on Mon Jun 27 16:50:57 2011 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7