Changes between Version 3 and Version 4 of Developers

Timestamp:

Jun 21, 2010, 3:05:39 PM (14 years ago)

Author:

Sebastien Decugis

Comment:

--

Developers

@@ +1 @@
+[[PageOutline(2-4)]]
 == Information for developers ==
 
@@ -55 +56 @@
    Compile the test application extension [wiki:test_app.fdx].
 
+=== Developer's useful files ===
+Here is a list of files that anyone starting with freeDiameter should read first:
+
+ [source:freeDiameter/include/freeDiameter] directory::
+   This directory contains the header files that describe the API for freeDiameter. Typically, a new extension should start by including the [source:freeDiameter/include/freeDiameter/extension.h extension.h] file like this:
+{{{
+#!C
+#include <freeDiameter/extension.h>
+}}}
+   The directory contains:
+ * [source:freeDiameter/include/freeDiameter/extension.h extension.h]: Includes the other files, and provides a macro that can be useful to define the extension entry point.
+ * [source:freeDiameter/include/freeDiameter/freeDiameter.h freeDiameter.h]: detail of the functions available in the daemon, including the description of the callback functions the extension must register.
+ * [source:freeDiameter/include/freeDiameter/libfreeDiameter.h libfreeDiameter.h]: detail of the functions available in the library, as well as macros that can be used for logging and debugging.
+ * [source:freeDiameter/include/freeDiameter/freeDiameter-host.h.in freeDiameter-host.h.in]: This contains the host-specific configuration, generated by CMake.
+
+ [source:freeDiameter/extensions/_sample] directory::
+   This is a skeleton that shows the basic structure of an extension. Other extensions also provide more complex examples, such as how to parse a configuration file or how to register a callback on some messages.
+
+ [source:freeDiameter/extensions/CMakeLists.txt]::
+   The file that must be modified in order to add a new extension and have it compiled along.
+
+If you create new extensions for freeDiameter, please consider '''sharing them with others'''! There are many benefits in doing so, both for others and for you. The source code can be hosted here if you want, please contact dev@freediameter.net in that case. Thank you!
+
 ----