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

119 120
  tagi_t         *nh_tags;	/**< Initial tags */
  tagi_t         *nh_ptags;	/**< Initial parameters */
Pekka Pessi's avatar
Pekka Pessi committed
121

122 123
  nua_handle_t   *nh_identity;	/**< Identity */

124 125
  nua_handle_preferences_t *nh_prefs; /**< Preferences */

126
  /* Handle type is determined by special event and flags. */
127
  nua_event_t     nh_special;	/**< Special event */
Pekka Pessi's avatar
Pekka Pessi committed
128 129 130 131
  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 */
132 133 134 135

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

137 138 139 140
  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 */
141
  unsigned :0;
142

Pekka Pessi's avatar
Pekka Pessi committed
143 144 145 146
  nua_dialog_state_t nh_ds[1];

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

Pekka Pessi's avatar
Pekka Pessi committed
147
  soa_session_t  *nh_soa;	/**< Media session */
Pekka Pessi's avatar
Pekka Pessi committed
148 149

  struct nua_referral {
150
    nua_handle_t  *ref_handle;	/**< Referring handle */
Pekka Pessi's avatar
Pekka Pessi committed
151 152 153 154 155 156 157 158 159 160 161 162 163
    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)

164 165
#define NH_IS_DEFAULT(nh) ((nh) == (nh)->nh_nua->nua_handles)

166 167 168 169 170 171
static inline
int nh_is_special(nua_handle_t *nh)
{
  return nh == NULL || nh->nh_special;
}

172
extern char const nua_internal_error[];
Pekka Pessi's avatar
Pekka Pessi committed
173

174
#define NUA_INTERNAL_ERROR 900, nua_internal_error
Pekka Pessi's avatar
Pekka Pessi committed
175 176 177 178 179 180 181 182

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;
183 184 185

  su_network_changed_t *nua_nw_changed;

Pekka Pessi's avatar
Pekka Pessi committed
186 187 188
  nua_callback_f       nua_callback;
  nua_magic_t         *nua_magic;

Pekka Pessi's avatar
Pekka Pessi committed
189
  nua_saved_event_t    nua_current[1];
190
  nua_saved_event_t    nua_signal[1];
Pekka Pessi's avatar
Pekka Pessi committed
191

192 193 194 195 196
  /* 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
197 198 199
  /**< Used by stop-and-wait args calls */
  tagi_t const        *nua_args;

200 201
  /**< Local SIP address. Contents are kept around for ever. */
  sip_from_t          nua_from[1];
Pekka Pessi's avatar
Pekka Pessi committed
202 203

  /* Protocol (server) side */
204 205 206

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

207
  /* Constants */
Pekka Pessi's avatar
Pekka Pessi committed
208
  sip_accept_t       *nua_invite_accept; /* What we accept for invite */
209

Pekka Pessi's avatar
Pekka Pessi committed
210 211 212 213 214 215 216 217 218 219 220 221
  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;

222
  /* User-agent parameters */
Pekka Pessi's avatar
Pekka Pessi committed
223 224 225 226 227 228 229 230 231 232 233 234
  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;
};

235
#define nua_dhandle    nua_handles
Pekka Pessi's avatar
Pekka Pessi committed
236 237 238 239 240 241 242

#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
243
#define __func__ __FUNCTION__
Pekka Pessi's avatar
Pekka Pessi committed
244 245 246
#else
#define enter ((void)0)
#define nh_enter ((void)0)
Pekka Pessi's avatar
Pekka Pessi committed
247
#define __func__ "nua"
Pekka Pessi's avatar
Pekka Pessi committed
248 249 250
#endif

/* Internal prototypes */
251 252 253 254
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
255 256 257
int nua_stack_init_transport(nua_t *nua, tagi_t const *tags);

int nua_stack_init_registrations(nua_t *nua);
258

259 260 261 262
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);
263

264 265 266
sip_contact_t const *nua_registration_contact(nua_registration_t const *nr);

int nua_registration_process_request(nua_registration_t *nr,
267 268
				     nta_incoming_t *irq,
				     sip_t const *sip);
269

270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
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) \
  nua_stack_event(nua, nh, NULL, e, statusphrase, TAG_END())

#define UA_EVENT2(e, status, phrase)			\
  nua_stack_event(nua, nh, NULL, e, status, phrase, TAG_END())

#define UA_EVENT3(e, status, phrase, tag)			\
  nua_stack_event(nua, nh, NULL, e, status, phrase, tag, TAG_END())

int nua_stack_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, ...);
Pekka Pessi's avatar
Pekka Pessi committed
299 300 301 302

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

303
nua_handle_t *nua_stack_incoming_handle(nua_t *nua,
304 305 306 307
					nta_incoming_t *irq,
					sip_t const *sip,
					int create_dialog);

308 309
enum { create_dialog = 1 };

310 311 312
int nua_stack_init_handle(nua_t *nua, nua_handle_t *nh, 
			  tag_type_t tag, tag_value_t value, ...);

313 314 315 316 317 318 319 320 321
enum nh_kind {
  nh_has_nothing,
  nh_has_invite,
  nh_has_subscribe,
  nh_has_notify,
  nh_has_register,
  nh_has_streaming
};

322 323 324 325
int nua_stack_set_handle_special(nua_handle_t *nh,
				 enum nh_kind kind,
				 nua_event_t special);

