nua_stack.h 18.5 KB
Newer Older
Pekka Pessi's avatar
Pekka Pessi committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2005 Nokia Corporation.
 *
 * Contact: Pekka Pessi <pekka.pessi@nokia.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

/**@file nua_stack.h 
 * @brief  Nokia User Agent Library - internal stack interface
 *
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>
 * @author Kai Vehmanen <Kai.Vehmanen@nokia.com>
 *
 * @date Created: Wed Feb 14 17:09:44 2001 ppessi
 */

#ifndef NUA_STACK_H
/** Defined when <nua_stack.h> has been included. */
Pekka Pessi's avatar
Pekka Pessi committed
36
#define NUA_STACK_H
Pekka Pessi's avatar
Pekka Pessi committed
37 38 39 40 41 42 43 44 45 46 47 48 49

#if HAVE_UICC_H
#include <uicc.h>
#endif

#if HAVE_PTHREAD_H
#include <pthread.h>
#endif

#if HAVE_SIGCOMP
#include <sigcomp.h>
#endif

Pekka Pessi's avatar
Pekka Pessi committed
50 51
#include "soa.h"

Pekka Pessi's avatar
Pekka Pessi committed
52 53 54 55 56 57 58 59 60 61 62 63 64
typedef struct event_s event_t;

#define       NONE ((void *)-1)

enum nh_kind {
  nh_has_nothing,
  nh_has_invite,
  nh_has_subscribe,
  nh_has_notify,
  nh_has_register,
  nh_has_streaming
};

65 66 67 68 69 70
enum nh_oa_event {
  nua_sdp_none,
  nua_sdp_offer_sent,		/**< O/A-1 offer sent */
  nua_sdp_answer_recv,		/**< O/A-2 answer received */
  nua_sdp_offer_recv,		/**< O/A-3 offer received */
  nua_sdp_answer_sent		/**< O/A-4 answer sent */
71 72
};

Pekka Pessi's avatar
Pekka Pessi committed
73 74 75 76 77 78
typedef struct nua_chat_s nua_chat_t;
typedef struct nua_remote_s nua_remote_t;

typedef struct nua_dialog_state nua_dialog_state_t;
typedef union  nua_dialog_usage nua_dialog_usage_t;
typedef struct nua_client_request nua_client_request_t; 
Pekka Pessi's avatar
Pekka Pessi committed
79
typedef struct nua_server_request nua_server_request_t; 
Pekka Pessi's avatar
Pekka Pessi committed
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126

typedef void nh_pending_f(nua_handle_t *nh, 
			  nua_dialog_usage_t *du,
			  sip_time_t now);

enum nua_dialog_usage_e
{
  nua_transaction_usage = 0,
  nua_session_usage,
  nua_notifier_usage,
  nua_subscriber_usage,
  nua_register_usage,
  nua_publish_usage
};

struct nua_common_usage {
  nua_dialog_usage_t *cu_next;
  unsigned     cu_kind:3;
  unsigned     cu_terminating:1;	/**< Trying to terminate */
  unsigned     cu_ready:1;	/**< Established usage */
  unsigned:0;
  /** Pending operation.
   *
   * The nh_pending() is called 
   * a) when current time sip_now() will soon exceed nh_refresh (now > 1)
   * b) when handle operation is restarted (now is 1)
   * c) when handle is destroyed (now is 0)
   */
  nh_pending_f   *cu_pending;
  sip_time_t      cu_refresh;	/**< When execute cu_pending */
};

struct nua_session_usage {
  struct nua_common_usage su_common[1];
};

struct nua_event_usage {
  struct nua_common_usage de_common[1];
  msg_t *de_msg;
  sip_event_t const *de_event;		/**< Event of usage */
  unsigned           de_substate:2;	/**< Subscription state */
  unsigned:0;
};

struct nua_register_usage {
  struct nua_common_usage ru_common[1];
  msg_t *ru_msg;
127
  struct sigcomp_compartment *ru_compartment;
Pekka Pessi's avatar
Pekka Pessi committed
128 129 130 131 132
};

struct nua_publish_usage {
  struct nua_common_usage pu_common[1];
  msg_t *pu_msg;
133
  sip_etag_t *pu_etag;	/**< ETag */
Pekka Pessi's avatar
Pekka Pessi committed
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
};


union nua_dialog_usage
{
  nua_dialog_usage_t *du_next;
  struct nua_common_usage du_common[1];
#define du_kind du_common->cu_kind
#define du_terminating du_common->cu_terminating
#define du_ready du_common->cu_ready
#define du_pending du_common->cu_pending
#define du_refresh du_common->cu_refresh

