nua_stack.h 12.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
/*
 * 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
 *
 */

25 26
#ifndef NUA_STACK_H
/** Defined when <nua_stack.h> has been included. */
27
#define NUA_STACK_H
Pekka Pessi's avatar
Pekka Pessi committed
28
/**@IFILE nua_stack.h 
29
 * @brief Sofia-SIP User Agent Engine - internal stack interface
Pekka Pessi's avatar
Pekka Pessi committed
30 31 32 33 34 35 36
 *
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>
 * @author Kai Vehmanen <Kai.Vehmanen@nokia.com>
 *
 * @date Created: Wed Feb 14 17:09:44 2001 ppessi
 */

37 38 39 40
#ifndef SU_CONFIG_H
#include <su_config.h>
#endif

41 42 43
#ifndef SU_OS_NW_H
#include <sofia-sip/su_os_nw.h>
#endif
44
#ifndef SOA_H
45
#include "sofia-sip/soa.h"
46 47
#endif
#ifndef NTA_H
48
#include <sofia-sip/nta.h>
49 50
#endif
#ifndef AUTH_CLIENT_H
51
#include <sofia-sip/auth_client.h>
52 53
#endif
#ifndef NEA_H
54
#include <sofia-sip/nea.h>
55 56
#endif
#ifndef NUA_H
57
#include <sofia-sip/nua.h>
Pekka Pessi's avatar
Pekka Pessi committed
58 59
#endif

60
#define SU_LOG (nua_log)
61
#include <sofia-sip/su_debug.h>
Pekka Pessi's avatar
Pekka Pessi committed
62

63 64 65 66 67
#ifndef NUA_DIALOG_H
#define NUA_OWNER_T struct nua_handle_s
#include <nua_dialog.h>
#endif

68 69 70 71 72
SOFIA_BEGIN_DECLS

#if HAVE_SIGCOMP
#include <sigcomp.h>
#endif
Martti Mela's avatar
Martti Mela committed
73

74 75 76 77
#ifndef NUA_PARAMS_H
#include <nua_params.h>
#endif

Pekka Pessi's avatar
Pekka Pessi committed
78 79 80 81
typedef struct event_s event_t;

#define       NONE ((void *)-1)

82
typedef struct register_usage nua_registration_t;
83

