Mon May 14 04:42:54 2007

Asterisk developer's documentation


cdr.h

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 1999 - 2005, Digium, Inc.
00005  *
00006  * Mark Spencer <markster@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 /*! \file
00020  * \brief Call Detail Record API 
00021  */
00022 
00023 #ifndef _ASTERISK_CDR_H
00024 #define _ASTERISK_CDR_H
00025 
00026 #include <sys/time.h>
00027 #define AST_CDR_FLAG_KEEP_VARS         (1 << 0)
00028 #define AST_CDR_FLAG_POSTED         (1 << 1)
00029 #define AST_CDR_FLAG_LOCKED         (1 << 2)
00030 #define AST_CDR_FLAG_CHILD       (1 << 3)
00031 #define AST_CDR_FLAG_POST_DISABLED     (1 << 4)
00032 
00033 #define AST_CDR_NOANSWER         (1 << 0)
00034 #define AST_CDR_BUSY          (1 << 1)
00035 #define AST_CDR_FAILED           (1 << 2)
00036 #define AST_CDR_ANSWERED         (1 << 3)
00037 
00038 /*! AMA Flags */
00039 #define AST_CDR_OMIT          (1)
00040 #define AST_CDR_BILLING          (2)
00041 #define AST_CDR_DOCUMENTATION       (3)
00042 
00043 #define AST_MAX_USER_FIELD       256
00044 #define AST_MAX_ACCOUNT_CODE        20
00045 
00046 /* Include channel.h after relevant declarations it will need */
00047 #include "asterisk/channel.h"
00048 #include "asterisk/utils.h"
00049 
00050 /*! Responsible for call detail data */
00051 struct ast_cdr {
00052    /*! Caller*ID with text */
00053    char clid[AST_MAX_EXTENSION];
00054    /*! Caller*ID number */
00055    char src[AST_MAX_EXTENSION];     
00056    /*! Destination extension */
00057    char dst[AST_MAX_EXTENSION];     
00058    /*! Destination context */
00059    char dcontext[AST_MAX_EXTENSION];   
00060    
00061    char channel[AST_MAX_EXTENSION];
00062    /*! Destination channel if appropriate */
00063    char dstchannel[AST_MAX_EXTENSION]; 
00064    /*! Last application if appropriate */
00065    char lastapp[AST_MAX_EXTENSION]; 
00066    /*! Last application data */
00067    char lastdata[AST_MAX_EXTENSION];   
00068    
00069    struct timeval start;
00070    
00071    struct timeval answer;
00072    
00073    struct timeval end;
00074    /*! Total time in system, in seconds */
00075    long int duration;            
00076    /*! Total time call is up, in seconds */
00077    long int billsec;          
00078    /*! What happened to the call */
00079    long int disposition;         
00080    /*! What flags to use */
00081    long int amaflags;            
00082    /*! What account number to use */
00083    char accountcode[AST_MAX_ACCOUNT_CODE];         
00084    /*! flags */
00085    unsigned int flags;           
00086    /* Unique Channel Identifier */
00087    char uniqueid[32];
00088    /* User field */
00089    char userfield[AST_MAX_USER_FIELD];
00090 
00091    /* A linked list for variables */
00092    struct varshead varshead;
00093 
00094    struct ast_cdr *next;
00095 };
00096 
00097 void ast_cdr_getvar(struct ast_cdr *cdr, const char *name, char **ret, char *workspace, int workspacelen, int recur, int raw);
00098 int ast_cdr_setvar(struct ast_cdr *cdr, const char *name, const char *value, int recur);
00099 int ast_cdr_serialize_variables(struct ast_cdr *cdr, char *buf, size_t size, char delim, char sep, int recur);
00100 void ast_cdr_free_vars(struct ast_cdr *cdr, int recur);
00101 int ast_cdr_copy_vars(struct ast_cdr *to_cdr, struct ast_cdr *from_cdr);
00102 
00103 typedef int (*ast_cdrbe)(struct ast_cdr *cdr);
00104 
00105 /*! \brief Allocate a CDR record 
00106  * Returns a malloc'd ast_cdr structure, returns NULL on error (malloc failure)
00107  */
00108 struct ast_cdr *ast_cdr_alloc(void);
00109 
00110 /*! \brief Duplicate a record 
00111  * Returns a malloc'd ast_cdr structure, returns NULL on error (malloc failure)
00112  */
00113 struct ast_cdr *ast_cdr_dup(struct ast_cdr *cdr);
00114 
00115 /*! \brief Free a CDR record 
00116  * \param cdr ast_cdr structure to free
00117  * Returns nothing
00118  */
00119 void ast_cdr_free(struct ast_cdr *cdr);
00120 
00121 /*! \brief Discard and free a CDR record 
00122  * \param cdr ast_cdr structure to free
00123  * Returns nothing  -- same as free, but no checks or complaints
00124  */
00125 void ast_cdr_discard(struct ast_cdr *cdr);
00126 
00127 /*! \brief Initialize based on a channel
00128  * \param cdr Call Detail Record to use for channel
00129  * \param chan Channel to bind CDR with
00130  * Initializes a CDR and associates it with a particular channel
00131  * Return is negligible.  (returns 0 by default)
00132  */
00133 int ast_cdr_init(struct ast_cdr *cdr, struct ast_channel *chan);
00134 
00135 /*! Initialize based on a channel */
00136 /*! 
00137  * \param cdr Call Detail Record to use for channel
00138  * \param chan Channel to bind CDR with
00139  * Initializes a CDR and associates it with a particular channel
00140  * Return is negligible.  (returns 0 by default)
00141  */
00142 int ast_cdr_setcid(struct ast_cdr *cdr, struct ast_channel *chan);
00143 
00144 /*! Register a CDR handling engine */
00145 /*!
00146  * \param name name associated with the particular CDR handler
00147  * \param desc description of the CDR handler
00148  * \param be function pointer to a CDR handler
00149  * Used to register a Call Detail Record handler.
00150  * Returns -1 on error, 0 on success.
00151  */
00152 int ast_cdr_register(const char *name, const char *desc, ast_cdrbe be);
00153 
00154 /*! Unregister a CDR handling engine */
00155 /*!
00156  * \param name name of CDR handler to unregister
00157  * Unregisters a CDR by it's name
00158  */
00159 void ast_cdr_unregister(const char *name);
00160 
00161 /*! Start a call */
00162 /*!
00163  * \param cdr the cdr you wish to associate with the call
00164  * Starts all CDR stuff necessary for monitoring a call
00165  * Returns nothing
00166  */
00167 void ast_cdr_start(struct ast_cdr *cdr);
00168 
00169 /*! Answer a call */
00170 /*!
00171  * \param cdr the cdr you wish to associate with the call
00172  * Starts all CDR stuff necessary for doing CDR when answering a call
00173  * NULL argument is just fine.
00174  */
00175 void ast_cdr_answer(struct ast_cdr *cdr);
00176 
00177 /*! Busy a call */
00178 /*!
00179  * \param cdr the cdr you wish to associate with the call
00180  * Returns nothing
00181  */
00182 void ast_cdr_busy(struct ast_cdr *cdr);
00183 
00184 /*! Fail a call */
00185 /*!
00186  * \param cdr the cdr you wish to associate with the call
00187  * Returns nothing
00188  */
00189 void ast_cdr_failed(struct ast_cdr *cdr);
00190 
00191 /*! Save the result of the call based on the AST_CAUSE_* */
00192 /*!
00193  * \param cdr the cdr you wish to associate with the call
00194  * Returns nothing
00195  * \param cause the AST_CAUSE_*
00196  */
00197 int ast_cdr_disposition(struct ast_cdr *cdr, int cause);
00198    
00199 /*! End a call */
00200 /*!
00201  * \param cdr the cdr you have associated the call with
00202  * Registers the end of call time in the cdr structure.
00203  * Returns nothing
00204  */
00205 void ast_cdr_end(struct ast_cdr *cdr);
00206 
00207 /*! Detaches the detail record for posting (and freeing) either now or at a
00208  * later time in bulk with other records during batch mode operation */
00209 /*! 
00210  * \param cdr Which CDR to detach from the channel thread
00211  * Prevents the channel thread from blocking on the CDR handling
00212  * Returns nothing
00213  */
00214 void ast_cdr_detach(struct ast_cdr *cdr);
00215 
00216 /*! Spawns (possibly) a new thread to submit a batch of CDRs to the backend engines */
00217 /*!
00218  * \param shutdown Whether or not we are shutting down
00219  * Blocks the asterisk shutdown procedures until the CDR data is submitted.
00220  * Returns nothing
00221  */
00222 void ast_cdr_submit_batch(int shutdown);
00223 
00224 /*! Set the destination channel, if there was one */
00225 /*!
00226  * \param cdr Which cdr it's applied to
00227  * \param chan Channel to which dest will be
00228  * Sets the destination channel the CDR is applied to
00229  * Returns nothing
00230  */
00231 void ast_cdr_setdestchan(struct ast_cdr *cdr, const char *chan);
00232 
00233 /*! Set the last executed application */
00234 /*!
00235  * \param cdr which cdr to act upon
00236  * \param app the name of the app you wish to change it to
00237  * \param data the data you want in the data field of app you set it to
00238  * Changes the value of the last executed app
00239  * Returns nothing
00240  */
00241 void ast_cdr_setapp(struct ast_cdr *cdr, char *app, char *data);
00242 
00243 /*! Convert a string to a detail record AMA flag */
00244 /*!
00245  * \param flag string form of flag
00246  * Converts the string form of the flag to the binary form.
00247  * Returns the binary form of the flag
00248  */
00249 int ast_cdr_amaflags2int(const char *flag);
00250 
00251 /*! Disposition to a string */
00252 /*!
00253  * \param disposition input binary form
00254  * Converts the binary form of a disposition to string form.
00255  * Returns a pointer to the string form
00256  */
00257 char *ast_cdr_disp2str(int disposition);
00258 
00259 /*! Reset the detail record, optionally posting it first */
00260 /*!
00261  * \param cdr which cdr to act upon
00262  * \param flags |AST_CDR_FLAG_POSTED whether or not to post the cdr first before resetting it
00263  *              |AST_CDR_FLAG_LOCKED whether or not to reset locked CDR's
00264  */
00265 void ast_cdr_reset(struct ast_cdr *cdr, struct ast_flags *flags);
00266 
00267 /*! Flags to a string */
00268 /*!
00269  * \param flags binary flag
00270  * Converts binary flags to string flags
00271  * Returns string with flag name
00272  */
00273 char *ast_cdr_flags2str(int flags);
00274 
00275 /*! Move the non-null data from the "from" cdr to the "to" cdr
00276  * \param to   the cdr to get the goodies
00277  * \param from the cdr to give the goodies
00278  */
00279 void ast_cdr_merge(struct ast_cdr *to, struct ast_cdr *from);
00280 
00281 int ast_cdr_setaccount(struct ast_channel *chan, const char *account);
00282 int ast_cdr_setamaflags(struct ast_channel *chan, const char *amaflags);
00283 
00284 
00285 int ast_cdr_setuserfield(struct ast_channel *chan, const char *userfield);
00286 int ast_cdr_appenduserfield(struct ast_channel *chan, const char *userfield);
00287 
00288 
00289 /* Update CDR on a channel */
00290 int ast_cdr_update(struct ast_channel *chan);
00291 
00292 
00293 extern int ast_default_amaflags;
00294 
00295 extern char ast_default_accountcode[AST_MAX_ACCOUNT_CODE];
00296 
00297 struct ast_cdr *ast_cdr_append(struct ast_cdr *cdr, struct ast_cdr *newcdr);
00298 
00299 /*! Reload the configuration file cdr.conf and start/stop CDR scheduling thread */
00300 int ast_cdr_engine_reload(void);
00301 
00302 /*! Load the configuration file cdr.conf and possibly start the CDR scheduling thread */
00303 int ast_cdr_engine_init(void);
00304 
00305 /*! Submit any remaining CDRs and prepare for shutdown */
00306 void ast_cdr_engine_term(void);
00307 
00308 #endif /* _ASTERISK_CDR_H */

Generated on Mon May 14 04:42:54 2007 for Asterisk - the Open Source PBX by  doxygen 1.5.1