Thu Oct 1 13:08:41 2009

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

Generated on Thu Oct 1 13:08:41 2009 for Asterisk - the Open Source PBX by  doxygen 1.4.7