[svn-commits] russell: branch group/newcdr r201826 - /team/group/newcdr/include/asterisk/cel.h

[SVN commits to the Digium repositories]

Author: russell
Date: Thu Jun 18 17:53:39 2009
New Revision: 201826

URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=201826
Log:
minor header changes

Modified:
    team/group/newcdr/include/asterisk/cel.h

Modified: team/group/newcdr/include/asterisk/cel.h
URL: http://svn.asterisk.org/svn-view/asterisk/team/group/newcdr/include/asterisk/cel.h?view=diff&rev=201826&r1=201825&r2=201826
==============================================================================
--- team/group/newcdr/include/asterisk/cel.h (original)
+++ team/group/newcdr/include/asterisk/cel.h Thu Jun 18 17:53:39 2009
@@ -1,9 +1,7 @@
 /*
  * Asterisk -- An open source telephony toolkit.
  *
- * Copyright (C) 1999 - 2005, Digium, Inc.
- *
- * Mark Spencer <markster at digium.com>
+ * Copyright (C) 2008 - 2009, Digium, Inc.
  *
  * See http://www.asterisk.org for more information about
  * the Asterisk project. Please do not directly contact
@@ -16,22 +14,25 @@
  * at the top of the source tree.
  */
 
-/*! \file
- * \brief Call Detail Record API 
+/*! 
+ * \file
+ * \brief Call Event Logging API 
+ *
+ * \todo Complete the documentation in this file.
  */
 
-#ifndef _ASTERISK_CEL_H
-#define _ASTERISK_CEL_H
-
-#include <sys/time.h>
+#ifndef __AST_CEL_H__
+#define __AST_CEL_H__
 
 /*! AMA Flags */
-#define AST_CEL_OMIT				(1)
-#define AST_CEL_BILLING				(2)
-#define AST_CEL_DOCUMENTATION			(3)
+enum ast_cel_ama_flags {
+	AST_CEL_OMIT,
+	AST_CEL_BILLING,
+	AST_CEL_DOCUMENTATION,
+};
 
-#define AST_MAX_USER_FIELD			256
-#define AST_MAX_ACCOUNT_CODE			20
+#define AST_MAX_USER_FIELD    256
+#define AST_MAX_ACCOUNT_CODE  20
 
 /* Include channel.h after relevant declarations it will need */
 #include "asterisk/channel.h"
@@ -41,68 +42,63 @@
 
 enum ast_cel_eventtype {
 	/*! channel birth */
-	  CEL_CHANNEL_START = 1,
+	CEL_CHANNEL_START = 1,
 	/*! channel end */
-	  CEL_CHANNEL_END = 2,
+	CEL_CHANNEL_END = 2,
 	/*! hangup terminates connection */
-	  CEL_HANGUP = 3,
+	CEL_HANGUP = 3,
 	/*! A ringing phone is answered */
-	  CEL_ANSWER = 4,
+	CEL_ANSWER = 4,
 	/*! an app starts */
-	  CEL_APP_START = 5,
+	CEL_APP_START = 5,
 	/*! an app ends */
-	  CEL_APP_END = 6,
+	CEL_APP_END = 6,
 	/*! a bridge is established */
-	  CEL_BRIDGE_START = 7,
+	CEL_BRIDGE_START = 7,
 	/*! a bridge is torn down */
-	  CEL_BRIDGE_END = 8,
+	CEL_BRIDGE_END = 8,
 	/*! a conference is started */
-	  CEL_CONF_START = 9,
+	CEL_CONF_START = 9,
 	/*! a conference is ended */
-	  CEL_CONF_END = 10,
+	CEL_CONF_END = 10,
 	/*! a channel is parked */
-	  CEL_PARK_START = 11,
+	CEL_PARK_START = 11,
 	/*! channel out of the park */
-	  CEL_PARK_END = 12,
+	CEL_PARK_END = 12,
 	/*! a transfer occurs */
-	  CEL_BLINDTRANSFER = 13,
+	CEL_BLINDTRANSFER = 13,
 	/*! a transfer occurs */
-	  CEL_ATTENDEDTRANSFER = 14,
+	CEL_ATTENDEDTRANSFER = 14,
 	/*! a transfer occurs */
-	  CEL_TRANSFER = 15,
+	CEL_TRANSFER = 15,
 	/*! a 3-way conference, usually part of a transfer */
-	  CEL_HOOKFLASH = 16,
+	CEL_HOOKFLASH = 16,
 	/*! a 3-way conference, usually part of a transfer */
-	  CEL_3WAY_START = 17,
+	CEL_3WAY_START = 17,
 	/*! a 3-way conference, usually part of a transfer */
-	  CEL_3WAY_END = 18,
+	CEL_3WAY_END = 18,
 	/*! channel enters a conference */
-	  CEL_CONF_ENTER = 19,
+	CEL_CONF_ENTER = 19,
 	/*! channel exits a conference */
-	  CEL_CONF_EXIT = 20,
+	CEL_CONF_EXIT = 20,
 	/*! a user-defined event, the event name field should be set  */
-	  CEL_USER_DEFINED = 21,
+	CEL_USER_DEFINED = 21,
 	/*! the last channel with the given linkedid is retired  */
-	  CEL_LINKEDID_END = 22,
+	CEL_LINKEDID_END = 22,
 	/*! a masquerade happened to alter the participants on a bridge  */
-	  CEL_BRIDGE_UPDATE = 23,
+	CEL_BRIDGE_UPDATE = 23,
 	/*! a directed pickup was performed on this channel  */
-	  CEL_PICKUP = 24,
+	CEL_PICKUP = 24,
 	/*! this call was forwarded somewhere else  */
-	  CEL_FORWARD = 25,
+	CEL_FORWARD = 25,
 };
-
-/* there was in the early stages of design, a concept of struct ast_cel,
-   which would take over the role of ast_cdr; but this was eliminated from
-   the design because the event stuff would make this very hard to manage;
-   and it wasn't necessary anyway; the 4 or so members that it might hold
-   were easily added to the event arglists */
 
 /*! \brief Return TRUE if CEL subsystem is enabled */
 int ast_cel_check_enabled(void);
 
-/*! \brief Allocate a CEL record 
- * Returns a malloc'd ast_cel structure, returns NULL on error (malloc failure)
+/*! 
+ * \brief Allocate a CEL record 
+ * \return a malloc'd ast_cel structure, returns NULL on error (malloc failure)
  */
 struct ast_cel *ast_cel_alloc(void);
 
@@ -139,4 +135,4 @@
 int ast_cel_engine_reload(void);
 
 
-#endif /* _ASTERISK_CEL_H */
+#endif /* __AST_CEL_H__ */