Changeset 85:e5fcd672caff in freeDiameter for include/freeDiameter/libfreeDiameter.h

Timestamp:

Dec 3, 2009, 2:59:23 PM (14 years ago)

Author:

Sebastien Decugis <sdecugis@nict.go.jp>

Branch:

default

Phase:

public

Message:

Added new function to retrieve messages sessions easily

File:

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

include/freeDiameter/libfreeDiameter.h

@@ -1473 +1473 @@
  *
  * DESCRIPTION: 
- *   Retrieve a session object from a Session-Id string. Calling this function makes an implicit call to the
- *  fd_sess_link function on the returned session. In case no session object was previously existing with this 
+ *   Retrieve a session object from a Session-Id string. In case no session object was previously existing with this 
  *  id, a new object is silently created (equivalent to fd_sess_new with flag SESSION_NEW_FULL).
  *
@@ -1648 +1647 @@
 int  fd_rtd_candidate_reorder(struct fd_list * candidates);
 
+/* Note : it is fine for a callback to add a new entry in the candidates list after the list has been extracted. The diamid must then be malloc'd. */
+/* Beware that this could lead to routing loops */
 
 /*============================================================*/
@@ -2052 +2053 @@
 
 
+/*
+ * FUNCTION:    fd_msg_sess_get
+ *
+ * PARAMETERS:
+ *  dict        : the dictionary that contains the Session-Id AVP definition
+ *  msg         : A valid message.
+ *  session     : Location to store the session pointer when retrieved.
+ *  new         : Indicates if the session has been created.
+ *
+ * DESCRIPTION:
+ *  This function retrieves or creates the session object corresponding to a message.
+ * If the message does not contain a Session-Id AVP, *session == NULL on return.
+ * Note that the Session-Id AVP must never be modified after created in a message.
+ *
+ * RETURN VALUE:
+ *  0 : success
+ * !0 : standard error code.
+ */
+int fd_msg_sess_get(struct dictionary * dict, struct msg * msg, struct session ** session, int * new);
+
 /***************************************/
 /*   Manage AVP values                 */