nua_stack.h 13 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
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
#ifndef NUA_DIALOG_H
#define NUA_OWNER_T struct nua_handle_s
65
#include "nua_dialog.h"
66 67
#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
#ifndef NUA_PARAMS_H
75
#include "nua_params.h"
76 77
#endif

78
typedef struct event_s event_t, nua_signal_data_t;
Pekka Pessi's avatar
Pekka Pessi committed
79

Pekka Pessi's avatar
Pekka Pessi committed
80
/** @internal Extended event data. */
81 82 83 84 85
typedef struct nua_ee_data {
  nua_t *ee_nua;
  nua_event_data_t ee_data[1];
} nua_ee_data_t;

86
#define NONE ((void *)(intptr_t)-1)
Pekka Pessi's avatar
Pekka Pessi committed
87

88
typedef struct register_usage nua_registration_t;
89

Pekka Pessi's avatar
Pekka Pessi committed
90 91 92
#define \
  NH_ACTIVE_MEDIA_TAGS(include, soa)					\
  TAG_IF((include) && (soa) && soa_is_audio_active(soa) >= 0,		\
Pekka Pessi's avatar
Pekka Pessi committed
93
	 SOATAG_ACTIVE_AUDIO(soa_is_audio_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
94
  TAG_IF((include) && (soa) && soa_is_video_active(soa) >= 0,		\
Pekka Pessi's avatar
Pekka Pessi committed
95
	 SOATAG_ACTIVE_VIDEO(soa_is_video_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
96
  TAG_IF((include) && (soa) && soa_is_image_active(soa) >= 0,		\
Pekka Pessi's avatar
Pekka Pessi committed
97
	 SOATAG_ACTIVE_IMAGE(soa_is_image_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
98
  TAG_IF((include) && (soa) && soa_is_chat_active(soa) >= 0,		\
Pekka Pessi's avatar
Pekka Pessi committed
99
	 SOATAG_ACTIVE_CHAT(soa_is_chat_active(soa)))
Pekka Pessi's avatar
Pekka Pessi committed
100 101 102 103

#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
104
	 SOATAG_ACTIVE_AUDIO(soa_is_remote_audio_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
105
  TAG_IF((include) && (soa) && soa_is_remote_video_active(soa) >= 0,	\
Pekka Pessi's avatar
Pekka Pessi committed
106
	 SOATAG_ACTIVE_VIDEO(soa_is_remote_video_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
107
  TAG_IF((include) && (soa) && soa_is_remote_image_active(soa) >= 0,	\
Pekka Pessi's avatar
Pekka Pessi committed
108
	 SOATAG_ACTIVE_IMAGE(soa_is_remote_image_active(soa))),		\
Pekka Pessi's avatar
Pekka Pessi committed
109
  TAG_IF((include) && (soa) && soa_is_remote_chat_active(soa) >= 0,	\
Pekka Pessi's avatar
Pekka Pessi committed
110
	 SOATAG_ACTIVE_CHAT(soa_is_remote_chat_active(soa)))
Pekka Pessi's avatar
Pekka Pessi committed
111

112
/** @internal @brief NUA handle.
Pekka Pessi's avatar
Pekka Pessi committed
113 114
 *
 */
115
struct nua_handle_s
Pekka Pessi's avatar
Pekka Pessi committed
116 117 118 119 120 121
{
  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  */
122 123
  void           *nh_valid;	/**< Cookie */
#define nua_valid_handle_cookie ((void *)(intptr_t)nua_handle)
Pekka Pessi's avatar
Pekka Pessi committed
124 125
  nua_hmagic_t 	 *nh_magic;	/**< Application context */

126 127
  tagi_t         *nh_tags;	/**< Initial tags */
  tagi_t         *nh_ptags;	/**< Initial parameters */
Pekka Pessi's avatar
Pekka Pessi committed
128

129 130
  nua_handle_t   *nh_identity;	/**< Identity */

131
  nua_handle_preferences_t *nh_prefs; /**< Preferences */
132
#define nh_dprefs nh_nua->nua_dhandle->nh_prefs
133

134
  /* Handle type is determined by special event and flags. */
135
  nua_event_t     nh_special;	/**< Special event */
Pekka Pessi's avatar
Pekka Pessi committed
136 137 138 139
  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 */
140 141 142 143

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

145 146 147 148
  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 */
149
  unsigned :0;
150

Pekka Pessi's avatar
Pekka Pessi committed
151 152 153 154
  nua_dialog_state_t nh_ds[1];

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

Pekka Pessi's avatar
Pekka Pessi committed
155
  soa_session_t  *nh_soa;	/**< Media session */
Pekka Pessi's avatar
Pekka Pessi committed
156 157

  struct nua_referral {
158
    nua_handle_t  *ref_handle;	/**< Referring handle */
Pekka Pessi's avatar
Pekka Pessi committed
159 160 161 162 163 164
    sip_event_t   *ref_event;	/**< Event used with NOTIFY */
  } nh_referral[1];

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

165 166
#define NH_IS_VALID(nh) \
  ((nh) && (nh)->nh_valid == nua_valid_handle_cookie)
Pekka Pessi's avatar
Pekka Pessi committed
167 168 169 170 171 172

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

173 174
#define NH_IS_DEFAULT(nh) ((nh) == (nh)->nh_nua->nua_handles)

175
su_inline
176 177 178 179 180
int nh_is_special(nua_handle_t *nh)
{
  return nh == NULL || nh->nh_special;
}

181 182
typedef struct nua_event_frame_s nua_event_frame_t;

183
extern char const nua_internal_error[];
Pekka Pessi's avatar
Pekka Pessi committed
184

185
#define NUA_INTERNAL_ERROR 900, nua_internal_error
186 187
#define _NUA_INTERNAL_ERROR_AT(file, line) "Internal error at " file ":" #line
#define NUA_ERROR_AT(file, line) 900, _NUA_INTERNAL_ERROR_AT(file, line)
Pekka Pessi's avatar
Pekka Pessi committed
188 189 190 191 192 193 194 195

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;
196

Pekka Pessi's avatar
Pekka Pessi committed
197 198 199
  nua_callback_f       nua_callback;
  nua_magic_t         *nua_magic;

200
  nua_event_frame_t   *nua_current;
201
  nua_saved_event_t    nua_signal[1];
202

203 204 205
  /**< Used by stop-and-wait args calls */
  tagi_t const        *nua_args;

206
  /* Engine state flags */
207 208
  sip_time_t           nua_shutdown;

209 210
  unsigned             nua_shutdown_started:1; /**< Shutdown initiated */
  unsigned             nua_shutdown_final:1; /**< Shutdown is complete */
211 212

  unsigned             nua_from_is_set;
213
  unsigned :0;
214

215
  /**< Local SIP address. Contents are kept around for ever. */
216 217 218
  sip_from_t           nua_from[1];

  /* ---------------------------------------------------------------------- */
Pekka Pessi's avatar
Pekka Pessi committed
219 220

  /* Protocol (server) side */
221
  su_network_changed_t *nua_nw_changed;
222 223 224

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

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

Pekka Pessi's avatar
Pekka Pessi committed
228 229 230
  su_root_t          *nua_root;
  su_task_r           nua_server;
  nta_agent_t        *nua_nta;
231
  su_timer_t         *nua_timer;
Pekka Pessi's avatar
Pekka Pessi committed
232

233
  /* User-agent parameters */
234
  nua_global_preferences_t nua_prefs[1];
Pekka Pessi's avatar
Pekka Pessi committed
235 236 237 238 239

  nua_handle_t        *nua_handles;
  nua_handle_t       **nua_handles_tail;
};

240
#define nua_dhandle    nua_handles
Pekka Pessi's avatar
Pekka Pessi committed
241 242 243 244 245 246 247

#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
248
#define __func__ __FUNCTION__
Pekka Pessi's avatar
Pekka Pessi committed
249 250 251
#else
#define enter ((void)0)
#define nh_enter ((void)0)
Pekka Pessi's avatar
Pekka Pessi committed
252
#define __func__ "nua"
Pekka Pessi's avatar
Pekka Pessi committed
253 254
#endif

255 256 257 258 259 260 261 262 263 264 265 266 267 268
#if HAVE_MEMLEAK_LOG

#define nua_handle_ref(nh) \
  _nua_handle_ref_by((nh), __FILE__, __LINE__, __func__)
#define nua_handle_unref(nh) \
  _nua_handle_unref_by((nh), __FILE__, __LINE__, __func__)

nua_handle_t *_nua_handle_ref_by(
  nua_handle_t *nh, char const *file, unsigned line, char const *by);
int _nua_handle_unref_by(
  nua_handle_t *nh, char const *file, unsigned line, char const *by);

#endif

269
su_inline nua_t *nua_stack_ref(nua_t *nua)
270
{
271 272 273 274
  return (nua_t *)su_home_ref(nua->nua_home);
}

su_inline void nua_stack_unref(nua_t *nua)
275
{
276 277 278
  su_home_unref(nua->nua_home);
}

Pekka Pessi's avatar
Pekka Pessi committed
279
/* Internal prototypes */
280 281 282
int  nua_stack_init(su_root_t *root, nua_t *nua);
void nua_stack_deinit(su_root_t *root, nua_t *nua);

283 284 285
int nua_stack_init_transport(nua_t *nua, tagi_t const *tags);

int nua_stack_init_registrations(nua_t *nua);
286

287 288 289 290
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);
291

292 293 294
sip_contact_t const *nua_registration_contact(nua_registration_t const *nr);

int nua_registration_process_request(nua_registration_t *nr,
295 296
				     nta_incoming_t *irq,
				     sip_t const *sip);
297

298
void nua_stack_post_signal(nua_handle_t *nh, nua_event_t event,
299 300
			   tag_type_t tag, tag_value_t value, ...);

301 302 303
typedef int nua_stack_signal_handler(nua_t *,
				     nua_handle_t *,
				     nua_event_t,
304 305
				     tagi_t const *);

306 307 308 309
void nua_move_signal(nua_saved_signal_t a[1], nua_saved_signal_t b[1]);
nua_signal_data_t const *nua_signal_data(nua_saved_signal_t const saved[1]);
void nua_destroy_signal(nua_saved_signal_t saved[1]);

310
nua_stack_signal_handler
311
  nua_stack_set_params, nua_stack_get_params,
312 313
  nua_stack_register,
  nua_stack_invite, nua_stack_ack, nua_stack_cancel,
314 315
  nua_stack_bye, nua_stack_info, nua_stack_update,
  nua_stack_prack,
316
  nua_stack_options, nua_stack_publish, nua_stack_message,
317 318 319 320
  nua_stack_subscribe, nua_stack_notify, nua_stack_refer,
  nua_stack_method;

#define UA_EVENT1(e, statusphrase) \
321
  nua_stack_event(nua, nh, NULL, e, statusphrase, NULL)
322 323

#define UA_EVENT2(e, status, phrase)			\
324
  nua_stack_event(nua, nh, NULL, e, status, phrase, NULL)
325 326

#define UA_EVENT3(e, status, phrase, tag)			\
327 328 329 330 331
  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, ...);
332 333 334

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

337 338
void nua_move_event(nua_saved_event_t a[1], nua_saved_event_t b[1]);

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

341
nua_handle_t *nua_stack_incoming_handle(nua_t *nua,
342 343 344 345
					nta_incoming_t *irq,
					sip_t const *sip,
					int create_dialog);

346
int nua_stack_init_handle(nua_t *nua, nua_handle_t *nh, tagi_t const *tags);
347

348 349 350 351 352 353 354 355 356
enum nh_kind {
  nh_has_nothing,
  nh_has_invite,
  nh_has_subscribe,
  nh_has_notify,
  nh_has_register,
  nh_has_streaming
};

357 358 359 360
int nua_stack_set_handle_special(nua_handle_t *nh,
				 enum nh_kind kind,
				 nua_event_t special);

361 362
int nua_handle_save_tags(nua_handle_t *h, tagi_t *tags);

363 364 365 366
void nh_destroy(nua_t *nua, nua_handle_t *nh);

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

367
sip_replaces_t *nua_stack_handle_make_replaces(nua_handle_t *handle,
368 369 370 371 372 373
					       su_home_t *home,
					       int early_only);

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

Michael Jerris's avatar
Michael Jerris committed
374 375 376
nua_handle_t *nua_stack_handle_by_call_id(nua_t *nua, const char *call_id);


377 378
/* ---------------------------------------------------------------------- */

379 380
int nua_stack_set_defaults(nua_handle_t *nh, nua_handle_preferences_t *nhp);

381
int nua_stack_set_from(nua_t *, int initial, tagi_t const *tags);
382 383 384

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

385 386 387 388 389
int nua_stack_process_request(nua_handle_t *nh,
			      nta_leg_t *leg,
			      nta_incoming_t *irq,
			      sip_t const *sip);

390 391
int nua_stack_launch_network_change_detector(nua_t *nua);

392
sip_contact_t const *nua_stack_get_contact(nua_registration_t const *nr);
393

394
int nua_registration_add_contact_to_request(nua_handle_t *nh,
395
					    msg_t *msg,
396 397 398 399 400 401 402 403 404
					    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);
405

406 407
/* ---------------------------------------------------------------------- */

408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
#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 SET_STATUS(_status, _phrase) status = _status, phrase = _phrase

426 427
#define SET_STATUS2(_status, _phrase) status = _status, phrase = _phrase

428 429 430 431 432 433 434 435 436 437 438
/* 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 */

439 440 441
int nua_signal(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
442

443 444
SOFIA_END_DECLS

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