  struct nua_session_usage du_session[1];
#define du_event du_subscriber->de_event
  struct nua_event_usage du_subscriber[1];
  struct nua_event_usage du_notifier[1];
  struct nua_register_usage du_register[1];
  struct nua_publish_usage du_publisher[1];
};


struct nua_dialog_state
{
  /** Dialog usages. */
159
  nua_dialog_usage_t     *ds_usage;
Pekka Pessi's avatar
Pekka Pessi committed
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199

  /* Dialog and subscription state */
  unsigned ds_route:1;		/**< We have route */
  unsigned ds_terminated:1;	/**< Being terminated */

  unsigned ds_has_session:1;	/**< We have session */
  unsigned ds_has_register:1;	/**< We have registration */
  unsigned ds_has_publish:1;	/**< We have publish */
  unsigned ds_has_events:1;	/**< We have some events */
  unsigned ds_has_subscription:1; /**< We have subscriptions */
  unsigned ds_has_notifier:1;	/**< We have notifiers */
  unsigned :0;

  sip_from_t const *ds_local;		/**< Local address */
  sip_to_t const *ds_remote;		/**< Remote address */
  nta_leg_t      *ds_leg;
  char const     *ds_remote_tag;	/**< Remote tag (if any). 
					 * Should be non-NULL 
					 * if dialog is established.
					 */

  struct nua_remote_s {
    sip_allow_t      *nr_allow;
    sip_accept_t     *nr_accept;
    sip_require_t    *nr_require;
    sip_supported_t  *nr_supported;
    sip_user_agent_t *nr_user_agent;
  } ds_remote_ua[1];
};

typedef void crequest_restart_f(nua_handle_t *, tagi_t *tags);

struct nua_client_request
{
  nua_event_t         cr_event;		/**< Request event */
  crequest_restart_f *cr_restart;
  nta_outgoing_t     *cr_orq;
  msg_t              *cr_msg;
  nua_dialog_usage_t *cr_usage;
  unsigned short      cr_retry_count;   /**< Retry count for this request */
Pekka Pessi's avatar
Pekka Pessi committed
200 201 202 203 204 205

  unsigned short      cr_answer_recv;   /**< Recv answer in response */
  unsigned            cr_offer_sent:1;  /**< Sent offer in this request */

  unsigned            cr_offer_recv:1;  /**< Recv offer in a response */
  unsigned            cr_answer_sent:1; /**< Sent answer in (PR)ACK */
Pekka Pessi's avatar
Pekka Pessi committed
206 207 208 209 210 211 212
};

typedef struct nua_session_state
{
  /** Session-related state */
  unsigned        ss_active:1;		/**< Session is currently active. */
  
213 214
  /* enum nua_callstate */
  unsigned        ss_state:4;		/**< Session status (enum nua_callstate) */
Pekka Pessi's avatar
Pekka Pessi committed
215
  
216
  unsigned        ss_100rel:1;	        /**< Use 100rel, send 183 */
Pekka Pessi's avatar
Pekka Pessi committed
217 218 219 220 221 222 223 224 225 226 227 228 229 230
  unsigned        ss_alerting:1;	/**< 180 is sent/received */
  
  unsigned        ss_update_needed:2;	/**< Send an UPDATE (do O/A if > 1) */

  unsigned        ss_precondition:1;	/**< Precondition required */

  unsigned        ss_hold_remote:1;	/**< We are holding remote */
  
  unsigned        : 0;
  
  unsigned        ss_session_timer;	/**< Value of Session-Expires (delta) */
  unsigned        ss_min_se;		/**< Minimum session expires */
  enum nua_session_refresher ss_refresher; /**< none, local or remote */

231 232 233 234
  char const     *ss_ack_needed;	/**< Send an ACK
					 * (do O/A, if "offer" or "answer")
					 */

Pekka Pessi's avatar
Pekka Pessi committed
235 236 237 238 239 240
  nua_dialog_usage_t *ss_usage;

  /* Outgoing invite */
  struct nua_client_request ss_crequest[1];

  /* Incoming invite */
Pekka Pessi's avatar
Pekka Pessi committed
241
  struct nua_server_request {
Pekka Pessi's avatar
Pekka Pessi committed
242 243 244 245 246 247

  /** Respond to an incoming INVITE transaction.
   *
   * When the application responds to an incoming INVITE transaction with
   * nua_respond(), the ss_respond_to_invite() is called (if non-NULL).
   */
Pekka Pessi's avatar
Pekka Pessi committed
248 249 250 251
    void (*sr_respond)(nua_t *nua, nua_handle_t *nh,
		       int status, char const *phrase, 
		       tagi_t const *tags);
    nta_incoming_t *sr_irq;
252
    msg_t *sr_msg;		/**< Request message */
Pekka Pessi's avatar
Pekka Pessi committed
253 254 255

    unsigned sr_offer_recv:1;	/**< We have received an offer */
    unsigned sr_answer_sent:2;	/**< We have answered (reliably, if >1) */
Pekka Pessi's avatar
Pekka Pessi committed
256

Pekka Pessi's avatar
Pekka Pessi committed
257 258 259
    unsigned sr_offer_sent:1;	/**< We have offered SDP */
    unsigned sr_answer_recv:1;	/**< We have received SDP answer */
  } ss_srequest[1];
Pekka Pessi's avatar
Pekka Pessi committed
260 261
} nua_session_state_t;

