Tue Aug 20 16:34:39 2013

Asterisk developer's documentation


sig_pri.h

Go to the documentation of this file.
00001 #ifndef _SIG_PRI_H
00002 #define _SIG_PRI_H
00003 /*
00004  * Asterisk -- An open source telephony toolkit.
00005  *
00006  * Copyright (C) 1999 - 2009, Digium, Inc.
00007  *
00008  * Mark Spencer <markster@digium.com>
00009  *
00010  * See http://www.asterisk.org for more information about
00011  * the Asterisk project. Please do not directly contact
00012  * any of the maintainers of this project for assistance;
00013  * the project provides a web site, mailing lists and IRC
00014  * channels for your use.
00015  *
00016  * This program is free software, distributed under the terms of
00017  * the GNU General Public License Version 2. See the LICENSE file
00018  * at the top of the source tree.
00019  */
00020 
00021 /*! \file
00022  *
00023  * \brief Interface header for PRI signaling module
00024  *
00025  * \author Matthew Fredrickson <creslin@digium.com>
00026  */
00027 
00028 #include "asterisk/channel.h"
00029 #include "asterisk/frame.h"
00030 #include "asterisk/event.h"
00031 #include "asterisk/ccss.h"
00032 #include <libpri.h>
00033 #include <dahdi/user.h>
00034 
00035 #if defined(HAVE_PRI_CCSS)
00036 /*! PRI debug message flags when normal PRI debugging is turned on at the command line. */
00037 #define SIG_PRI_DEBUG_NORMAL  \
00038    (PRI_DEBUG_APDU | PRI_DEBUG_Q931_DUMP | PRI_DEBUG_Q931_STATE | PRI_DEBUG_Q921_STATE \
00039    | PRI_DEBUG_CC)
00040 
00041 /*! PRI debug message flags when intense PRI debugging is turned on at the command line. */
00042 #define SIG_PRI_DEBUG_INTENSE \
00043    (PRI_DEBUG_APDU | PRI_DEBUG_Q931_DUMP | PRI_DEBUG_Q931_STATE | PRI_DEBUG_Q921_STATE \
00044    | PRI_DEBUG_CC | PRI_DEBUG_Q921_RAW | PRI_DEBUG_Q921_DUMP)
00045 
00046 #else
00047 
00048 /*! PRI debug message flags when normal PRI debugging is turned on at the command line. */
00049 #define SIG_PRI_DEBUG_NORMAL  \
00050    (PRI_DEBUG_APDU | PRI_DEBUG_Q931_DUMP | PRI_DEBUG_Q931_STATE | PRI_DEBUG_Q921_STATE)
00051 
00052 /*! PRI debug message flags when intense PRI debugging is turned on at the command line. */
00053 #define SIG_PRI_DEBUG_INTENSE \
00054    (PRI_DEBUG_APDU | PRI_DEBUG_Q931_DUMP | PRI_DEBUG_Q931_STATE | PRI_DEBUG_Q921_STATE \
00055    | PRI_DEBUG_Q921_RAW | PRI_DEBUG_Q921_DUMP)
00056 #endif   /* !defined(HAVE_PRI_CCSS) */
00057 
00058 #if 0
00059 /*! PRI debug message flags set on initial startup. */
00060 #define SIG_PRI_DEBUG_DEFAULT SIG_PRI_DEBUG_NORMAL
00061 #else
00062 /*! PRI debug message flags set on initial startup. */
00063 #define SIG_PRI_DEBUG_DEFAULT 0
00064 #endif
00065 
00066 #define SIG_PRI_AOC_GRANT_S    (1 << 0)
00067 #define SIG_PRI_AOC_GRANT_D    (1 << 1)
00068 #define SIG_PRI_AOC_GRANT_E    (1 << 2)
00069 
00070 enum sig_pri_tone {
00071    SIG_PRI_TONE_RINGTONE = 0,
00072    SIG_PRI_TONE_STUTTER,
00073    SIG_PRI_TONE_CONGESTION,
00074    SIG_PRI_TONE_DIALTONE,
00075    SIG_PRI_TONE_DIALRECALL,
00076    SIG_PRI_TONE_INFO,
00077    SIG_PRI_TONE_BUSY,
00078 };
00079 
00080 enum sig_pri_law {
00081    SIG_PRI_DEFLAW = 0,
00082    SIG_PRI_ULAW,
00083    SIG_PRI_ALAW
00084 };
00085 
00086 /*! Call establishment life cycle level for simple comparisons. */
00087 enum sig_pri_call_level {
00088    /*! Call does not exist. */
00089    SIG_PRI_CALL_LEVEL_IDLE,
00090    /*! Call is present but has no response yet. (SETUP) */
00091    SIG_PRI_CALL_LEVEL_SETUP,
00092    /*! Call is collecting digits for overlap dialing. (SETUP ACKNOWLEDGE) */
00093    SIG_PRI_CALL_LEVEL_OVERLAP,
00094    /*! Call routing is happening. (PROCEEDING) */
00095    SIG_PRI_CALL_LEVEL_PROCEEDING,
00096    /*! Called party is being alerted of the call. (ALERTING) */
00097    SIG_PRI_CALL_LEVEL_ALERTING,
00098    /*! Call is dialing 'w' deferred digits. (CONNECT) */
00099    SIG_PRI_CALL_LEVEL_DEFER_DIAL,
00100    /*! Call is connected/answered. (CONNECT) */
00101    SIG_PRI_CALL_LEVEL_CONNECT,
00102 };
00103 
00104 enum sig_pri_reset_state {
00105    /*! \brief The channel is not being RESTARTed. */
00106    SIG_PRI_RESET_IDLE,
00107    /*!
00108     * \brief The channel is being RESTARTed.
00109     * \note Waiting for a RESTART ACKNOWLEDGE from the peer.
00110     */
00111    SIG_PRI_RESET_ACTIVE,
00112    /*!
00113     * \brief Peer may not be sending the expected RESTART ACKNOWLEDGE.
00114     *
00115     * \details We have already received a SETUP on this channel.
00116     * If another SETUP comes in on this channel then the peer
00117     * considers this channel useable.  Assume that the peer is
00118     * never going to give us a RESTART ACKNOWLEDGE and assume that
00119     * we have received one.  This is not according to Q.931, but
00120     * some peers occasionally fail to send a RESTART ACKNOWLEDGE.
00121     */
00122    SIG_PRI_RESET_NO_ACK,
00123 };
00124 
00125 struct sig_pri_span;
00126 
00127 struct sig_pri_callback {
00128    /* Unlock the private in the signalling private structure.  This is used for three way calling madness. */
00129    void (* const unlock_private)(void *pvt);
00130    /* Lock the private in the signalling private structure.  ... */
00131    void (* const lock_private)(void *pvt);
00132    /* Function which is called back to handle any other DTMF events that are received.  Called by analog_handle_event.  Why is this
00133     * important to use, instead of just directly using events received before they are passed into the library?  Because sometimes,
00134     * (CWCID) the library absorbs DTMF events received. */
00135    //void (* const handle_dtmf)(void *pvt, struct ast_channel *ast, enum analog_sub analog_index, struct ast_frame **dest);
00136 
00137    //int (* const dial_digits)(void *pvt, enum analog_sub sub, struct analog_dialoperation *dop);
00138    int (* const play_tone)(void *pvt, enum sig_pri_tone tone);
00139 
00140    int (* const set_echocanceller)(void *pvt, int enable);
00141    int (* const train_echocanceller)(void *pvt);
00142    int (* const dsp_reset_and_flush_digits)(void *pvt);
00143 
00144    struct ast_channel * (* const new_ast_channel)(void *pvt, int state, enum sig_pri_law law, char *exten, const struct ast_channel *chan);
00145 
00146    void (* const fixup_chans)(void *old_chan, void *new_chan);
00147 
00148    /* Note: Called with PRI lock held */
00149    void (* const handle_dchan_exception)(struct sig_pri_span *pri, int index);
00150    void (* const set_alarm)(void *pvt, int in_alarm);
00151    void (* const set_dialing)(void *pvt, int is_dialing);
00152    void (* const set_digital)(void *pvt, int is_digital);
00153    void (* const set_outgoing)(void *pvt, int is_outgoing);
00154    void (* const set_callerid)(void *pvt, const struct ast_party_caller *caller);
00155    void (* const set_dnid)(void *pvt, const char *dnid);
00156    void (* const set_rdnis)(void *pvt, const char *rdnis);
00157    void (* const queue_control)(void *pvt, int subclass);
00158    int (* const new_nobch_intf)(struct sig_pri_span *pri);
00159    void (* const init_config)(void *pvt, struct sig_pri_span *pri);
00160    const char *(* const get_orig_dialstring)(void *pvt);
00161    void (* const make_cc_dialstring)(void *pvt, char *buf, size_t buf_size);
00162    void (* const update_span_devstate)(struct sig_pri_span *pri);
00163    void (* const dial_digits)(void *pvt, const char *dial_string);
00164 
00165    void (* const open_media)(void *pvt);
00166 
00167    /*!
00168     * \brief Post an AMI B channel association event.
00169     *
00170     * \param pvt Private structure of the user of this module.
00171     * \param chan Channel associated with the private pointer
00172     *
00173     * \return Nothing
00174     */
00175    void (* const ami_channel_event)(void *pvt, struct ast_channel *chan);
00176 
00177    /*! Reference the parent module. */
00178    void (*module_ref)(void);
00179    /*! Unreference the parent module. */
00180    void (*module_unref)(void);
00181 };
00182 
00183 #define SIG_PRI_NUM_DCHANS    4     /*!< No more than 4 d-channels */
00184 #define SIG_PRI_MAX_CHANNELS  672      /*!< No more than a DS3 per trunk group */
00185 
00186 #define SIG_PRI      DAHDI_SIG_CLEAR
00187 #define SIG_BRI      (0x2000000 | DAHDI_SIG_CLEAR)
00188 #define SIG_BRI_PTMP (0X4000000 | DAHDI_SIG_CLEAR)
00189 
00190 /* QSIG channel mapping option types */
00191 #define DAHDI_CHAN_MAPPING_PHYSICAL 0
00192 #define DAHDI_CHAN_MAPPING_LOGICAL  1
00193 
00194 /* Overlap dialing option types */
00195 #define DAHDI_OVERLAPDIAL_NONE 0
00196 #define DAHDI_OVERLAPDIAL_OUTGOING 1
00197 #define DAHDI_OVERLAPDIAL_INCOMING 2
00198 #define DAHDI_OVERLAPDIAL_BOTH (DAHDI_OVERLAPDIAL_INCOMING|DAHDI_OVERLAPDIAL_OUTGOING)
00199 
00200 #if defined(HAVE_PRI_SERVICE_MESSAGES)
00201 /*! \brief Persistent Service State */
00202 #define SRVST_DBKEY "service-state"
00203 /*! \brief The out-of-service SERVICE state */
00204 #define SRVST_TYPE_OOS "O"
00205 /*! \brief SRVST_INITIALIZED is used to indicate a channel being out-of-service
00206  *  The SRVST_INITIALIZED is mostly used maintain backwards compatibility but also may
00207  *  mean that the channel has not yet received a RESTART message.  If a channel is
00208  *  out-of-service with this reason a RESTART message will result in the channel
00209  *  being put into service. */
00210 #define SRVST_INITIALIZED 0
00211 /*! \brief SRVST_NEAREND is used to indicate that the near end was put out-of-service */
00212 #define SRVST_NEAREND  (1 << 0)
00213 /*! \brief SRVST_FAREND is used to indicate that the far end was taken out-of-service */
00214 #define SRVST_FAREND   (1 << 1)
00215 /*! \brief SRVST_BOTH is used to indicate that both sides of the channel are out-of-service */
00216 #define SRVST_BOTH (SRVST_NEAREND | SRVST_FAREND)
00217 
00218 /*! \brief The AstDB family */
00219 static const char dahdi_db[] = "dahdi/registry";
00220 #endif   /* defined(HAVE_PRI_SERVICE_MESSAGES) */
00221 
00222 struct sig_pri_chan {
00223    /* Options to be set by user */
00224    unsigned int hidecallerid:1;
00225    unsigned int hidecalleridname:1;      /*!< Hide just the name not the number for legacy PBX use */
00226    unsigned int immediate:1;        /*!< Answer before getting digits? */
00227    unsigned int priexclusive:1;        /*!< Whether or not to override and use exculsive mode for channel selection */
00228    unsigned int priindication_oob:1;
00229    unsigned int use_callerid:1;        /*!< Whether or not to use caller id on this channel */
00230    unsigned int use_callingpres:1;        /*!< Whether to use the callingpres the calling switch sends */
00231    char context[AST_MAX_CONTEXT];
00232    char mohinterpret[MAX_MUSICCLASS];
00233    int stripmsd;
00234    int channel;               /*!< Channel Number or CRV */
00235 
00236    /* Options to be checked by user */
00237    int cid_ani2;                 /*!< Automatic Number Identification number (Alternate PRI caller ID number) */
00238    int cid_ton;               /*!< Type Of Number (TON) */
00239    int callingpres;           /*!< The value of calling presentation that we're going to use when placing a PRI call */
00240    char cid_num[AST_MAX_EXTENSION];
00241    char cid_subaddr[AST_MAX_EXTENSION];
00242    char cid_name[AST_MAX_EXTENSION];
00243    char cid_ani[AST_MAX_EXTENSION];
00244    /*! \brief User tag for party id's sent from this device driver. */
00245    char user_tag[AST_MAX_EXTENSION];
00246    char exten[AST_MAX_EXTENSION];
00247 
00248    /* Internal variables -- Don't touch */
00249    /* Probably will need DS0 number, DS1 number, and a few other things */
00250    char dialdest[256];           /* Queued up digits for overlap dialing.  They will be sent out as information messages when setup ACK is received */
00251 #if defined(HAVE_PRI_SETUP_KEYPAD)
00252    /*! \brief Keypad digits that came in with the SETUP message. */
00253    char keypad_digits[AST_MAX_EXTENSION];
00254 #endif   /* defined(HAVE_PRI_SETUP_KEYPAD) */
00255    /*! 'w' deferred dialing digits. */
00256    char deferred_digits[AST_MAX_EXTENSION];
00257 
00258 #if defined(HAVE_PRI_AOC_EVENTS)
00259    struct pri_subcmd_aoc_e aoc_e;
00260    int aoc_s_request_invoke_id;     /*!< If an AOC-S request was present for the call, this is the invoke_id to use for the response */
00261    unsigned int aoc_s_request_invoke_id_valid:1; /*!< This is set when the AOC-S invoke id is present */
00262    unsigned int waiting_for_aoce:1; /*!< Delaying hangup for AOC-E msg. If this is set and AOC-E is received, continue with hangup before timeout period. */
00263    unsigned int holding_aoce:1;     /*!< received AOC-E msg from asterisk. holding for disconnect/release */
00264 #endif   /* defined(HAVE_PRI_AOC_EVENTS) */
00265    unsigned int inalarm:1;
00266    unsigned int alreadyhungup:1; /*!< TRUE if the call has already gone/hungup */
00267    unsigned int isidlecall:1;    /*!< TRUE if this is an idle call */
00268    unsigned int progress:1;      /*!< TRUE if the call has seen inband-information progress through the network */
00269 
00270    /*!
00271     * \brief TRUE when this channel is allocated.
00272     *
00273     * \details
00274     * Needed to hold an outgoing channel allocation before the
00275     * owner pointer is created.
00276     *
00277     * \note This is one of several items to check to see if a
00278     * channel is available for use.
00279     */
00280    unsigned int allocated:1;
00281    unsigned int outgoing:1;
00282    unsigned int digital:1;
00283    /*! \brief TRUE if this interface has no B channel.  (call hold and call waiting) */
00284    unsigned int no_b_channel:1;
00285 #if defined(HAVE_PRI_CALL_WAITING)
00286    /*! \brief TRUE if this is a call waiting call */
00287    unsigned int is_call_waiting:1;
00288 #endif   /* defined(HAVE_PRI_CALL_WAITING) */
00289 
00290    struct ast_channel *owner;
00291 
00292    struct sig_pri_span *pri;
00293    q931_call *call;           /*!< opaque libpri call control structure */
00294 
00295    /*! Call establishment life cycle level for simple comparisons. */
00296    enum sig_pri_call_level call_level;
00297    /*! \brief Channel reset/restart state. */
00298    enum sig_pri_reset_state resetting;
00299    int prioffset;             /*!< channel number in span */
00300    int logicalspan;           /*!< logical span number within trunk group */
00301    int mastertrunkgroup;         /*!< what trunk group is our master */
00302 #if defined(HAVE_PRI_SERVICE_MESSAGES)
00303    /*! \brief Active SRVST_DBKEY out-of-service status value. */
00304    unsigned service_status;
00305 #endif   /* defined(HAVE_PRI_SERVICE_MESSAGES) */
00306 
00307    struct sig_pri_callback *calls;
00308    void *chan_pvt;               /*!< Private structure of the user of this module. */
00309 #if defined(HAVE_PRI_REVERSE_CHARGE)
00310    /*!
00311     * \brief Reverse charging indication
00312     * \details
00313     * -1 - No reverse charging,
00314     *  1 - Reverse charging,
00315     * 0,2-7 - Reserved for future use
00316     */
00317    int reverse_charging_indication;
00318 #endif
00319 };
00320 
00321 #if defined(HAVE_PRI_MWI)
00322 /*! Maximum number of mailboxes per span. */
00323 #define SIG_PRI_MAX_MWI_MAILBOXES         8
00324 /*! Typical maximum length of mwi mailbox number */
00325 #define SIG_PRI_MAX_MWI_MBOX_NUMBER_LEN      10 /* digits in number */
00326 /*! Typical maximum length of mwi mailbox context */
00327 #define SIG_PRI_MAX_MWI_CONTEXT_LEN       10
00328 /*!
00329  * \brief Maximum mwi_mailbox string length.
00330  * \details
00331  * max_length = #mailboxes * (mbox_number + '@' + context + ',')
00332  * The last ',' is a null terminator instead.
00333  */
00334 #define SIG_PRI_MAX_MWI_MAILBOX_STR    (SIG_PRI_MAX_MWI_MAILBOXES \
00335    * (SIG_PRI_MAX_MWI_MBOX_NUMBER_LEN + 1 + SIG_PRI_MAX_MWI_CONTEXT_LEN + 1))
00336 
00337 struct sig_pri_mbox {
00338    /*!
00339     * \brief MWI mailbox event subscription.
00340     * \note NULL if mailbox not configured.
00341     */
00342    struct ast_event_sub *sub;
00343    /*! \brief Mailbox number */
00344    const char *number;
00345    /*! \brief Mailbox context. */
00346    const char *context;
00347 };
00348 #endif   /* defined(HAVE_PRI_MWI) */
00349 
00350 struct sig_pri_span {
00351    /* Should be set by user */
00352    struct ast_cc_config_params *cc_params;         /*!< CC config parameters for each new call. */
00353    int   pritimers[PRI_MAX_TIMERS];
00354    int overlapdial;                       /*!< In overlap dialing mode */
00355    int qsigchannelmapping;                   /*!< QSIG channel mapping type */
00356    int discardremoteholdretrieval;              /*!< shall remote hold or remote retrieval notifications be discarded? */
00357    int facilityenable;                       /*!< Enable facility IEs */
00358 #if defined(HAVE_PRI_L2_PERSISTENCE)
00359    /*! Layer 2 persistence option. */
00360    int l2_persistence;
00361 #endif   /* defined(HAVE_PRI_L2_PERSISTENCE) */
00362    int dchan_logical_span[SIG_PRI_NUM_DCHANS];     /*!< Logical offset the DCHAN sits in */
00363    int fds[SIG_PRI_NUM_DCHANS];              /*!< FD's for d-channels */
00364 
00365 #if defined(HAVE_PRI_AOC_EVENTS)
00366    int aoc_passthrough_flag;                 /*!< Represents what AOC messages (S,D,E) are allowed to pass-through */
00367    unsigned int aoce_delayhangup:1;          /*!< defines whether the aoce_delayhangup option is enabled or not */
00368 #endif   /* defined(HAVE_PRI_AOC_EVENTS) */
00369 
00370 #if defined(HAVE_PRI_SERVICE_MESSAGES)
00371    unsigned int enable_service_message_support:1;  /*!< enable SERVICE message support */
00372 #endif   /* defined(HAVE_PRI_SERVICE_MESSAGES) */
00373 #ifdef HAVE_PRI_INBANDDISCONNECT
00374    unsigned int inbanddisconnect:1;          /*!< Should we support inband audio after receiving DISCONNECT? */
00375 #endif
00376 #if defined(HAVE_PRI_CALL_HOLD)
00377    /*! \brief TRUE if held calls are transferred on disconnect. */
00378    unsigned int hold_disconnect_transfer:1;
00379 #endif   /* defined(HAVE_PRI_CALL_HOLD) */
00380    /*!
00381     * \brief TRUE if call transfer is enabled for the span.
00382     * \note Support switch-side transfer (called 2BCT, RLT or other names)
00383     */
00384    unsigned int transfer:1;
00385 #if defined(HAVE_PRI_CALL_WAITING)
00386    /*! \brief TRUE if we will allow incoming ISDN call waiting calls. */
00387    unsigned int allow_call_waiting_calls:1;
00388 #endif   /* defined(HAVE_PRI_CALL_WAITING) */
00389    /*! TRUE if layer 1 alarm status is ignored */
00390    unsigned int layer1_ignored:1;
00391    /*!
00392     * TRUE if a new call's sig_pri_chan.user_tag[] has the MSN
00393     * appended to the initial_user_tag[].
00394     */
00395    unsigned int append_msn_to_user_tag:1;
00396    int dialplan;                    /*!< Dialing plan */
00397    int localdialplan;                  /*!< Local dialing plan */
00398    char internationalprefix[10];       /*!< country access code ('00' for european dialplans) */
00399    char nationalprefix[10];            /*!< area access code ('0' for european dialplans) */
00400    char localprefix[20];               /*!< area access code + area code ('0'+area code for european dialplans) */
00401    char privateprefix[20];             /*!< for private dialplans */
00402    char unknownprefix[20];             /*!< for unknown dialplans */
00403    long resetinterval;                 /*!< Interval (in seconds) for resetting unused channels */
00404 #if defined(HAVE_PRI_MWI)
00405    /*! \brief Active MWI mailboxes */
00406    struct sig_pri_mbox mbox[SIG_PRI_MAX_MWI_MAILBOXES];
00407    /*!
00408     * \brief Comma separated list of mailboxes to indicate MWI.
00409     * \note Empty if disabled.
00410     * \note Format: mailbox_number[@context]{,mailbox_number[@context]}
00411     * \note String is split apart when span is started.
00412     */
00413    char mwi_mailboxes[SIG_PRI_MAX_MWI_MAILBOX_STR];
00414 #endif   /* defined(HAVE_PRI_MWI) */
00415    /*!
00416     * \brief Initial user tag for party id's sent from this device driver.
00417     * \note String set by config file.
00418     */
00419    char initial_user_tag[AST_MAX_EXTENSION];
00420    char msn_list[AST_MAX_EXTENSION];      /*!< Comma separated list of MSNs to handle.  Empty if disabled. */
00421    char idleext[AST_MAX_EXTENSION];    /*!< Where to idle extra calls */
00422    char idlecontext[AST_MAX_CONTEXT];     /*!< What context to use for idle */
00423    char idledial[AST_MAX_EXTENSION];      /*!< What to dial before dumping */
00424    int minunused;                   /*!< Min # of channels to keep empty */
00425    int minidle;                     /*!< Min # of "idling" calls to keep active */
00426    int nodetype;                    /*!< Node type */
00427    int switchtype;                     /*!< Type of switch to emulate */
00428    int nsf;                      /*!< Network-Specific Facilities */
00429    int trunkgroup;                     /*!< What our trunkgroup is */
00430 #if defined(HAVE_PRI_CCSS)
00431    int cc_ptmp_recall_mode;            /*!< CC PTMP recall mode. globalRecall(0), specificRecall(1) */
00432    int cc_qsig_signaling_link_req;        /*!< CC Q.SIG signaling link retention (Party A) release(0), retain(1), do-not-care(2) */
00433    int cc_qsig_signaling_link_rsp;        /*!< CC Q.SIG signaling link retention (Party B) release(0), retain(1) */
00434 #endif   /* defined(HAVE_PRI_CCSS) */
00435 #if defined(HAVE_PRI_CALL_WAITING)
00436    /*!
00437     * \brief Number of extra outgoing calls to allow on a span before
00438     * considering that span congested.
00439     */
00440    int max_call_waiting_calls;
00441    struct {
00442       int stripmsd;
00443       unsigned int hidecallerid:1;
00444       unsigned int hidecalleridname:1;      /*!< Hide just the name not the number for legacy PBX use */
00445       unsigned int immediate:1;        /*!< Answer before getting digits? */
00446       unsigned int priexclusive:1;        /*!< Whether or not to override and use exculsive mode for channel selection */
00447       unsigned int priindication_oob:1;
00448       unsigned int use_callerid:1;        /*!< Whether or not to use caller id on this channel */
00449       unsigned int use_callingpres:1;        /*!< Whether to use the callingpres the calling switch sends */
00450       char context[AST_MAX_CONTEXT];
00451       char mohinterpret[MAX_MUSICCLASS];
00452    } ch_cfg;
00453 
00454    /*!
00455     * \brief Number of outstanding call waiting calls.
00456     * \note Must be zero to allow new calls from asterisk to
00457     * immediately allocate a B channel.
00458     */
00459    int num_call_waiting_calls;
00460 #endif   /* defined(HAVE_PRI_CALL_WAITING) */
00461    int dchanavail[SIG_PRI_NUM_DCHANS];    /*!< Whether each channel is available */
00462    int debug;                       /*!< set to true if to dump PRI event info */
00463    int span;                        /*!< span number put into user output messages */
00464    int resetting;                   /*!< true if span is being reset/restarted */
00465    int resetpos;                    /*!< current position during a reset (-1 if not started) */
00466    int sig;                      /*!< ISDN signalling type (SIG_PRI, SIG_BRI, SIG_BRI_PTMP, etc...) */
00467    int new_chan_seq;                /*!< New struct ast_channel sequence number */
00468    /*! TRUE if we have already whined about no D channels available. */
00469    unsigned int no_d_channels:1;
00470 
00471    /* Everything after here is internally set */
00472    struct pri *dchans[SIG_PRI_NUM_DCHANS];      /*!< Actual d-channels */
00473    struct pri *pri;                    /*!< Currently active D-channel */
00474    /*!
00475     * List of private structures of the user of this module for no B channel
00476     * interfaces. (hold and call waiting interfaces)
00477     */
00478    void *no_b_chan_iflist;
00479    /*!
00480     * List of private structures of the user of this module for no B channel
00481     * interfaces. (hold and call waiting interfaces)
00482     */
00483    void *no_b_chan_end;
00484    int numchans;                       /*!< Num of channels we represent */
00485    struct sig_pri_chan *pvts[SIG_PRI_MAX_CHANNELS];/*!< Member channel pvt structs */
00486    pthread_t master;                   /*!< Thread of master */
00487    ast_mutex_t lock;                   /*!< libpri access Mutex */
00488    time_t lastreset;                   /*!< time when unused channels were last reset */
00489    struct sig_pri_callback *calls;
00490    /*!
00491     * \brief Congestion device state of the span.
00492     * \details
00493     * AST_DEVICE_NOT_INUSE - Span does not have all B channels in use.
00494     * AST_DEVICE_BUSY - All B channels are in use.
00495     * AST_DEVICE_UNAVAILABLE - Span is in alarm.
00496     * \note
00497     * Device name: \startverbatim DAHDI/I<span>/congestion. \endverbatim
00498     */
00499    int congestion_devstate;
00500 #if defined(THRESHOLD_DEVSTATE_PLACEHOLDER)
00501    /*! \todo An ISDN span threshold device state could be useful in determining how often a span utilization goes over a configurable threshold. */
00502    /*!
00503     * \brief User threshold device state of the span.
00504     * \details
00505     * AST_DEVICE_NOT_INUSE - There are no B channels in use.
00506     * AST_DEVICE_INUSE - The number of B channels in use is less than
00507     *    the configured threshold but not zero.
00508     * AST_DEVICE_BUSY - The number of B channels in use meets or exceeds
00509     *    the configured threshold.
00510     * AST_DEVICE_UNAVAILABLE - Span is in alarm.
00511     * \note
00512     * Device name:  DAHDI/I<span>/threshold
00513     */
00514    int threshold_devstate;
00515    /*!
00516     * \brief Number of B channels in use to consider the span in a busy state.
00517     * \note Setting the threshold to zero is interpreted as all B channels.
00518     */
00519    int user_busy_threshold;
00520 #endif   /* defined(THRESHOLD_DEVSTATE_PLACEHOLDER) */
00521 };
00522 
00523 void sig_pri_extract_called_num_subaddr(struct sig_pri_chan *p, const char *rdest, char *called, size_t called_buff_size);
00524 int sig_pri_call(struct sig_pri_chan *p, struct ast_channel *ast, char *rdest, int timeout, int layer1);
00525 
00526 int sig_pri_hangup(struct sig_pri_chan *p, struct ast_channel *ast);
00527 
00528 int sig_pri_indicate(struct sig_pri_chan *p, struct ast_channel *chan, int condition, const void *data, size_t datalen);
00529 
00530 int sig_pri_answer(struct sig_pri_chan *p, struct ast_channel *ast);
00531 
00532 int sig_pri_is_chan_available(struct sig_pri_chan *pvt);
00533 int sig_pri_available(struct sig_pri_chan **pvt, int is_specific_channel);
00534 
00535 void sig_pri_init_pri(struct sig_pri_span *pri);
00536 
00537 /* If return 0, it means this function was able to handle it (pre setup digits).  If non zero, the user of this
00538  * functions should handle it normally (generate inband DTMF) */
00539 int sig_pri_digit_begin(struct sig_pri_chan *pvt, struct ast_channel *ast, char digit);
00540 void sig_pri_dial_complete(struct sig_pri_chan *pvt, struct ast_channel *ast);
00541 
00542 void sig_pri_stop_pri(struct sig_pri_span *pri);
00543 int sig_pri_start_pri(struct sig_pri_span *pri);
00544 
00545 void sig_pri_set_alarm(struct sig_pri_chan *p, int in_alarm);
00546 void sig_pri_chan_alarm_notify(struct sig_pri_chan *p, int noalarm);
00547 
00548 int sig_pri_is_alarm_ignored(struct sig_pri_span *pri);
00549 void pri_event_alarm(struct sig_pri_span *pri, int index, int before_start_pri);
00550 void pri_event_noalarm(struct sig_pri_span *pri, int index, int before_start_pri);
00551 
00552 struct ast_channel *sig_pri_request(struct sig_pri_chan *p, enum sig_pri_law law, const struct ast_channel *requestor, int transfercapability);
00553 
00554 struct sig_pri_chan *sig_pri_chan_new(void *pvt_data, struct sig_pri_callback *callback, struct sig_pri_span *pri, int logicalspan, int channo, int trunkgroup);
00555 void sig_pri_chan_delete(struct sig_pri_chan *doomed);
00556 
00557 int pri_is_up(struct sig_pri_span *pri);
00558 
00559 void sig_pri_cli_show_channels_header(int fd);
00560 void sig_pri_cli_show_channels(int fd, struct sig_pri_span *pri);
00561 void sig_pri_cli_show_spans(int fd, int span, struct sig_pri_span *pri);
00562 
00563 void sig_pri_cli_show_span(int fd, int *dchannels, struct sig_pri_span *pri);
00564 
00565 int pri_send_keypad_facility_exec(struct sig_pri_chan *p, const char *digits);
00566 int pri_send_callrerouting_facility_exec(struct sig_pri_chan *p, enum ast_channel_state chanstate, const char *destination, const char *original, const char *reason);
00567 
00568 #if defined(HAVE_PRI_SERVICE_MESSAGES)
00569 int pri_maintenance_bservice(struct pri *pri, struct sig_pri_chan *p, int changestatus);
00570 #endif   /* defined(HAVE_PRI_SERVICE_MESSAGES) */
00571 
00572 void sig_pri_fixup(struct ast_channel *oldchan, struct ast_channel *newchan, struct sig_pri_chan *pchan);
00573 
00574 int sig_pri_cc_agent_init(struct ast_cc_agent *agent, struct sig_pri_chan *pvt_chan);
00575 int sig_pri_cc_agent_start_offer_timer(struct ast_cc_agent *agent);
00576 int sig_pri_cc_agent_stop_offer_timer(struct ast_cc_agent *agent);
00577 void sig_pri_cc_agent_req_rsp(struct ast_cc_agent *agent, enum ast_cc_agent_response_reason reason);
00578 int sig_pri_cc_agent_status_req(struct ast_cc_agent *agent);
00579 int sig_pri_cc_agent_stop_ringing(struct ast_cc_agent *agent);
00580 int sig_pri_cc_agent_party_b_free(struct ast_cc_agent *agent);
00581 int sig_pri_cc_agent_start_monitoring(struct ast_cc_agent *agent);
00582 int sig_pri_cc_agent_callee_available(struct ast_cc_agent *agent);
00583 void sig_pri_cc_agent_destructor(struct ast_cc_agent *agent);
00584 
00585 int sig_pri_cc_monitor_req_cc(struct ast_cc_monitor *monitor, int *available_timer_id);
00586 int sig_pri_cc_monitor_suspend(struct ast_cc_monitor *monitor);
00587 int sig_pri_cc_monitor_unsuspend(struct ast_cc_monitor *monitor);
00588 int sig_pri_cc_monitor_status_rsp(struct ast_cc_monitor *monitor, enum ast_device_state devstate);
00589 int sig_pri_cc_monitor_cancel_available_timer(struct ast_cc_monitor *monitor, int *sched_id);
00590 void sig_pri_cc_monitor_destructor(void *monitor_pvt);
00591 
00592 int sig_pri_load(const char *cc_type_name);
00593 void sig_pri_unload(void);
00594 
00595 #endif /* _SIG_PRI_H */

Generated on 20 Aug 2013 for Asterisk - The Open Source Telephony Project by  doxygen 1.6.1