Wed Feb 6 12:05:46 EST 2008 Pekka.Pessi@nokia.com

  * nua: using global preferences. Added NUTAG_SHUTDOWN_EVENTS().

Mon Feb 25 14:14:15 EST 2008  Pekka.Pessi@nokia.com
  * nua: added NUTAG_SUB_EXPIRES()



git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@7759 d0543943-73ff-0310-b7d9-9358b9ac24b2

libs/sofia-sip/libsofia-sip-ua/nua/nua_notifier.c

@@ -237,7 +237,8 @@ int nua_subscribe_server_preprocess(nua_server_request_t *sr)
   sip_event_t *o = sip->sip_event;
   char const *event = o ? o->o_type : NULL;
   /* Maximum expiration time */
-  unsigned long expires = 3600;
+  unsigned long expires = sip->sip_expires ? sip->sip_expires->ex_delta : 3600;
+  sip_time_t now = sip_now();
 
   assert(nh && nh->nh_nua->nua_dhandle != nh);
   
@@ -259,9 +260,10 @@ int nua_subscribe_server_preprocess(nua_server_request_t *sr)
 
   nu = nua_dialog_usage_private(du);
 
-  if (sip->sip_expires && sip->sip_expires->ex_delta < expires)
-    expires = sip->sip_expires->ex_delta;
-  nu->nu_requested = sip_now() + expires;
+  if (now + expires >= now)
+    nu->nu_requested = now + expires;
+  else
+    nu->nu_requested = SIP_TIME_MAX - 1;
 
 #if SU_HAVE_EXPERIMENTAL
   nu->nu_etags = 
@@ -295,9 +297,23 @@ int nua_subscribe_server_respond(nua_server_request_t *sr, tagi_t const *tags)
       sip_time_t now = sip_now();
 
       if (nu->nu_requested) {
-	if (nu->nu_requested > nu->nu_expires)
+	if (sip->sip_expires) {
+	  /* Expires in response can only shorten the expiration time */
+	  if (nu->nu_requested > now + sip->sip_expires->ex_delta) 
+	    nu->nu_requested = now + sip->sip_expires->ex_delta;
+	}
+	else {
+	  unsigned sub_expires = NH_PGET(sr->sr_owner, sub_expires);
+	  if (nu->nu_requested > now + sub_expires)
+	    nu->nu_requested = now + sub_expires;
+	}
+
+	if (nu->nu_requested >= now)
 	  nu->nu_expires = nu->nu_requested;
-	else if (nu->nu_expires <= now || nu->nu_requested <= now)
+	else
+	  nu->nu_expires = now;
+
+	if (nu->nu_expires <= now)
 	  nu->nu_substate = nua_substate_terminated;
       }
 
@@ -305,7 +321,7 @@ int nua_subscribe_server_respond(nua_server_request_t *sr, tagi_t const *tags)
 	ex->ex_delta = nu->nu_expires - now;
     }
     else {
-      /* Add header Expires: 0 */
+      /* Always add header Expires: 0 */
     }
 
     if (!sip->sip_expires || sip->sip_expires->ex_delta > ex->ex_delta)

libs/sofia-sip/libsofia-sip-ua/nua/nua_params.h

@@ -107,6 +107,7 @@ typedef struct nua_handle_preferences
 
   /* Subscriber state, i.e. nua_substate_pending */
   unsigned         nhp_substate;
+  unsigned         nhp_sub_expires;
 
   /* REGISTER keepalive intervals */
   unsigned         nhp_keepalive, nhp_keepalive_stream;
@@ -127,9 +128,6 @@ typedef struct nua_handle_preferences
   /** Outbound OPTIONS */
   char const         *nhp_outbound; 
   
-  /** Network detection: NONE, INFORMAL, TRY_FULL */
-  int                 nhp_detect_network_updates;
-  
   sip_allow_t        *nhp_appl_method;
 
   /** Initial route set */