326 327
int nua_handle_save_tags(nua_handle_t *h, tagi_t *tags);

328 329 330 331
void nh_destroy(nua_t *nua, nua_handle_t *nh);

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

332 333 334 335 336 337 338 339 340
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);

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

341 342
int nua_stack_set_defaults(nua_handle_t *nh, nua_handle_preferences_t *nhp);

Pekka Pessi's avatar
Pekka Pessi committed
343
int nua_stack_set_from(nua_t *, int initial, tagi_t const *tags);
344 345 346

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

347 348 349 350 351 352
int nua_stack_process_request(nua_handle_t *nh,
			      nta_leg_t *leg,
			      nta_incoming_t *irq,
			      sip_t const *sip);

int nua_stack_process_response(nua_handle_t *nh,
353
			       nua_client_request_t *cr,
354 355 356 357
			       nta_outgoing_t *orq,
			       sip_t const *sip,
			       tag_type_t tag, tag_value_t value, ...);

358 359
int nua_stack_launch_network_change_detector(nua_t *nua);

360
msg_t *nua_creq_msg(nua_t *nua, nua_handle_t *nh,
361
		    nua_client_request_t *cr,
362 363 364 365
		    int restart, 
		    sip_method_t method, char const *name,
		    tag_type_t tag, tag_value_t value, ...);

366 367
int nua_tagis_have_contact_tag(tagi_t const *t);

368
int nua_creq_check_restart(nua_handle_t *nh,
369
			   nua_client_request_t *cr,
370 371 372 373
			   nta_outgoing_t *orq,
			   sip_t const *sip,
			   nua_creq_restart_f *f);

374
int nua_creq_restart_with(nua_handle_t *nh,
375
			  nua_client_request_t *cr,
376 377 378 379 380
			  nta_outgoing_t *orq,
			  int status, char const *phrase,
			  nua_creq_restart_f *f, 
			  tag_type_t tag, tag_value_t value, ...);

381
int nua_creq_save_restart(nua_handle_t *nh,
382
			  nua_client_request_t *cr,
383 384 385 386
			  nta_outgoing_t *orq,
			  int status, char const *phrase,
			  nua_creq_restart_f *f);

387
int nua_creq_restart(nua_handle_t *nh,
388
		     nua_client_request_t *cr,
389 390 391
		     nta_response_f *cb,
		     tagi_t *tags);

392
void nua_creq_deinit(nua_client_request_t *cr, nta_outgoing_t *orq);
393

394
sip_contact_t const *nua_stack_get_contact(nua_registration_t const *nr);
395

396 397 398 399 400 401 402 403 404 405 406
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);
407

408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
msg_t *nh_make_response(nua_t *nua, nua_handle_t *nh, 
			nta_incoming_t *irq,
			int status, char const *phrase,
			tag_type_t tag, tag_value_t value, ...);


typedef int nua_stack_process_request_t(nua_t *nua,
					nua_handle_t *nh,
					nta_incoming_t *irq,
					sip_t const *sip);

nua_stack_process_request_t nua_stack_process_invite;
nua_stack_process_request_t nua_stack_process_info;
nua_stack_process_request_t nua_stack_process_update;
nua_stack_process_request_t nua_stack_process_bye;
nua_stack_process_request_t nua_stack_process_message;
nua_stack_process_request_t nua_stack_process_options;
nua_stack_process_request_t nua_stack_process_publish;
426
nua_stack_process_request_t nua_stack_process_subscribe;
427 428 429
nua_stack_process_request_t nua_stack_process_notify;
nua_stack_process_request_t nua_stack_process_refer;
nua_stack_process_request_t nua_stack_process_unknown;
Michael Jerris's avatar
Michael Jerris committed
430
nua_stack_process_request_t nua_stack_process_register;
431
nua_stack_process_request_t nua_stack_process_method;
432

433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
nua_client_request_t
  *nua_client_request_pending(nua_client_request_t const *),
  *nua_client_request_restarting(nua_client_request_t const *),
  *nua_client_request_by_orq(nua_client_request_t const *cr,
			     nta_outgoing_t const *orq);

nua_server_request_t *nua_server_request(nua_t *nua,
					 nua_handle_t *nh,
					 nta_incoming_t *irq,
					 sip_t const *sip,
					 nua_server_request_t *sr,
					 size_t size,
					 nua_server_respond_f *respond,
					 int create_dialog);

int nua_stack_server_event(nua_t *nua,
449 450
			   nua_server_request_t *sr,
			   nua_event_t event,
451 452 453 454
			   tag_type_t tag, tag_value_t value, ...);

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

455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
#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;

#define NUTAG_ADD_CONTACT_REF(v) _nutag_add_contact_ref, tag_bool_vr(&v)
extern tag_typedef_t _nutag_add_contact_ref;

#define NUTAG_COPY(v) _nutag_copy, tag_bool_v(v)
extern tag_typedef_t _nutag_copy;

#define NUTAG_COPY_REF(v) _nutag_copy_ref, tag_bool_vr(&v)
extern tag_typedef_t _nutag_copy_ref;

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

typedef unsigned longlong ull;

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

484 485
#define SET_STATUS2(_status, _phrase) status = _status, phrase = _phrase

486 487 488 489 490 491 492 493 494 495 496
/* 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
497 498 499 500 501 502
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);

503 504
SOFIA_END_DECLS

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