Mon Jun 27 16:50:56 2011

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 connected/answered. (CONNECT) */
00099    SIG_PRI_CALL_LEVEL_CONNECT,
00100 };
00101 
00102 struct sig_pri_span;
00103 
00104 struct sig_pri_callback {
00105    /* Unlock the private in the signalling private structure.  This is used for three way calling madness. */
00106    void (* const unlock_private)(void *pvt);
00107    /* Lock the private in the signalling private structure.  ... */
00108    void (* const lock_private)(void *pvt);
00109    /* Function which is called back to handle any other DTMF events that are received.  Called by analog_handle_event.  Why is this
00110     * important to use, instead of just directly using events received before they are passed into the library?  Because sometimes,
00111     * (CWCID) the library absorbs DTMF events received. */
00112    //void (* const handle_dtmf)(void *pvt, struct ast_channel *ast, enum analog_sub analog_index, struct ast_frame **dest);
00113 
00114    //int (* const dial_digits)(void *pvt, enum analog_sub sub, struct analog_dialoperation *dop);
00115    int (* const play_tone)(void *pvt, enum sig_pri_tone tone);
00116 
00117    int (* const set_echocanceller)(void *pvt, int enable);
00118    int (* const train_echocanceller)(void *pvt);
00119    int (* const dsp_reset_and_flush_digits)(void *pvt);
00120 
00121    struct ast_channel * (* const new_ast_channel)(void *pvt, int state, enum sig_pri_law law, char *exten, const struct ast_channel *chan);
00122 
00123    void (* const fixup_chans)(void *old_chan, void *new_chan);
00124 
00125    /* Note: Called with PRI lock held */
00126    void (* const handle_dchan_exception)(struct sig_pri_span *pri, int index);
00127    void (* const set_alarm)(void *pvt, int in_alarm);
00128    void (* const set_dialing)(void *pvt, int is_dialing);
00129    void (* const set_digital)(void *pvt, int is_digital);
00130    void (* const set_callerid)(void *pvt, const struct ast_party_caller *caller);
00131    void (* const set_dnid)(void *pvt, const char *dnid);
00132    void (* const set_rdnis)(void *pvt, const char *rdnis);
00133    void (* const queue_control)(void *pvt, int subclass);
00134    int (* const new_nobch_intf)(struct sig_pri_span *pri);
00135    void (* const init_config)(void *pvt, struct sig_pri_span *pri);
00136    const char *(* const get_orig_dialstring)(void *pvt);
00137    void (* const make_cc_dialstring)(void *pvt, char *buf, size_t buf_size);
00138    void (* const update_span_devstate)(struct sig_pri_span *pri);
00139 
00140    void (* const open_media)(void *pvt);
00141 
00142    /*! Reference the parent module. */
00143    void (*module_ref)(void);
00144    /*! Unreference the parent module. */
00145    void (*module_unref)(void);
00146 };
00147 
00148 #define SIG_PRI_NUM_DCHANS    4     /*!< No more than 4 d-channels */
00149 #define SIG_PRI_MAX_CHANNELS  672      /*!< No more than a DS3 per trunk group */
00150 
00151 #define SIG_PRI      DAHDI_SIG_CLEAR
00152 #define SIG_BRI      (0x2000000 | DAHDI_SIG_CLEAR)
00153 #define SIG_BRI_PTMP (0X4000000 | DAHDI_SIG_CLEAR)
00154 
00155 /* QSIG channel mapping option types */
00156 #define DAHDI_CHAN_MAPPING_PHYSICAL 0
00157 #define DAHDI_CHAN_MAPPING_LOGICAL  1
00158 
00159 /* Overlap dialing option types */
00160 #define DAHDI_OVERLAPDIAL_NONE 0
00161 #define DAHDI_OVERLAPDIAL_OUTGOING 1
00162 #define DAHDI_OVERLAPDIAL_INCOMING 2
00163 #define DAHDI_OVERLAPDIAL_BOTH (DAHDI_OVERLAPDIAL_INCOMING|DAHDI_OVERLAPDIAL_OUTGOING)
00164 
00165 #if defined(HAVE_PRI_SERVICE_MESSAGES)
00166 /*! \brief Persistent Service State */
00167 #define SRVST_DBKEY "service-state"
00168 /*! \brief The out-of-service SERVICE state */
00169 #define SRVST_TYPE_OOS "O"
00170 /*! \brief SRVST_INITIALIZED is used to indicate a channel being out-of-service
00171  *  The SRVST_INITIALIZED is mostly used maintain backwards compatibility but also may
00172  *  mean that the channel has not yet received a RESTART message.  If a channel is
00173  *  out-of-service with this reason a RESTART message will result in the channel
00174  *  being put into service. */
00175 #define SRVST_INITIALIZED 0
00176 /*! \brief SRVST_NEAREND is used to indicate that the near end was put out-of-service */
00177 #define SRVST_NEAREND  (1 << 0)
00178 /*! \brief SRVST_FAREND is used to indicate that the far end was taken out-of-service */
00179 #define SRVST_FAREND   (1 << 1)
00180 /*! \brief SRVST_BOTH is used to indicate that both sides of the channel are out-of-service */
00181 #define SRVST_BOTH (SRVST_NEAREND | SRVST_FAREND)
00182 
00183 /*! \brief The AstDB family */
00184 static const char dahdi_db[] = "dahdi/registry";
00185 #endif   /* defined(HAVE_PRI_SERVICE_MESSAGES) */
00186 
00187 struct sig_pri_chan {
00188    /* Options to be set by user */
00189    unsigned int hidecallerid:1;
00190    unsigned int hidecalleridname:1;      /*!< Hide just the name not the number for legacy PBX use */
00191    unsigned int immediate:1;        /*!< Answer before getting digits? */
00192    unsigned int priexclusive:1;        /*!< Whether or not to override and use exculsive mode for channel selection */
00193    unsigned int priindication_oob:1;
00194    unsigned int use_callerid:1;        /*!< Whether or not to use caller id on this channel */
00195    unsigned int use_callingpres:1;        /*!< Whether to use the callingpres the calling switch sends */
00196    char context[AST_MAX_CONTEXT];
00197    char mohinterpret[MAX_MUSICCLASS];
00198    int stripmsd;
00199    int channel;               /*!< Channel Number or CRV */
00200 
00201    /* Options to be checked by user */
00202    int cid_ani2;                 /*!< Automatic Number Identification number (Alternate PRI caller ID number) */
00203    int cid_ton;               /*!< Type Of Number (TON) */
00204    int callingpres;           /*!< The value of calling presentation that we're going to use when placing a PRI call */
00205    char cid_num[AST_MAX_EXTENSION];
00206    char cid_subaddr[AST_MAX_EXTENSION];
00207    char cid_name[AST_MAX_EXTENSION];
00208    char cid_ani[AST_MAX_EXTENSION];
00209    /*! \brief User tag for party id's sent from this device driver. */
00210    char user_tag[AST_MAX_EXTENSION];
00211    char exten[AST_MAX_EXTENSION];
00212 
00213    /* Internal variables -- Don't touch */
00214    /* Probably will need DS0 number, DS1 number, and a few other things */
00215    char dialdest[256];           /* Queued up digits for overlap dialing.  They will be sent out as information messages when setup ACK is received */
00216 #if defined(HAVE_PRI_SETUP_KEYPAD)
00217    /*! \brief Keypad digits that came in with the SETUP message. */
00218    char keypad_digits[AST_MAX_EXTENSION];
00219 #endif   /* defined(HAVE_PRI_SETUP_KEYPAD) */
00220 
00221 #if defined(HAVE_PRI_AOC_EVENTS)
00222    struct pri_subcmd_aoc_e aoc_e;
00223    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 */
00224    unsigned int aoc_s_request_invoke_id_valid:1; /*!< This is set when the AOC-S invoke id is present */
00225    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. */
00226    unsigned int holding_aoce:1;     /*!< received AOC-E msg from asterisk. holding for disconnect/release */
00227 #endif   /* defined(HAVE_PRI_AOC_EVENTS) */
00228    unsigned int inalarm:1;
00229    unsigned int alreadyhungup:1; /*!< TRUE if the call has already gone/hungup */
00230    unsigned int isidlecall:1;    /*!< TRUE if this is an idle call */
00231    unsigned int progress:1;      /*!< TRUE if the call has seen inband-information progress through the network */
00232    unsigned int resetting:1;     /*!< TRUE if this channel is being reset/restarted */
00233 
00234    unsigned int outgoing:1;
00235    unsigned int digital:1;
00236    /*! \brief TRUE if this interface has no B channel.  (call hold and call waiting) */
00237    unsigned int no_b_channel:1;
00238 #if defined(HAVE_PRI_CALL_WAITING)
00239    /*! \brief TRUE if this is a call waiting call */
00240    unsigned int is_call_waiting:1;
00241 #endif   /* defined(HAVE_PRI_CALL_WAITING) */
00242 
00243    struct ast_channel *owner;
00244 
00245    struct sig_pri_span *pri;
00246    q931_call *call;           /*!< opaque libpri call control structure */
00247 
00248    /*! Call establishment life cycle level for simple comparisons. */
00249    enum sig_pri_call_level call_level;
00250    int prioffset;             /*!< channel number in span */
00251    int logicalspan;           /*!< logical span number within trunk group */
00252    int mastertrunkgroup;         /*!< what trunk group is our master */
00253 #if defined(HAVE_PRI_SERVICE_MESSAGES)
00254    /*! \brief Active SRVST_DBKEY out-of-service status value. */
00255    unsigned service_status;
00256 #endif   /* defined(HAVE_PRI_SERVICE_MESSAGES) */
00257 
00258    struct sig_pri_callback *calls;
00259    void *chan_pvt;               /*!< Private structure of the user of this module. */
00260 #if defined(HAVE_PRI_REVERSE_CHARGE)
00261    /*!
00262     * \brief Reverse charging indication
00263     * \details
00264     * -1 - No reverse charging,
00265     *  1 - Reverse charging,
00266     * 0,2-7 - Reserved for future use
00267     */
00268    int reverse_charging_indication;
00269 #endif
00270 };
00271 
00272 #if defined(HAVE_PRI_MWI)
00273 /*! Maximum number of mailboxes per span. */
00274 #define SIG_PRI_MAX_MWI_MAILBOXES         8
00275 /*! Typical maximum length of mwi mailbox number */
00276 #define SIG_PRI_MAX_MWI_MBOX_NUMBER_LEN      10 /* digits in number */
00277 /*! Typical maximum length of mwi mailbox context */
00278 #define SIG_PRI_MAX_MWI_CONTEXT_LEN       10
00279 /*!
00280  * \brief Maximum mwi_mailbox string length.
00281  * \details
00282  * max_length = #mailboxes * (mbox_number + '@' + context + ',')
00283  * The last ',' is a null terminator instead.
00284  */
00285 #define SIG_PRI_MAX_MWI_MAILBOX_STR    (SIG_PRI_MAX_MWI_MAILBOXES \
00286    * (SIG_PRI_MAX_MWI_MBOX_NUMBER_LEN + 1 + SIG_PRI_MAX_MWI_CONTEXT_LEN + 1))
00287 
00288 struct sig_pri_mbox {
00289    /*!
00290     * \brief MWI mailbox event subscription.
00291     * \note NULL if mailbox not configured.
00292     */
00293    struct ast_event_sub *sub;
00294    /*! \brief Mailbox number */
00295    const char *number;
00296    /*! \brief Mailbox context. */
00297    const char *context;
00298 };
00299 #endif   /* defined(HAVE_PRI_MWI) */
00300 
00301 struct sig_pri_span {
00302    /* Should be set by user */
00303    struct ast_cc_config_params *cc_params;         /*!< CC config parameters for each new call. */
00304    int   pritimers[PRI_MAX_TIMERS];
00305    int overlapdial;                       /*!< In overlap dialing mode */
00306    int qsigchannelmapping;                   /*!< QSIG channel mapping type */
00307    int discardremoteholdretrieval;              /*!< shall remote hold or remote retrieval notifications be discarded? */
00308    int facilityenable;                       /*!< Enable facility IEs */
00309    int dchan_logical_span[SIG_PRI_NUM_DCHANS];     /*!< Logical offset the DCHAN sits in */
00310    int fds[SIG_PRI_NUM_DCHANS];              /*!< FD's for d-channels */
00311 
00312 #if defined(HAVE_PRI_AOC_EVENTS)
00313    int aoc_passthrough_flag;                 /*!< Represents what AOC messages (S,D,E) are allowed to pass-through */
00314    unsigned int aoce_delayhangup:1;          /*!< defines whether the aoce_delayhangup option is enabled or not */
00315 #endif   /* defined(HAVE_PRI_AOC_EVENTS) */
00316 
00317 #if defined(HAVE_PRI_SERVICE_MESSAGES)
00318    unsigned int enable_service_message_support:1;  /*!< enable SERVICE message support */
00319 #endif   /* defined(HAVE_PRI_SERVICE_MESSAGES) */
00320 #ifdef HAVE_PRI_INBANDDISCONNECT
00321    unsigned int inbanddisconnect:1;          /*!< Should we support inband audio after receiving DISCONNECT? */
00322 #endif
00323 #if defined(HAVE_PRI_CALL_HOLD)
00324    /*! \brief TRUE if held calls are transferred on disconnect. */
00325    unsigned int hold_disconnect_transfer:1;
00326 #endif   /* defined(HAVE_PRI_CALL_HOLD) */
00327    /*!
00328     * \brief TRUE if call transfer is enabled for the span.
00329     * \note Support switch-side transfer (called 2BCT, RLT or other names)
00330     */
00331    unsigned int transfer:1;
00332 #if defined(HAVE_PRI_CALL_WAITING)
00333    /*! \brief TRUE if we will allow incoming ISDN call waiting calls. */
00334    unsigned int allow_call_waiting_calls:1;
00335 #endif   /* defined(HAVE_PRI_CALL_WAITING) */
00336    /*!
00337     * TRUE if a new call's sig_pri_chan.user_tag[] has the MSN
00338     * appended to the initial_user_tag[].
00339     */
00340    unsigned int append_msn_to_user_tag:1;
00341    int dialplan;                    /*!< Dialing plan */
00342    int localdialplan;                  /*!< Local dialing plan */
00343    char internationalprefix[10];       /*!< country access code ('00' for european dialplans) */
00344    char nationalprefix[10];            /*!< area access code ('0' for european dialplans) */
00345    char localprefix[20];               /*!< area access code + area code ('0'+area code for european dialplans) */
00346    char privateprefix[20];             /*!< for private dialplans */
00347    char unknownprefix[20];             /*!< for unknown dialplans */
00348    long resetinterval;                 /*!< Interval (in seconds) for resetting unused channels */
00349 #if defined(HAVE_PRI_MWI)
00350    /*! \brief Active MWI mailboxes */
00351    struct sig_pri_mbox mbox[SIG_PRI_MAX_MWI_MAILBOXES];
00352    /*!
00353     * \brief Comma separated list of mailboxes to indicate MWI.
00354     * \note Empty if disabled.
00355     * \note Format: mailbox_number[@context]{,mailbox_number[@context]}
00356     * \note String is split apart when span is started.
00357     */
00358    char mwi_mailboxes[SIG_PRI_MAX_MWI_MAILBOX_STR];
00359 #endif   /* defined(HAVE_PRI_MWI) */
00360    /*!
00361     * \brief Initial user tag for party id's sent from this device driver.
00362     * \note String set by config file.
00363     */
00364    char initial_user_tag[AST_MAX_EXTENSION];
00365    char msn_list[AST_MAX_EXTENSION];      /*!< Comma separated list of MSNs to handle.  Empty if disabled. */
00366    char idleext[AST_MAX_EXTENSION];    /*!< Where to idle extra calls */
00367    char idlecontext[AST_MAX_CONTEXT];     /*!< What context to use for idle */
00368    char idledial[AST_MAX_EXTENSION];      /*!< What to dial before dumping */
00369    int minunused;                   /*!< Min # of channels to keep empty */
00370    int minidle;                     /*!< Min # of "idling" calls to keep active */
00371    int nodetype;                    /*!< Node type */
00372    int switchtype;                     /*!< Type of switch to emulate */
00373    int nsf;                      /*!< Network-Specific Facilities */
00374    int trunkgroup;                     /*!< What our trunkgroup is */
00375 #if defined(HAVE_PRI_CCSS)
00376    int cc_ptmp_recall_mode;            /*!< CC PTMP recall mode. globalRecall(0), specificRecall(1) */
00377    int cc_qsig_signaling_link_req;        /*!< CC Q.SIG signaling link retention (Party A) release(0), retain(1), do-not-care(2) */
00378    int cc_qsig_signaling_link_rsp;        /*!< CC Q.SIG signaling link retention (Party B) release(0), retain(1) */
00379 #endif   /* defined(HAVE_PRI_CCSS) */
00380 #if defined(HAVE_PRI_CALL_WAITING)
00381    /*!
00382     * \brief Number of extra outgoing calls to allow on a span before
00383     * considering that span congested.
00384     */
00385    int max_call_waiting_calls;
00386    struct {
00387       int stripmsd;
00388       unsigned int hidecallerid:1;
00389       unsigned int hidecalleridname:1;      /*!< Hide just the name not the number for legacy PBX use */
00390       unsigned int immediate:1;        /*!< Answer before getting digits? */
00391       unsigned int priexclusive:1;        /*!< Whether or not to override and use exculsive mode for channel selection */
00392       unsigned int priindication_oob:1;
00393       unsigned int use_callerid:1;        /*!< Whether or not to use caller id on this channel */
00394       unsigned int use_callingpres:1;        /*!< Whether to use the callingpres the calling switch sends */
00395       char context[AST_MAX_CONTEXT];
00396       char mohinterpret[MAX_MUSICCLASS];
00397    } ch_cfg;
00398 
00399    /*!
00400     * \brief Number of outstanding call waiting calls.
00401     * \note Must be zero to allow new calls from asterisk to
00402     * immediately allocate a B channel.
00403     */
00404    int num_call_waiting_calls;
00405 #endif   /* defined(HAVE_PRI_CALL_WAITING) */
00406    int dchanavail[SIG_PRI_NUM_DCHANS];    /*!< Whether each channel is available */
00407    int debug;                       /*!< set to true if to dump PRI event info */
00408    int span;                        /*!< span number put into user output messages */
00409    int resetting;                   /*!< true if span is being reset/restarted */
00410    int resetpos;                    /*!< current position during a reset (-1 if not started) */
00411    int sig;                      /*!< ISDN signalling type (SIG_PRI, SIG_BRI, SIG_BRI_PTMP, etc...) */
00412    int new_chan_seq;                /*!< New struct ast_channel sequence number */
00413    /*! TRUE if we have already whined about no D channels available. */
00414    unsigned int no_d_channels:1;
00415 
00416    /* Everything after here is internally set */
00417    struct pri *dchans[SIG_PRI_NUM_DCHANS];      /*!< Actual d-channels */
00418    struct pri *pri;                    /*!< Currently active D-channel */
00419    /*!
00420     * List of private structures of the user of this module for no B channel
00421     * interfaces. (hold and call waiting interfaces)
00422     */
00423    void *no_b_chan_iflist;
00424    /*!
00425     * List of private structures of the user of this module for no B channel
00426     * interfaces. (hold and call waiting interfaces)
00427     */
00428    void *no_b_chan_end;
00429    int numchans;                       /*!< Num of channels we represent */
00430    struct sig_pri_chan *pvts[SIG_PRI_MAX_CHANNELS];/*!< Member channel pvt structs */
00431    pthread_t master;                   /*!< Thread of master */
00432    ast_mutex_t lock;                   /*!< libpri access Mutex */
00433    time_t lastreset;                   /*!< time when unused channels were last reset */
00434    struct sig_pri_callback *calls;
00435    /*!
00436     * \brief Congestion device state of the span.
00437     * \details
00438     * AST_DEVICE_NOT_INUSE - Span does not have all B channels in use.
00439     * AST_DEVICE_BUSY - All B channels are in use.
00440     * AST_DEVICE_UNAVAILABLE - Span is in alarm.
00441     * \note
00442     * Device name: \startverbatim DAHDI/I<span>/congestion. \endverbatim
00443     */
00444    int congestion_devstate;
00445 #if defined(THRESHOLD_DEVSTATE_PLACEHOLDER)
00446    /*! \todo An ISDN span threshold device state could be useful in determining how often a span utilization goes over a configurable threshold. */
00447    /*!
00448     * \brief User threshold device state of the span.
00449     * \details
00450     * AST_DEVICE_NOT_INUSE - There are no B channels in use.
00451     * AST_DEVICE_INUSE - The number of B channels in use is less than
00452     *    the configured threshold but not zero.
00453     * AST_DEVICE_BUSY - The number of B channels in use meets or exceeds
00454     *    the configured threshold.
00455     * AST_DEVICE_UNAVAILABLE - Span is in alarm.
00456     * \note
00457     * Device name:  DAHDI/I<span>/threshold
00458     */
00459    int threshold_devstate;
00460    /*!
00461     * \brief Number of B channels in use to consider the span in a busy state.
00462     * \note Setting the threshold to zero is interpreted as all B channels.
00463     */
00464    int user_busy_threshold;
00465 #endif   /* defined(THRESHOLD_DEVSTATE_PLACEHOLDER) */
00466 };
00467 
00468 void sig_pri_extract_called_num_subaddr(struct sig_pri_chan *p, const char *rdest, char *called, size_t called_buff_size);
00469 int sig_pri_call(struct sig_pri_chan *p, struct ast_channel *ast, char *rdest, int timeout, int layer1);
00470 
00471 int sig_pri_hangup(struct sig_pri_chan *p, struct ast_channel *ast);
00472 
00473 int sig_pri_indicate(struct sig_pri_chan *p, struct ast_channel *chan, int condition, const void *data, size_t datalen);
00474 
00475 int sig_pri_answer(struct sig_pri_chan *p, struct ast_channel *ast);
00476 
00477 int sig_pri_available(struct sig_pri_chan **pvt, int is_specific_channel);
00478 
00479 void sig_pri_init_pri(struct sig_pri_span *pri);
00480 
00481 /* If return 0, it means this function was able to handle it (pre setup digits).  If non zero, the user of this
00482  * functions should handle it normally (generate inband DTMF) */
00483 int sig_pri_digit_begin(struct sig_pri_chan *pvt, struct ast_channel *ast, char digit);
00484 
00485 void sig_pri_stop_pri(struct sig_pri_span *pri);
00486 int sig_pri_start_pri(struct sig_pri_span *pri);
00487 
00488 void sig_pri_chan_alarm_notify(struct sig_pri_chan *p, int noalarm);
00489 
00490 void pri_event_alarm(struct sig_pri_span *pri, int index, int before_start_pri);
00491 
00492 void pri_event_noalarm(struct sig_pri_span *pri, int index, int before_start_pri);
00493 
00494 struct ast_channel *sig_pri_request(struct sig_pri_chan *p, enum sig_pri_law law, const struct ast_channel *requestor, int transfercapability);
00495 
00496 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);
00497 void sig_pri_chan_delete(struct sig_pri_chan *doomed);
00498 
00499 int pri_is_up(struct sig_pri_span *pri);
00500 
00501 void sig_pri_cli_show_spans(int fd, int span, struct sig_pri_span *pri);
00502 
00503 void sig_pri_cli_show_span(int fd, int *dchannels, struct sig_pri_span *pri);
00504 
00505 int pri_send_keypad_facility_exec(struct sig_pri_chan *p, const char *digits);
00506 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);
00507 
00508 #if defined(HAVE_PRI_SERVICE_MESSAGES)
00509 int pri_maintenance_bservice(struct pri *pri, struct sig_pri_chan *p, int changestatus);
00510 #endif   /* defined(HAVE_PRI_SERVICE_MESSAGES) */
00511 
00512 void sig_pri_fixup(struct ast_channel *oldchan, struct ast_channel *newchan, struct sig_pri_chan *pchan);
00513 
00514 int sig_pri_cc_agent_init(struct ast_cc_agent *agent, struct sig_pri_chan *pvt_chan);
00515 int sig_pri_cc_agent_start_offer_timer(struct ast_cc_agent *agent);
00516 int sig_pri_cc_agent_stop_offer_timer(struct ast_cc_agent *agent);
00517 void sig_pri_cc_agent_req_rsp(struct ast_cc_agent *agent, enum ast_cc_agent_response_reason reason);
00518 int sig_pri_cc_agent_status_req(struct ast_cc_agent *agent);
00519 int sig_pri_cc_agent_stop_ringing(struct ast_cc_agent *agent);
00520 int sig_pri_cc_agent_party_b_free(struct ast_cc_agent *agent);
00521 int sig_pri_cc_agent_start_monitoring(struct ast_cc_agent *agent);
00522 int sig_pri_cc_agent_callee_available(struct ast_cc_agent *agent);
00523 void sig_pri_cc_agent_destructor(struct ast_cc_agent *agent);
00524 
00525 int sig_pri_cc_monitor_req_cc(struct ast_cc_monitor *monitor, int *available_timer_id);
00526 int sig_pri_cc_monitor_suspend(struct ast_cc_monitor *monitor);
00527 int sig_pri_cc_monitor_unsuspend(struct ast_cc_monitor *monitor);
00528 int sig_pri_cc_monitor_status_rsp(struct ast_cc_monitor *monitor, enum ast_device_state devstate);
00529 int sig_pri_cc_monitor_cancel_available_timer(struct ast_cc_monitor *monitor, int *sched_id);
00530 void sig_pri_cc_monitor_destructor(void *monitor_pvt);
00531 
00532 int sig_pri_load(const char *cc_type_name);
00533 void sig_pri_unload(void);
00534 
00535 #endif /* _SIG_PRI_H */

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