@@ -137,6 +135,12 @@ typedef struct nua_handle_preferences
 
   union { struct {
     /* A bit for each feature set by application */
+    /* NOTE: 
+       Some compilers behave weird if there are bitfields
+       together with width > 32 
+       So there should be a padding field (unsigned:0;) 
+       every 32 bits. 
+    */
     unsigned nhb_retry_count:1;
     unsigned nhb_max_subscriptions:1;
 
@@ -166,13 +170,15 @@ typedef struct nua_handle_preferences
     unsigned nhb_refer_with_id:1;
     unsigned nhb_refer_expires:1;
     unsigned nhb_substate:1;
+    unsigned nhb_sub_expires:1;
     unsigned nhb_keepalive:1;
     unsigned nhb_keepalive_stream:1;
     unsigned nhb_registrar:1;
 
     unsigned nhb_allow:1;
+    unsigned :0;		/* at most 32 bits before this point */
     unsigned nhb_supported:1;
-    unsigned :0;		/* at most 32 bits ... */
+
     unsigned nhb_allow_events:1;
     unsigned nhb_user_agent:1;
     unsigned nhb_organization:1;
@@ -183,7 +189,6 @@ typedef struct nua_handle_preferences
     unsigned nhb_m_features:1;
     unsigned nhb_instance:1;
     unsigned nhb_outbound:1;
-    unsigned nhb_detect_network_updates:1;
     unsigned nhb_appl_method:1;
     unsigned nhb_initial_route:1;
     unsigned :0;
@@ -194,6 +199,26 @@ typedef struct nua_handle_preferences
 
 #define nhp_set nhp_set_.set_bits
 
+/** Global preferences for nua. */
+typedef struct {
+  /** Network detection: NONE, INFORMAL, TRY_FULL */
+  signed int ngp_detect_network_updates:3;
+  /** Pass events during shutdown, too */
+  int ngp_shutdown_events:1;
+
+  unsigned :0;			/* pad */
+  union { struct {
+    /* A bit for each feature set by application */
+    unsigned ngp_detect_network_updates:1;
+    unsigned ngp_shutdown_events:1;
+    unsigned :0;
+  } set_bits; 
+    unsigned set_unsigned[2];
+  } ngp_set_;
+} nua_global_preferences_t;
+
+#define ngp_set ngp_set_.set_bits
+
 #define DNHP_GET(dnhp, pref) ((dnhp)->nhp_##pref)
 
 #define NHP_GET(nhp, dnhp, pref)					\

libs/sofia-sip/libsofia-sip-ua/nua/nua_stack.c

@@ -209,7 +209,7 @@ int nua_stack_init(su_root_t *root, nua_t *nua)
   if (nua_stack_set_from(nua, 1, nua->nua_args) < 0)
     return -1;
 
-  if (NHP_ISSET(dnh->nh_prefs, detect_network_updates))
+  if (nua->nua_prefs->ngp_detect_network_updates)
     nua_stack_launch_network_change_detector(nua);
 
   nua_stack_timer(nua, nua->nua_timer, NULL);

libs/sofia-sip/libsofia-sip-ua/nua/nua_stack.h

@@ -217,28 +217,31 @@ struct nua_s {
   su_clone_r   	       nua_clone;
   su_task_r            nua_client;
 
-  su_network_changed_t *nua_nw_changed;
-
   nua_callback_f       nua_callback;
   nua_magic_t         *nua_magic;
 
   nua_event_frame_t   *nua_current;
   nua_saved_event_t    nua_signal[1];
 
+  /**< Used by stop-and-wait args calls */
+  tagi_t const        *nua_args;
+
   /* Engine state flags */
+  sip_time_t           nua_shutdown;
+
   unsigned             nua_shutdown_started:1; /**< Shutdown initiated */
   unsigned             nua_shutdown_final:1; /**< Shutdown is complete */
 
   unsigned             nua_from_is_set;
   unsigned :0;
   
-  /**< Used by stop-and-wait args calls */
-  tagi_t const        *nua_args;
-
   /**< Local SIP address. Contents are kept around for ever. */
   sip_from_t           nua_from[1];
 
+  /* ---------------------------------------------------------------------- */
+
   /* Protocol (server) side */
+  su_network_changed_t *nua_nw_changed;
 
   nua_registration_t *nua_registrations; /**< Active registrations */
 
@@ -250,21 +253,8 @@ struct nua_s {
   nta_agent_t        *nua_nta;
   su_timer_t         *nua_timer;
 
-  void         	      *nua_sip_parser;
-
-  sip_time_t           nua_shutdown;
-
-  /* Route */
-  sip_service_route_t *nua_service_route;
-
   /* User-agent parameters */
-  unsigned             nua_media_enable:1;
-
-  unsigned     	       :0;
-
-#if HAVE_SMIME		/* Start NRC Boston */
-  sm_object_t          *sm;
-#endif                  /* End NRC Boston */
+  nua_global_preferences_t nua_prefs[1];
 
   nua_handle_t        *nua_handles;
   nua_handle_t       **nua_handles_tail;

libs/sofia-sip/libsofia-sip-ua/nua/nua_tag.c

@@ -227,21 +227,22 @@
  * - NUTAG_ALLOW_EVENTS(), SIPTAG_ALLOW_EVENTS(), and
  *                          SIPTAG_ALLOW_EVENTS_STR()
  * - NUTAG_MAX_SUBSCRIPTIONS()
- * - NUTAG_SUBSTATE()
+ * - NUTAG_SUBSTATE(), NUTAG_SUB_EXPIRES()
  * @par Specifications
  * - @RFC3265
  *
  * @par SIP Event Subscriber
  * - nua_subscribe(), #nua_r_subscribe, #nua_i_notify, NUTAG_SUBSTATE(),
- *   SIPTAG_EVENT(), SIPTAG_EXPIRES(),
+ *   SIPTAG_EVENT(), SIPTAG_EXPIRES()
  * - nua_unsubscribe(), #nua_r_unsubscribe()
  * @par Specifications
  * - @RFC3265
  *
  * @par SIP Event Notifier
  * - #nua_i_subscribe(), nua_notify(), #nua_r_notify,
- *   NUTAG_SUBSTATE(), SIPTAG_EVENT()
+ *   NUTAG_SUBSTATE(), NUTAG_SUB_EXPIRES(), SIPTAG_EVENT()
  * Settings:
+ * - NUTAG_SUB_EXPIRES()
  * - NUTAG_ALLOW_EVENTS(), SIPTAG_ALLOW_EVENTS(), and
  *                          SIPTAG_ALLOW_EVENTS_STR()
  * - NUTAG_ALLOW("SUBSCRIBE"), NUTAG_APPL_METHOD("SUBSCRIBE")
@@ -267,6 +268,8 @@
  * Settings:
  * - NUTAG_ALLOW(x), NUTAG_APPL_METHOD(x)
  *
+ * @par Server Shutdown
+ * - nua_shutdown(), NUTAG_SHUTDOWN_EVENTS(), nua_destroy().
  */
 
 /* @par S/MIME
@@ -769,7 +772,7 @@ tag_typedef_t nutag_answer_sent = BOOLTAG_TYPEDEF(answer_sent);
  * - with nua_create(), nua_set_params(), nua_get_params(),
  *   nua_handle(), nua_set_hparams(), nua_get_hparams(), and
  *   nua_notifier() to change the default subscription state returned by
- *    the intenal event server
+ *   the internal event server
  * - with nua_notify() and nua_respond() to SUBSCRIBE to determine the
  *   subscription state (if application include @SubscriptionState
  *   header in the tag list, the NUTAG_SUBSTATE() value is ignored)
@@ -806,6 +809,39 @@ tag_typedef_t nutag_substate = INTTAG_TYPEDEF(substate);
  */
 
 
+/**@def NUTAG_SUB_EXPIRES()
+ *
+ * Default expiration time of subscriptions.
+ *
+ * @par Used with
+ * - with nua_create(), nua_set_params(), nua_get_params(), nua_handle(),
+ *   nua_set_hparams(), nua_get_hparams(), nua_respond(), nua_notify(), and
+ *   nua_notifier() to change the default expiration time of subscriptions
+ *
+ * @par Parameter type
+ *    unsigned int
+ *
+ * @par Values
+ *   - default expiration time in seconds
+ *
+ * Note that the expires parameter in @SubscriptionState or @Expires header
+ * in the nua_response() to the SUBSCRIBE overrides the default subscription
+ * expiration specified by NUTAG_SUB_EXPIRES().
+ *
+ * @sa @RFC3265, NUTAG_REFER_EXPIRES(), @Expires, SIPTAG_EXPIRES(),
+ * SIPTAG_EXPIRES_STR(), @SubscriptionState, nua_respond(), nua_notifier(),
+ * #nua_r_subscribe, #nua_i_subscribe, #nua_r_refer, #nua_r_notify,
+ * #nua_i_notify.
+ *
+ * Corresponding tag taking reference parameter is NUTAG_SUB_EXPIRES_REF().
+ */
+tag_typedef_t nutag_sub_expires = UINTTAG_TYPEDEF(substate);
+
+/**@def NUTAG_SUB_EXPIRES_REF(x) 
+ * Reference tag for NUTAG_SUB_EXPIRES().
+ */
+
+
 /**@def NUTAG_NEWSUB()
  *
  * Send unsolicited NOTIFY request.
@@ -1075,17 +1111,17 @@ tag_typedef_t nutag_update_refresh = BOOLTAG_TYPEDEF(update_refresh);
  * REFER.
  *
  * @par Used with
- *    nua_set_params() \n
- *    nua_get_params() \n
- *    nua_set_hparams() \n
- *    nua_get_hparams() \n
+ *    nua_handle(), nua_respond() \n
+ *    nua_set_params() or nua_set_hparams() \n
+ *    nua_get_params() or nua_get_hparams()
  *
  * @par Parameter type
  *    unsigned int
  *
  * @par Values
- *    @c 0  disable \n
- *    @c >0 interval in seconds
+ *    - default interval in seconds
+ *
+ * @sa NUTAG_SUB_EXPIRES()
  *
  * Corresponding tag taking reference parameter is NUTAG_REFER_EXPIRES_REF().
  */
@@ -1570,6 +1606,9 @@ extern msg_hclass_t sip_route_class[];
  * NUTAG_INITIAL_ROUTE_STR() tags, the route set is constructed from them
  * all.
  *
+ * The initial route is inserted into request message before the route
+ * entries set with SIPTAG_ROUTE() or SIPTAG_ROUTE_STR().
+ *
  * @par Used with
  *    nua_set_params() \n
  *    nua_set_hparams() \n
@@ -2736,6 +2775,39 @@ tag_typedef_t nutag_dialog = UINTTAG_TYPEDEF(dialog);
  * Reference tag for NUTAG_SIP_PARSER().
  */
 
+
+/**@def NUTAG_SHUTDOWN_EVENTS(x)
+ *
+ * Allow passing of normal events when stack is being shut down.
+ *
+ * By default, only #nua_r_shutdown events are passed to application after
+ * calling nua_shutdown(). If application is interested in nua events during
+ * shutdown, it should give NUTAG_SHUTDOWN_EVENTS(1) to nua_create() or
+ * nua_set_params() called before nua_shutdown().
+ *
+ * @par Used with
+ *    nua_create(), nua_set_params().
+ *
+ * @par Parameter type
+ *    int (boolean)
+ *
+ * @par Values
+ *    @c 0   False \n
+ *    @c !=0 True
+ *
+ * Corresponding tag taking reference parameter is NUTAG_SHUTDOWN_EVENTS_REF().
+ *
+ * @sa nua_shutdown(), nua_destroy().
+ * 
+ * @NEW_1_12_9.
+ */
+tag_typedef_t nutag_shutdown_events = BOOLTAG_TYPEDEF(shutdown_events);
+
+/**@def NUTAG_SHUTDOWN_EVENTS_REF(x) 
+ * Reference tag for NUTAG_SHUTDOWN_EVENTS().
+ */
+
+
 /* ---------------------------------------------------------------------- */
 
 tag_typedef_t nutag_soa_session = PTRTAG_TYPEDEF(soa_session);

libs/sofia-sip/libsofia-sip-ua/nua/sofia-sip/nua_tag.h

@@ -497,6 +497,11 @@ SOFIAPUBFUN char const *nua_substate_name(enum nua_substate substate);
 /** Convert string to enum nua_substate. @NEW_1_12_5. */
 SOFIAPUBFUN enum nua_substate nua_substate_make(char const *sip_substate);
 
+#define NUTAG_SUB_EXPIRES(x) nutag_sub_expires, tag_uint_v(x)
+SOFIAPUBVAR tag_typedef_t nutag_sub_expires;
+#define NUTAG_SUB_EXPIRES_REF(x) nutag_sub_expires_ref, tag_uint_vr(&(x))
+SOFIAPUBVAR tag_typedef_t nutag_sub_expires_ref;
+
 #define NUTAG_NEWSUB(x)   nutag_newsub, tag_bool_v(x)
 SOFIAPUBVAR tag_typedef_t nutag_newsub;
 #define NUTAG_NEWSUB_REF(x) nutag_newsub_ref, tag_bool_vr(&(x))
@@ -569,6 +574,13 @@ SOFIAPUBVAR tag_typedef_t nutag_detect_network_updates;
           nutag_detect_network_updates_ref, tag_int_vr(&(x))
 SOFIAPUBVAR tag_typedef_t nutag_detect_network_updates_ref;
 
+#define NUTAG_SHUTDOWN_EVENTS(x) \
+  nutag_shutdown_events, tag_bool_v(x)
+SOFIAPUBVAR tag_typedef_t nutag_shutdown_events;
+#define NUTAG_SHUTDOWN_EVENTS_REF(x) \
+  nutag_shutdown_events_ref, tag_bool_vr(&(x))
+SOFIAPUBVAR tag_typedef_t nutag_shutdown_events_ref;
+
 /* Pass nua handle as tagged argument */
 #if SU_INLINE_TAG_CAST
 su_inline tag_value_t nutag_handle_v(nua_handle_t *v) { return (tag_value_t)v; }

libs/sofia-sip/libsofia-sip-ua/nua/test_nua_params.c

@@ -203,6 +203,7 @@ int test_nua_params(struct context *ctx)
 		 NUTAG_REFER_EXPIRES(333),
 		 NUTAG_REFER_WITH_ID(0),
 		 NUTAG_SUBSTATE(nua_substate_pending),
+		 NUTAG_SUB_EXPIRES(3700),
 
 		 NUTAG_KEEPALIVE(66),
 		 NUTAG_KEEPALIVE_STREAM(33),
@@ -284,6 +285,7 @@ int test_nua_params(struct context *ctx)
     int auth_cache = -1;
     unsigned refer_expires = (unsigned)-1;
     int refer_with_id = -1;
+    unsigned sub_expires = (unsigned)-1;
     int substate = -1;
 
     sip_allow_t const *allow = NONE;
@@ -352,6 +354,7 @@ int test_nua_params(struct context *ctx)
 	       	NUTAG_REFER_EXPIRES_REF(refer_expires),
 	       	NUTAG_REFER_WITH_ID_REF(refer_with_id),
 	       	NUTAG_SUBSTATE_REF(substate),
+		NUTAG_SUB_EXPIRES_REF(sub_expires),
 
 	       	SIPTAG_SUPPORTED_REF(supported),
 	       	SIPTAG_SUPPORTED_STR_REF(supported_str),
@@ -382,7 +385,7 @@ int test_nua_params(struct context *ctx)
 		NUTAG_INSTANCE_REF(instance),
 
 		TAG_END());
-    TEST(n, 50);
+    TEST(n, 51);
 
     TEST_S(sip_header_as_string(tmphome, (void *)from), Alice);
     TEST_S(from_str, Alice);
@@ -416,6 +419,7 @@ int test_nua_params(struct context *ctx)
     TEST(refer_expires, 333);
     TEST(refer_with_id, 0);
     TEST(substate, nua_substate_pending);
+    TEST(sub_expires, 3700);
 
     TEST_S(sip_header_as_string(tmphome, (void *)allow), "OPTIONS, INFO, ACK");
     TEST_S(allow_str, "OPTIONS, INFO, ACK");
@@ -492,6 +496,7 @@ int test_nua_params(struct context *ctx)
     unsigned refer_expires = (unsigned)-1;
     int refer_with_id = -1;
     int substate = -1;
+    unsigned sub_expires = (unsigned)-1;
 
     sip_allow_t const *allow = NONE;
     char const   *allow_str = "NONE";
@@ -552,6 +557,7 @@ int test_nua_params(struct context *ctx)
 	       	NUTAG_PATH_ENABLE_REF(path_enable),
 		NUTAG_AUTH_CACHE_REF(auth_cache),
 	       	NUTAG_SUBSTATE_REF(substate),
+	       	NUTAG_SUB_EXPIRES_REF(sub_expires),
 
 	       	SIPTAG_SUPPORTED_REF(supported),
 	       	SIPTAG_SUPPORTED_STR_REF(supported_str),
@@ -607,6 +613,7 @@ int test_nua_params(struct context *ctx)
     TEST(refer_expires, (unsigned)-1);
     TEST(refer_with_id, -1);
     TEST(substate, -1);
+    TEST(sub_expires, -1);
 
     TEST_P(allow, NONE);
     TEST_S(allow_str, "NONE");