Allow CDR's to be linked and work on the linked list
[asterisk/asterisk.git] / include / asterisk / cdr.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Call Detail Record API 
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License.
12  *
13  * Includes code and algorithms from the Zapata library.
14  *
15  */
16
17 #ifndef _CDR_H
18 #define _CDR_H
19
20 #include <asterisk/channel.h>
21 #include <sys/time.h>
22
23 #define AST_CDR_NOANSWER                        (1 << 0)
24 #define AST_CDR_BUSY                            (1 << 1)
25 #define AST_CDR_ANSWERED                        (1 << 2)
26 #define AST_CDR_FAILED                          (1 << 3)
27
28 //! AMA Flags
29 #define AST_CDR_OMIT                            (1)
30 #define AST_CDR_BILLING                         (2)
31 #define AST_CDR_DOCUMENTATION                   (3)
32
33 #define AST_MAX_USER_FIELD                      256
34
35 struct ast_channel;
36
37 //! Responsible for call detail data
38 struct ast_cdr {
39         /*! Caller*ID with text */
40         char clid[AST_MAX_EXTENSION];           
41         /*! Caller*ID number */
42         char src[AST_MAX_EXTENSION];            
43         /*! Destination extension */
44         char dst[AST_MAX_EXTENSION];            
45         /*! Destination context */
46         char dcontext[AST_MAX_EXTENSION];       
47         
48         char channel[AST_MAX_EXTENSION];
49         /*! Destination channel if appropriate */
50         char dstchannel[AST_MAX_EXTENSION];     
51         /*! Last application if appropriate */
52         char lastapp[AST_MAX_EXTENSION];        
53         /*! Last application data */
54         char lastdata[AST_MAX_EXTENSION];       
55         
56         struct timeval start;
57         
58         struct timeval answer;
59         
60         struct timeval end;
61         /*! Total time in system, in seconds */
62         int duration;                           
63         /*! Total time call is up, in seconds */
64         int billsec;                            
65         /*! What happened to the call */
66         int disposition;                        
67         /*! What flags to use */
68         int amaflags;                           
69         /*! What account number to use */
70         char accountcode[20];                   
71         /*! Whether or not the record has been posted */
72         int posted;                             
73         /* Unique Channel Identifier */
74         char uniqueid[32];
75         /* User field */
76         char userfield[AST_MAX_USER_FIELD];
77         struct ast_cdr *next;
78 };
79
80 typedef int (*ast_cdrbe)(struct ast_cdr *cdr);
81
82 //! Allocate a record
83 /*! 
84  * Returns a malloc'd ast_cdr structure, returns NULL on error (malloc failure)
85  */
86 extern struct ast_cdr *ast_cdr_alloc(void);
87
88 //! Free a record
89 /* \param cdr ast_cdr structure to free
90  * Returns nothing important
91  */
92 extern void ast_cdr_free(struct ast_cdr *cdr);
93
94 //! Initialize based on a channel
95 /*! 
96  * \param cdr Call Detail Record to use for channel
97  * \param chan Channel to bind CDR with
98  * Initializes a CDR and associates it with a particular channel
99  * Return is negligible.  (returns 0 by default)
100  */
101 extern int ast_cdr_init(struct ast_cdr *cdr, struct ast_channel *chan);
102
103 //! Initialize based on a channel
104 /*! 
105  * \param cdr Call Detail Record to use for channel
106  * \param chan Channel to bind CDR with
107  * Initializes a CDR and associates it with a particular channel
108  * Return is negligible.  (returns 0 by default)
109  */
110 extern int ast_cdr_setcid(struct ast_cdr *cdr, struct ast_channel *chan);
111
112 //! Register a CDR handling engine
113 /*!
114  * \param name name associated with the particular CDR handler
115  * \param desc description of the CDR handler
116  * \param be function pointer to a CDR handler
117  * Used to register a Call Detail Record handler.
118  * Returns -1 on error, 0 on success.
119  */
120 extern int ast_cdr_register(char *name, char *desc, ast_cdrbe be);
121
122 //! Unregister a CDR handling engine
123 /*!
124  * \param name name of CDR handler to unregister
125  * Unregisters a CDR by it's name
126  */
127 extern void ast_cdr_unregister(char *name);
128
129 //! Start a call
130 /*!
131  * \param cdr the cdr you wish to associate with the call
132  * Starts all CDR stuff necessary for monitoring a call
133  * Returns nothing important
134  */
135 extern void ast_cdr_start(struct ast_cdr *cdr);
136
137 //! Answer a call
138 /*!
139  * \param cdr the cdr you wish to associate with the call
140  * Starts all CDR stuff necessary for doing CDR when answering a call
141  */
142 extern void ast_cdr_answer(struct ast_cdr *cdr);
143
144 //! Busy a call
145 /*!
146  * \param cdr the cdr you wish to associate with the call
147  * Returns nothing important
148  */
149 extern void ast_cdr_busy(struct ast_cdr *cdr);
150
151 //! Fail a call
152 /*!
153  * \param cdr the cdr you wish to associate with the call
154  * Returns nothing important
155  */
156 extern void ast_cdr_failed(struct ast_cdr *cdr);
157
158 //! Save the result of the call based on the AST_CAUSE_*
159 /*!
160  * \param cdr the cdr you wish to associate with the call
161  * Returns nothing important
162  * \param cause the AST_CAUSE_*
163  */
164 extern int ast_cdr_disposition(struct ast_cdr *cdr, int cause);
165         
166 //! End a call
167 /*!
168  * \param cdr the cdr you have associated the call with
169  * Registers the end of call time in the cdr structure.
170  * Returns nothing important
171  */
172 extern void ast_cdr_end(struct ast_cdr *cdr);
173
174 //! Post the detail record
175 /*! 
176  * \param cdr Which cdr to post
177  * Actually outputs the CDR record to the CDR plugins installed
178  * Returns nothing
179  */
180 extern void ast_cdr_post(struct ast_cdr *cdr);
181
182 //! Set the destination channel, if there was one
183 /*!
184  * \param cdr Which cdr it's applied to
185  * Sets the destination channel the CDR is applied to
186  * Returns nothing
187  */
188 extern void ast_cdr_setdestchan(struct ast_cdr *cdr, char *chan);
189
190 //! Set the last executed application
191 /*!
192  * \param cdr which cdr to act upon
193  * \param app the name of the app you wish to change it to
194  * \param data the data you want in the data field of app you set it to
195  * Changes the value of the last executed app
196  * Returns nothing
197  */
198 extern void ast_cdr_setapp(struct ast_cdr *cdr, char *app, char *data);
199
200 //! Convert a string to a detail record AMA flag
201 /*!
202  * \param flag string form of flag
203  * Converts the string form of the flag to the binary form.
204  * Returns the binary form of the flag
205  */
206 extern int ast_cdr_amaflags2int(char *flag);
207
208 //! Disposition to a string
209 /*!
210  * \param flag input binary form
211  * Converts the binary form of a disposition to string form.
212  * Returns a pointer to the string form
213  */
214 extern char *ast_cdr_disp2str(int disposition);
215
216 //! Reset the detail record, optionally posting it first
217 /*!
218  * \param cdr which cdr to act upon
219  * \param post whether or not to post the cdr first before resetting it
220  */
221 extern void ast_cdr_reset(struct ast_cdr *cdr, int post);
222
223 //! Flags to a string
224 /*!
225  * \param flags binary flag
226  * Converts binary flags to string flags
227  * Returns string with flag name
228  */
229 extern char *ast_cdr_flags2str(int flags);
230
231 extern int ast_cdr_setaccount(struct ast_channel *chan, char *account);
232
233
234 extern int ast_cdr_setuserfield(struct ast_channel *chan, char *userfield);
235 extern int ast_cdr_appenduserfield(struct ast_channel *chan, char *userfield);
236
237
238 /* Update CDR on a channel */
239 extern int ast_cdr_update(struct ast_channel *chan);
240
241
242 extern int ast_default_amaflags;
243
244 extern char ast_default_accountcode[20];
245
246 #endif /* _CDR_H */