Pekka Pessi's avatar
Pekka Pessi committed
262 263 264
#define \
  NH_ACTIVE_MEDIA_TAGS(include, soa)					\
  TAG_IF((include) && (soa) && soa_is_audio_active(soa) >= 0,		\
Pekka Pessi's avatar
Pekka Pessi committed
265
	 SOATAG_ACTIVE_AUDIO(soa_is_audio_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
266
  TAG_IF((include) && (soa) && soa_is_video_active(soa) >= 0,		\
Pekka Pessi's avatar
Pekka Pessi committed
267
	 SOATAG_ACTIVE_VIDEO(soa_is_video_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
268
  TAG_IF((include) && (soa) && soa_is_image_active(soa) >= 0,		\
Pekka Pessi's avatar
Pekka Pessi committed
269
	 SOATAG_ACTIVE_IMAGE(soa_is_image_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
270
  TAG_IF((include) && (soa) && soa_is_chat_active(soa) >= 0,		\
Pekka Pessi's avatar
Pekka Pessi committed
271
	 SOATAG_ACTIVE_CHAT(soa_is_chat_active(soa)))
Pekka Pessi's avatar
Pekka Pessi committed
272 273 274 275

#define \
  NH_REMOTE_MEDIA_TAGS(include, soa)					\
  TAG_IF((include) && (soa) && soa_is_remote_audio_active(soa) >= 0,	\
Pekka Pessi's avatar
Pekka Pessi committed
276
	 SOATAG_ACTIVE_AUDIO(soa_is_remote_audio_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
277
  TAG_IF((include) && (soa) && soa_is_remote_video_active(soa) >= 0,	\
Pekka Pessi's avatar
Pekka Pessi committed
278
	 SOATAG_ACTIVE_VIDEO(soa_is_remote_video_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
279
  TAG_IF((include) && (soa) && soa_is_remote_image_active(soa) >= 0,	\
Pekka Pessi's avatar
Pekka Pessi committed
280
	 SOATAG_ACTIVE_IMAGE(soa_is_remote_image_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
281
  TAG_IF((include) && (soa) && soa_is_remote_chat_active(soa) >= 0,	\
Pekka Pessi's avatar
Pekka Pessi committed
282
	 SOATAG_ACTIVE_CHAT(soa_is_remote_chat_active(soa)))
Pekka Pessi's avatar
Pekka Pessi committed
283

284 285 286 287 288 289 290 291 292 293 294 295 296 297
typedef struct nua_handle_preferences
{
  unsigned         nhp_retry_count;	/**< times to retry a request */
  unsigned         nhp_max_subscriptions;

  /* Session-related preferences */
  unsigned     	   nhp_invite_enable:1;
  unsigned     	   nhp_auto_alert:1;
  unsigned         nhp_early_media:1;/**< Establish early media session */
  unsigned         nhp_auto_answer:1;
  unsigned         nhp_auto_ack:1; /**< Automatically ACK a final response */
  unsigned         :0;

  /** INVITE timeout. 
Pekka Pessi's avatar
Pekka Pessi committed
298 299 300
   *
   * If no response is received in nhp_invite_timeout seconds,
   * INVITE client transaction times out
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
   */
  unsigned         nhp_invite_timeout;

  /** Default session timer (in seconds, 0 disables) */
  unsigned         nhp_session_timer;
  /** Default Min-SE Delta value */
  unsigned         nhp_min_se;
  /** no (preference), local or remote */
  enum nua_session_refresher nhp_refresher; 
  unsigned         nhp_update_refresh:1; /**< Use UPDATE to refresh */
  
  /* Messaging preferences */
  unsigned     	   nhp_message_enable : 1;
  /** Be bug-compatible with Windows Messenger */
  unsigned     	   nhp_win_messenger_enable : 1;
  /** PIM-IW hack */
  unsigned         nhp_message_auto_respond : 1;

  /* Preferences for registration (and dialog establishment) */
  unsigned         nhp_callee_caps:1; /**< Add callee caps to contact */
  unsigned         nhp_media_features:1;/**< Add media features to caps*/
  /** Enable Service-Route */
  unsigned         nhp_service_route_enable:1;
  /** Enable Path */
  unsigned         nhp_path_enable:1;

  unsigned:0;

329 330 331
  /* Default lifetime for implicit subscriptions created by REFER */
  unsigned         nhp_refer_expires;

332 333 334
  /* Subscriber state, i.e. nua_substate_pending */
  unsigned         nhp_substate;

335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
  sip_allow_t        *nhp_allow;
  sip_supported_t    *nhp_supported;
  sip_user_agent_t   *nhp_user_agent;
  char const         *nhp_ua_name;
  sip_organization_t *nhp_organization;
  
  /* A bit for each feature set by application */
  union {
    uint32_t set_any;
    struct {
      unsigned nhp_retry_count:1;
      unsigned nhp_max_subscriptions:1;
      unsigned nhp_invite_enable:1;
      unsigned nhp_auto_alert:1;
      unsigned nhp_early_media:1;
      unsigned nhp_auto_answer:1;
      unsigned nhp_auto_ack:1;
      unsigned nhp_invite_timeout:1;
      unsigned nhp_session_timer:1;
      unsigned nhp_min_se:1;
      unsigned nhp_refresher:1; 
      unsigned nhp_update_refresh:1;
      unsigned nhp_message_enable:1;
      unsigned nhp_win_messenger_enable:1;
      unsigned nhp_message_auto_respond:1;
      unsigned nhp_callee_caps:1;
      unsigned nhp_media_features:1;
      unsigned nhp_service_route_enable:1;
      unsigned nhp_path_enable:1;
364
      unsigned nhp_refer_expires:1;
365
      unsigned nhp_substate:1;
366 367 368 369 370 371 372 373 374 375
      unsigned nhp_allow:1;
      unsigned nhp_supported:1;
      unsigned nhp_user_agent:1;
      unsigned nhp_ua_name:1;
      unsigned nhp_organization:1;
      unsigned :0;
    } set_bits;
  } nhp_set;
} nua_handle_preferences_t;

376
/* Get preference from default handle */
377 378 379 380 381 382
#define DNH_PGET(dnh, pref)						\
  DNHP_GET((dnh)->nh_prefs, pref)
#define DNHP_GET(dnhp, pref) ((dnhp)->nhp_##pref)
#define DNHP_SET(dnhp, pref, value) \
  ((dnhp)->nhp_##pref = (value), (dnhp)->nhp_set.set_bits.nhp_##pref = 1)

383
/* Get preference from handle, if set, otherwise from default handle */
384 385 386 387 388 389
#define NH_PGET(nh, pref)						\
  NHP_GET((nh)->nh_prefs, (nh)->nh_nua->nua_dhandle->nh_prefs, pref)
#define NHP_GET(nhp, dnhp, pref)					\
  ((nhp)->nhp_set.set_bits.nhp_##pref					\
   ? (nhp)->nhp_##pref : (dnhp)->nhp_##pref)

390 391
/* Check if preference is set in the handle */
#define NH_PISSET(nh, pref)						\
392
  (NHP_ISSET((nh)->nh_prefs, pref) &&					\
393 394
   (nh)->nh_nua->nua_dhandle->nh_prefs != (nh)->nh_prefs)

395 396 397 398
/* Check if preference is set */
#define NHP_ISSET(nhp, pref)						\
  ((nhp)->nhp_set.set_bits.nhp_##pref)

399 400 401 402
#define NHP_UNSET_ALL(nhp) ((nhp)->nhp_set.set_any = 0)
#define NHP_SET_ALL(nhp) ((nhp)->nhp_set.set_any = 0xffffffffU)
#define NHP_IS_ANY_SET(nhp) ((nhp)->nhp_set.set_any != 0)

Pekka Pessi's avatar
Pekka Pessi committed
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
/** NUA handle. 
 *
 */
struct nua_handle_s 
{
  su_home_t       nh_home[1];	/**< Memory home  */
  nua_handle_t   *nh_next;
  nua_handle_t  **nh_prev;

  nua_t        	 *nh_nua;	/**< Pointer to NUA object  */
  void           *nh_valid;
  nua_hmagic_t 	 *nh_magic;	/**< Application context */

  tagi_t         *nh_tags;	/**< Default tags */

#if HAVE_PTHREAD_H
  pthread_rwlock_t nh_refcount[1];  
#else
  unsigned        nh_refcount;
#endif

424 425
  nua_handle_preferences_t *nh_prefs; /**< Preferences */

Pekka Pessi's avatar
Pekka Pessi committed
426
  /* Handle state */
427 428
  nua_event_t     nh_special;	/**< Special event */

Pekka Pessi's avatar
Pekka Pessi committed
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
  unsigned        nh_ref_by_stack:1;	/**< Has stack used the handle? */
  unsigned        nh_ref_by_user:1;	/**< Has user used the handle? */
  unsigned        nh_init:1;

  unsigned        nh_has_invite:1;     /**< Has call */
  unsigned        nh_has_subscribe:1;  /**< Has watcher */
  unsigned        nh_has_notify:1;     /**< Has notifier */
  unsigned        nh_has_register:1;   /**< Has registration */
  unsigned        nh_has_streaming:1;  /**< Has RTSP-related session */

  struct nua_client_request nh_cr[1];

  nua_dialog_state_t nh_ds[1];
  nua_session_state_t nh_ss[1];

  auth_client_t  *nh_auth;	/**< Authorization objects */

Pekka Pessi's avatar
Pekka Pessi committed
446
  soa_session_t  *nh_soa;	/**< Media session */
Pekka Pessi's avatar
Pekka Pessi committed
447 448

  struct nua_referral {
449
    nua_handle_t  *ref_handle;	/**< Referring handle */
Pekka Pessi's avatar
Pekka Pessi committed
450 451 452 453 454 455 456 457 458 459 460 461 462
    sip_event_t   *ref_event;	/**< Event used with NOTIFY */
  } nh_referral[1];

  nea_server_t   *nh_notifier;	/**< SIP notifier */
};

#define NH_IS_VALID(nh) ((nh) && (nh)->nh_valid)

#define NH_STATUS(nh) \
  (nh)->nh_status, \
  (nh)->nh_phrase, \
  SIPTAG_WARNING_STR(nh->nh_warning)

Pekka Pessi's avatar
Pekka Pessi committed
463 464 465
extern char const nua_500_error[];

#define NUA_500_ERROR 500, nua_500_error
Pekka Pessi's avatar
Pekka Pessi committed
466 467 468 469 470 471 472 473 474 475 476

struct nua_s {
  su_home_t            nua_home[1];

  /* API (client) side */
  su_root_t    	      *nua_api_root;
  su_clone_r   	       nua_clone;
  su_task_r            nua_client;
  nua_callback_f       nua_callback;
  nua_magic_t         *nua_magic;

Pekka Pessi's avatar
Pekka Pessi committed
477
  nua_saved_event_t    nua_current[1];
478
  nua_saved_event_t    nua_signal[1];
Pekka Pessi's avatar
Pekka Pessi committed
479

480 481 482 483 484
  /* Engine state flags */
  unsigned             nua_shutdown_started:1; /**< Shutdown initiated */
  unsigned             nua_shutdown_final:1; /**< Shutdown is complete */
  unsigned :0;
  
Pekka Pessi's avatar
Pekka Pessi committed
485 486 487 488
  /**< Used by stop-and-wait args calls */
  tagi_t const        *nua_args;
  tagi_t              *nua_filter;

489 490
  /**< Local SIP address. Contents are kept around for ever. */
  sip_from_t          nua_from[1];
Pekka Pessi's avatar
Pekka Pessi committed
491 492 493 494 495 496

  /* Protocol (server) side */
  sip_contact_t      *nua_contact;
  sip_contact_t      *nua_sips_contact;
  sip_content_type_t *nua_sdp_content;
  sip_accept_t       *nua_invite_accept; /* What we accept for invite */
497 498

  /* char const         *nua_ua_name; => nhp_ua_name */
Pekka Pessi's avatar
Pekka Pessi committed
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
  url_t        	     *nua_registrar;

  su_root_t          *nua_root;
  su_task_r           nua_server;
  nta_agent_t        *nua_nta;
  su_timer_t         *nua_timer;

#if HAVE_UICC_H
  uicc_t             *nua_uicc;
#endif

  void         	      *nua_sip_parser;

  sip_time_t           nua_shutdown;

  /* Route */
  sip_service_route_t *nua_service_route;

517
  /* User-agent parameters */
Pekka Pessi's avatar
Pekka Pessi committed
518 519 520 521 522 523 524 525 526 527 528 529
  unsigned             nua_media_enable:1;

  unsigned     	       :0;

#if HAVE_SMIME		/* Start NRC Boston */
  sm_object_t          *sm;
#endif                  /* End NRC Boston */

  nua_handle_t        *nua_handles;
  nua_handle_t       **nua_handles_tail;
};

530
#define nua_dhandle    nua_handles
Pekka Pessi's avatar
Pekka Pessi committed
531 532 533 534 535 536 537

#if HAVE_FUNC
#define enter (void)SU_DEBUG_9(("nua: %s: entering\n", __func__))
#define nh_enter (void)SU_DEBUG_9(("nua %s(%p): entering\n", __func__, nh))
#elif HAVE_FUNCTION
#define enter (void)SU_DEBUG_9(("nua: %s: entering\n", __FUNCTION__))
#define nh_enter (void)SU_DEBUG_9(("nua %s(%p): entering\n", __FUNCTION__, nh))
Pekka Pessi's avatar
Pekka Pessi committed
538
#define __func__ __FUNCTION__
Pekka Pessi's avatar
Pekka Pessi committed
539 540 541
#else
#define enter ((void)0)
#define nh_enter ((void)0)
Pekka Pessi's avatar
Pekka Pessi committed
542
#define __func__ "nua"
Pekka Pessi's avatar
Pekka Pessi committed
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
#endif

/*# Increase reference count by one.
 *
 * Reference conting works pretty simple. Currently, application can have a
 * single reference to a handle, stack can keep multiple references. When
 * application creates a handle, it gets a reference to it. When such a
 * handle is sent to stack, stack checks the nh_ref_by_stack and makes sure
 * that it has a reference. Likewise, when stack creates a handle, and it is
 * sent to application, the application side of nua checks nh_ref_by_appl
 * and increases the reference count if needed.
 *
 * When application calls nua_handle_destroy(), it marks the handle as
 * invalid, sends a nua_r_destroy signal to stack and decreases its
 * reference count.
 * 
 */
static inline
nua_handle_t *nh_incref(nua_handle_t *nh)
{
  nh_enter;

  if (nh) {
#if HAVE_PTHREAD_H
    pthread_rwlock_rdlock(nh->nh_refcount);
#else 
    nh->nh_refcount++;		/* XXX */
#endif
  }
  return nh;
}

/*# Decrease reference count by one, return false if no more references  */
static inline
int nh_decref(nua_handle_t *nh)
{
  nh_enter;

  if (nh == NULL) 
    return 1;

#if HAVE_PTHREAD_H
  pthread_rwlock_unlock(nh->nh_refcount);
  if (pthread_rwlock_trywrlock(nh->nh_refcount) == 0) {
    SU_DEBUG_9(("nua(%p): zapped\n", nh));
    su_home_zap(nh->nh_home);
    return 0;
  }
  return 1;
#else 
  if (--nh->nh_refcount == 0) {
    SU_DEBUG_9(("nua(%p): zapped\n", nh));
    su_home_zap(nh->nh_home);
  }
  return 1;
#endif  
}


/* Internal prototypes */
int  ua_init(su_root_t *root, nua_t *nua);
void ua_deinit(su_root_t *root, nua_t *nua);
void ua_signal(nua_t *nua, su_msg_r msg, event_t *e);
int ua_event(nua_t *nua, nua_handle_t *nh, msg_t *msg,
	     nua_event_t event, int status, char const *phrase,
	     tag_type_t tag, tag_value_t value, ...);

nua_handle_t *nh_create_handle(nua_t *nua, nua_hmagic_t *hmagic,
			       tagi_t *tags);

/* Private prototypes (XXX: move to nua_priv.h; nua.c interface) */
void nua_signal(nua_t *nua, nua_handle_t *nh, msg_t *msg, int always,
		nua_event_t event, int status, char const *phrase,
		tag_type_t tag, tag_value_t value, ...);

/*  (XXX: move to nua_priv.h; nua.c interface) */
void nua_event(nua_t *root_magic, su_msg_r sumsg, event_t *e);

#define SIP_METHOD_UNKNOWN sip_method_unknown, NULL

#define UA_INTERVAL 5

#endif /* NUA_STACK_H */