Pekka Pessi's avatar
Pekka Pessi committed
84 85 86
#define \
  NH_ACTIVE_MEDIA_TAGS(include, soa)					\
  TAG_IF((include) && (soa) && soa_is_audio_active(soa) >= 0,		\
Pekka Pessi's avatar
Pekka Pessi committed
87
	 SOATAG_ACTIVE_AUDIO(soa_is_audio_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
88
  TAG_IF((include) && (soa) && soa_is_video_active(soa) >= 0,		\
Pekka Pessi's avatar
Pekka Pessi committed
89
	 SOATAG_ACTIVE_VIDEO(soa_is_video_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
90
  TAG_IF((include) && (soa) && soa_is_image_active(soa) >= 0,		\
Pekka Pessi's avatar
Pekka Pessi committed
91
	 SOATAG_ACTIVE_IMAGE(soa_is_image_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
92
  TAG_IF((include) && (soa) && soa_is_chat_active(soa) >= 0,		\
Pekka Pessi's avatar
Pekka Pessi committed
93
	 SOATAG_ACTIVE_CHAT(soa_is_chat_active(soa)))
Pekka Pessi's avatar
Pekka Pessi committed
94 95 96 97

#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
98
	 SOATAG_ACTIVE_AUDIO(soa_is_remote_audio_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
99
  TAG_IF((include) && (soa) && soa_is_remote_video_active(soa) >= 0,	\
Pekka Pessi's avatar
Pekka Pessi committed
100
	 SOATAG_ACTIVE_VIDEO(soa_is_remote_video_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
101
  TAG_IF((include) && (soa) && soa_is_remote_image_active(soa) >= 0,	\
Pekka Pessi's avatar
Pekka Pessi committed
102
	 SOATAG_ACTIVE_IMAGE(soa_is_remote_image_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
103
  TAG_IF((include) && (soa) && soa_is_remote_chat_active(soa) >= 0,	\
Pekka Pessi's avatar
Pekka Pessi committed
104
	 SOATAG_ACTIVE_CHAT(soa_is_remote_chat_active(soa)))
Pekka Pessi's avatar
Pekka Pessi committed
105

Pekka Pessi's avatar
Pekka Pessi committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
#if HAVE_NUA_HANDLE_DEBUG

#define nua_handle_ref(nh) nua_handle_ref_by((nh), __func__)
#define nua_handle_unref(nh) nua_handle_unref_by((nh), __func__)

static inline nua_handle_t *nua_handle_ref_by(nua_handle_t *nh,
					      char const *by)
{
  SU_DEBUG_0(("nua_handle_ref(%p) by %s\n", nh, by));
  return (nua_handle_t *)su_home_ref((su_home_t *)nh);
}

static inline int nua_handle_unref_by(nua_handle_t *nh, char const *by)
{
  SU_DEBUG_0(("nua_handle_unref(%p) by %s\n", nh, by));
  return su_home_unref((su_home_t *)nh);
}

#endif

Pekka Pessi's avatar
Pekka Pessi committed
126 127 128 129 130 131 132 133 134 135 136 137 138
/** 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 */

139 140
  tagi_t         *nh_tags;	/**< Initial tags */
  tagi_t         *nh_ptags;	/**< Initial parameters */
Pekka Pessi's avatar
Pekka Pessi committed
141

142 143
  nua_handle_t   *nh_identity;	/**< Identity */

144 145
  nua_handle_preferences_t *nh_prefs; /**< Preferences */

146
  /* Handle type is determined by special event and flags. */
147
  nua_event_t     nh_special;	/**< Special event */
Pekka Pessi's avatar
Pekka Pessi committed
148 149 150 151
  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 */
152 153 154 155

  /* Call status */
  unsigned        nh_active_call:1;
  unsigned        nh_hold_remote:1;
Pekka Pessi's avatar
Pekka Pessi committed
156

157 158 159 160
  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;	        /**< Handle has been initialized */
  unsigned        nh_used_ptags:1;	/**< Ptags has been used */
161
  unsigned :0;
162

Pekka Pessi's avatar
Pekka Pessi committed
163 164 165 166
  nua_dialog_state_t nh_ds[1];

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

Pekka Pessi's avatar
Pekka Pessi committed
167
  soa_session_t  *nh_soa;	/**< Media session */
Pekka Pessi's avatar
Pekka Pessi committed
168 169

  struct nua_referral {
170
    nua_handle_t  *ref_handle;	/**< Referring handle */
Pekka Pessi's avatar
Pekka Pessi committed
171 172 173 174 175 176 177 178 179 180 181 182 183
    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)

184 185
#define NH_IS_DEFAULT(nh) ((nh) == (nh)->nh_nua->nua_handles)

186 187 188 189 190 191
static inline
int nh_is_special(nua_handle_t *nh)
{
  return nh == NULL || nh->nh_special;
}

192
extern char const nua_internal_error[];
Pekka Pessi's avatar
Pekka Pessi committed
193

194
#define NUA_INTERNAL_ERROR 900, nua_internal_error
Pekka Pessi's avatar
Pekka Pessi committed
195 196 197 198 199 200 201 202

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;
203 204 205

  su_network_changed_t *nua_nw_changed;

Pekka Pessi's avatar
Pekka Pessi committed
206 207 208
  nua_callback_f       nua_callback;
  nua_magic_t         *nua_magic;

Pekka Pessi's avatar
Pekka Pessi committed
209
  nua_saved_event_t    nua_current[1];
210
  nua_saved_event_t    nua_signal[1];
Pekka Pessi's avatar
Pekka Pessi committed
211

212 213 214 215 216
  /* 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
217 218 219
  /**< Used by stop-and-wait args calls */
  tagi_t const        *nua_args;

220 221
  /**< Local SIP address. Contents are kept around for ever. */
  sip_from_t          nua_from[1];
Pekka Pessi's avatar
Pekka Pessi committed
222 223

  /* Protocol (server) side */
224 225 226

  nua_registration_t *nua_registrations; /**< Active registrations */

227
  /* Constants */
Pekka Pessi's avatar
Pekka Pessi committed
228
  sip_accept_t       *nua_invite_accept; /* What we accept for invite */
229

Pekka Pessi's avatar
Pekka Pessi committed
230 231 232 233 234 235 236 237 238 239 240 241
  su_root_t          *nua_root;
  su_task_r           nua_server;
  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;

242
  /* User-agent parameters */
Pekka Pessi's avatar
Pekka Pessi committed
243 244 245 246 247 248 249 250 251 252 253 254
  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;
};

255
#define nua_dhandle    nua_handles
Pekka Pessi's avatar
Pekka Pessi committed
256 257 258 259 260 261 262

#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
263
#define __func__ __FUNCTION__
Pekka Pessi's avatar
Pekka Pessi committed
264 265 266
#else
#define enter ((void)0)
#define nh_enter ((void)0)
Pekka Pessi's avatar
Pekka Pessi committed
267
#define __func__ "nua"
Pekka Pessi's avatar
Pekka Pessi committed
268 269 270
#endif

/* Internal prototypes */
271 272 273 274
int  nua_stack_init(su_root_t *root, nua_t *nua);
void nua_stack_deinit(su_root_t *root, nua_t *nua);
void nua_stack_signal(nua_t *nua, su_msg_r msg, event_t *e);

Pekka Pessi's avatar
Pekka Pessi committed
275 276 277
int nua_stack_init_transport(nua_t *nua, tagi_t const *tags);

int nua_stack_init_registrations(nua_t *nua);
278

279 280 281 282
nua_registration_t *nua_registration_by_aor(nua_registration_t const *list,
					    sip_from_t const *aor,
					    url_t const *remote_uri,
					    int only_default);
283

284 285 286
sip_contact_t const *nua_registration_contact(nua_registration_t const *nr);

int nua_registration_process_request(nua_registration_t *nr,
287 288
				     nta_incoming_t *irq,
				     sip_t const *sip);
289

290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
void nua_stack_post_signal(nua_handle_t *nh, nua_event_t event, 
			   tag_type_t tag, tag_value_t value, ...);

typedef int nua_stack_signal_handler(nua_t *, 
				     nua_handle_t *, 
				     nua_event_t, 
				     tagi_t const *);

nua_stack_signal_handler 
  nua_stack_set_params, nua_stack_get_params,
  nua_stack_register, 
  nua_stack_invite, nua_stack_ack, nua_stack_cancel, 
  nua_stack_bye, nua_stack_info, nua_stack_update, 
  nua_stack_options, nua_stack_publish, nua_stack_message, 
  nua_stack_subscribe, nua_stack_notify, nua_stack_refer,
  nua_stack_method;

#define UA_EVENT1(e, statusphrase) \
308
  nua_stack_event(nua, nh, NULL, e, statusphrase, NULL)
309 310

#define UA_EVENT2(e, status, phrase)			\
311
  nua_stack_event(nua, nh, NULL, e, status, phrase, NULL)
312 313

#define UA_EVENT3(e, status, phrase, tag)			\
314 315 316 317 318
  nua_stack_event(nua, nh, NULL, e, status, phrase, tag, NULL)

int nua_stack_tevent(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, ...);
319 320 321

int nua_stack_event(nua_t *nua, nua_handle_t *nh, msg_t *msg,
		    nua_event_t event, int status, char const *phrase,
322
		    tagi_t const *tags);
Pekka Pessi's avatar
Pekka Pessi committed
323

324
nua_handle_t *nh_create_handle(nua_t *nua, nua_hmagic_t *hmagic, tagi_t *tags);
Pekka Pessi's avatar
Pekka Pessi committed
325

326
nua_handle_t *nua_stack_incoming_handle(nua_t *nua,
327 328 329 330
					nta_incoming_t *irq,
					sip_t const *sip,
					int create_dialog);

331 332
enum { create_dialog = 1 };

333 334 335
int nua_stack_init_handle(nua_t *nua, nua_handle_t *nh, 
			  tag_type_t tag, tag_value_t value, ...);

336 337 338 339 340 341 342 343 344
enum nh_kind {
  nh_has_nothing,
  nh_has_invite,
  nh_has_subscribe,
  nh_has_notify,
  nh_has_register,
  nh_has_streaming
};

345 346 347 348
int nua_stack_set_handle_special(nua_handle_t *nh,
				 enum nh_kind kind,
				 nua_event_t special);

349 350
int nua_handle_save_tags(nua_handle_t *h, tagi_t *tags);

351 352 353 354
void nh_destroy(nua_t *nua, nua_handle_t *nh);

nua_handle_t *nh_validate(nua_t *nua, nua_handle_t *maybe);

355 356 357 358 359 360 361 362 363
sip_replaces_t *nua_stack_handle_make_replaces(nua_handle_t *handle, 
					       su_home_t *home,
					       int early_only);

nua_handle_t *nua_stack_handle_by_replaces(nua_t *nua,
					   sip_replaces_t const *r);

/* ---------------------------------------------------------------------- */

364 365
int nua_stack_set_defaults(nua_handle_t *nh, nua_handle_preferences_t *nhp);

Pekka Pessi's avatar
Pekka Pessi committed
366
int nua_stack_set_from(nua_t *, int initial, tagi_t const *tags);
367 368 369

int nua_stack_init_instance(nua_handle_t *nh, tagi_t const *tags);

370 371 372 373 374
int nua_stack_process_request(nua_handle_t *nh,
			      nta_leg_t *leg,
			      nta_incoming_t *irq,
			      sip_t const *sip);

375 376
int nua_stack_launch_network_change_detector(nua_t *nua);

377
sip_contact_t const *nua_stack_get_contact(nua_registration_t const *nr);
378

379 380 381 382 383 384 385 386 387 388 389
int nua_registration_add_contact_to_request(nua_handle_t *nh,
					    msg_t *msg, 
					    sip_t *sip,
					    int add_contact,
					    int add_service_route);

int nua_registration_add_contact_to_response(nua_handle_t *nh,
					     msg_t *msg,
					     sip_t *sip,
					     sip_record_route_t const *,
					     sip_contact_t const *remote);
390

391 392
/* ---------------------------------------------------------------------- */

393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
#ifndef SDP_MIME_TYPE
#define SDP_MIME_TYPE nua_application_sdp
#endif

extern char const nua_application_sdp[];

/* ---------------------------------------------------------------------- */

#define SIP_METHOD_UNKNOWN sip_method_unknown, NULL

/* Private tags */
#define NUTAG_ADD_CONTACT(v) _nutag_add_contact, tag_bool_v(v)
extern tag_typedef_t _nutag_add_contact;

/* ---------------------------------------------------------------------- */

typedef unsigned longlong ull;

#define SET_STATUS(_status, _phrase) status = _status, phrase = _phrase

413 414
#define SET_STATUS2(_status, _phrase) status = _status, phrase = _phrase

415 416 417 418 419 420 421 422 423 424 425
/* This is an "interesting" macro:
 * x is a define expanding to <i>num, str</i>.
 * @a num is assigned to variable status, @a str to variable phrase.
 * Macro SET_STATUS1 expands to two comma-separated expressions that are
 * also usable as function arguments.
 */
#define SET_STATUS1(x) ((status = x), status), (phrase = ((void)x))

/* ---------------------------------------------------------------------- */
/* Application side prototypes */

Pekka Pessi's avatar
Pekka Pessi committed
426 427 428 429 430 431
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, ...);

void nua_event(nua_t *root_magic, su_msg_r sumsg, event_t *e);

432 433
SOFIA_END_DECLS

Pekka Pessi's avatar
Pekka Pessi committed
434
#endif /* NUA_STACK_H */