Changeset 639:95a784729cac in freeDiameter for include

Timestamp:

Dec 20, 2010, 1:07:06 PM (13 years ago)

Author:

Sebastien Decugis <sdecugis@nict.go.jp>

Branch:

default

Phase:

public

Message:

Added new opaque pointer to fd_sess_handler_create and fd_disp_register for usability. Bumped API version number.

File:

• include/freeDiameter/libfreeDiameter.h (modified) (9 diffs)

include/freeDiameter/libfreeDiameter.h

@@ -1559 +1559 @@
  *  handler     : location where the new handler must be stored.
  *  cleanup     : a callback function that must be called when the session with associated data is destroyed.
+ *  opaque      : A pointer that is passed to the cleanup callback -- the content is never examined by the framework.
  *
  * DESCRIPTION: 
@@ -1570 +1571 @@
  *  ENOMEM      : Not enough memory to complete the operation
  */
-int fd_sess_handler_create_internal ( struct session_handler ** handler, void (*cleanup)(session_state * state, char * sid) );
+int fd_sess_handler_create_internal ( struct session_handler ** handler, void (*cleanup)(session_state * state, char * sid, void * opaque), void * opaque );
 /* Macro to avoid casting everywhere */
-#define fd_sess_handler_create( _handler, _cleanup ) \
-        fd_sess_handler_create_internal( (_handler), (void (*)(session_state *, char *))(_cleanup) )
+#define fd_sess_handler_create( _handler, _cleanup, _opaque ) \
+        fd_sess_handler_create_internal( (_handler), (void (*)(session_state *, char *, void *))(_cleanup), (void *)(_opaque) )
 
         
@@ -1581 +1582 @@
  * PARAMETERS:
  *  handler     : location of an handler created by fd_sess_handler_create.
+ *  opaque      : the opaque pointer registered with the callback is restored here (if ! NULL).
  *
  * DESCRIPTION: 
@@ -1591 +1593 @@
  *  ENOMEM      : Not enough memory to complete the operation
  */
-int fd_sess_handler_destroy ( struct session_handler ** handler );
+int fd_sess_handler_destroy ( struct session_handler ** handler, void **opaque );
 
 
@@ -2526 +2528 @@
  *  avp         : for callbacks registered with DISP_HOW_AVP or DISP_HOW_AVP_ENUMVAL, direct link to the triggering AVP.
  *  session     : if the message contains a Session-Id AVP, the corresponding session object, NULL otherwise.
+ *  opaque      : An opaque pointer that is registered along the session handler.
  *  action      : upon return, this tells the daemon what to do next.
  *
@@ -2557 +2560 @@
  *  how           : How the callback must be registered.
  *  when          : Values that must match, depending on the how argument.
+ *  opaque        : A pointer that is passed back to the handler. The content is not interpreted by the framework.
  *  handle        : On success, a handler to the registered callback is stored here if not NULL. 
  *                 This handler can be used to unregister the cb.
@@ -2568 +2572 @@
  *  ENOMEM      : Not enough memory to complete the operation
  */
-int fd_disp_register ( int (*cb)( struct msg **, struct avp *, struct session *, enum disp_action *), 
-                        enum disp_how how, struct disp_when * when, struct disp_hdl ** handle );
+int fd_disp_register ( int (*cb)( struct msg **, struct avp *, struct session *, void *, enum disp_action *), 
+                        enum disp_how how, struct disp_when * when, void * opaque, struct disp_hdl ** handle );
 
 /*
@@ -2576 +2580 @@
  * PARAMETERS:
  *  handle       : Location of the handle of the callback that must be unregistered.
+ *  opaque       : If not NULL, the opaque data that was registered is restored here.
  *
  * DESCRIPTION: 
@@ -2584 +2589 @@
  *  EINVAL      : A parameter is invalid.
  */
-int fd_disp_unregister ( struct disp_hdl ** handle );
+int fd_disp_unregister ( struct disp_hdl ** handle, void ** opaque );
 
 /* Destroy all handlers */