nua_dialog.h 17 KB
Newer Older
1 2 3
/*
 * This file is part of the Sofia-SIP package
 *
4
 * Copyright (C) 2006 Nokia Corporation.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 *
 * 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_DIALOG_H
/** Defined when <nua_dialog.h> has been included. */
27 28
#define NUA_DIALOG_H

29
/**@IFILE nua_dialog.h 
30 31 32 33 34 35 36 37 38 39
 * @brief Dialog and dialog usage handling
 *
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>
 * @author Kai Vehmanen <Kai.Vehmanen@nokia.com>
 *
 * @date Created: Wed Mar  8 11:38:18 EET 2006  ppessi
 */

typedef struct nua_dialog_state nua_dialog_state_t;
typedef struct nua_dialog_usage nua_dialog_usage_t;
40
typedef struct nua_remote_s nua_remote_t;
41

42 43
#ifndef NUA_OWNER_T
#define NUA_OWNER_T struct nua_owner_s
44
#endif
45 46
typedef NUA_OWNER_T nua_owner_t;

47 48 49 50
#ifndef NTA_H
#include <sofia-sip/nta.h>
#endif

51 52
typedef struct nua_server_request nua_server_request_t; 
typedef struct nua_client_request nua_client_request_t; 
53
typedef su_msg_r nua_saved_signal_t;
54 55 56 57 58 59 60

/** Respond to an incoming request. */
typedef int nua_server_respond_f(nua_server_request_t *, tagi_t const *);

/** Restart an outgoing request. */
typedef void nua_creq_restart_f(nua_owner_t *, tagi_t *tags);

61 62 63 64 65 66 67 68 69
/** Initialize an outgoing request */
typedef int nua_client_init_f(nua_client_request_t *,
			      nua_dialog_usage_t *,
			      tagi_t const *tags);

/** Send an outgoing request. */
typedef int nua_client_request_f(nua_client_request_t *,
				 msg_t *msg, sip_t *);

70 71 72 73 74 75 76
/** Server side transaction */
struct nua_server_request {
  struct nua_server_request *sr_next, **sr_prev;

  nua_owner_t *sr_owner;	/**< Backpointer to handle */
  nua_dialog_usage_t *sr_usage;	/**< Backpointer to usage */

77
  /** When the application responds to a request with
78 79 80 81 82
   * nua_respond(), the sr_respond() is called
   */
  nua_server_respond_f *sr_respond;
  
  nta_incoming_t *sr_irq;	/**< Server transaction object */
83 84
  msg_t *sr_request;		/**< Request message */
  msg_t *sr_response;		/**< Response message */
85 86 87 88 89

  sip_method_t sr_method;	/**< Request method */
  int sr_status;		/**< Status code */
  char const *sr_phrase;	/**< Status phrase */

90 91
  unsigned sr_event:1;		/**< Sent to application */
  unsigned sr_application:1;	/**< Response by application */
92 93 94 95 96 97 98 99 100 101
  unsigned sr_initial:1;	/**< Handle was created by this request */

  /* Flags used with offer-answer */
  unsigned sr_offer_recv:1;	/**< We have received an offer */
  unsigned sr_answer_sent:2;	/**< We have answered (reliably, if >1) */

  unsigned sr_offer_sent:1;	/**< We have offered SDP */
  unsigned sr_answer_recv:1;	/**< We have received SDP answer */
};

102 103 104 105
#define SR_INIT(sr)			     \
  ((void)memset((sr), 0, sizeof (sr)[0]),    \
   (void)(SR_STATUS1((sr), SIP_100_TRYING)), \
   sr)
106 107 108 109 110 111 112 113 114 115 116 117 118

#define SR_STATUS(sr, status, phrase) \
  ((sr)->sr_phrase = (phrase), (sr)->sr_status = (status))

#define SR_STATUS1(sr, statusphrase)					\
  sr_status(sr, statusphrase)

su_inline 
int sr_status(nua_server_request_t *sr, int status, char const *phrase)
{
  return (void)(sr->sr_phrase = phrase), (sr->sr_status = status);
}

119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 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 159 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 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
/** Methods for client request */
typedef struct {
  sip_method_t crm_method;
  char const *crm_method_name;
  size_t crm_extra;		/**< Size of private data */

  struct {
    unsigned create_dialog:1, in_dialog:1, target_refresh:1;
    unsigned:0;
  } crm_flags;

  /** Generate a request message.
   *
   * @retval 1 when request message has been created
   * @retval 0 when request message should be created in normal fashion
   * @retval -1 upon an error
   */
  int (*crm_template)(nua_client_request_t *cr,
		      msg_t **return_msg,
		      tagi_t const *tags);

  /**@a crm_init is called when a client request is sent first time. 
   *
   * @retval 1 when request has been responded
   * @retval 0 when request should be sent in normal fashion
   * @retval -1 upon an error
   */
  int (*crm_init)(nua_client_request_t *, msg_t *msg, sip_t *sip,
		  tagi_t const *tags);

  /** @a crm_send is called each time when a client request is sent.
   *
   * @retval 1 when request has been responded
   * @retval 0 when request has been sent
   * @retval -1 upon an error (request message has not been destroyed)
   * @retval -2 upon an error (request message has been destroyed)
   */
  int (*crm_send)(nua_client_request_t *,
		  msg_t *msg, sip_t *sip,
		  tagi_t const *tags);

  /** @a crm_check_restart is called each time when a response is received.
   *
   * It is used to restart reqquest after responses with method-specific
   * status code or method-specific way of restarting the request.
   *
   * @retval 1 when request has been restarted
   * @retval 0 when response should be processed normally
   */
  int (*crm_check_restart)(nua_client_request_t *,
			   int status, char const *phrase,
			   sip_t const *sip);

  /** @a crm_recv is called each time a final response is received.
   *
   * A final response is in range 200 .. 699 (or internal response) and it
   * cannot be restarted.
   *
   * crm_recv() should call nua_base_client_response() or
   * nua_base_client_tresponse(). The return values below are documented with
   * nua_base_client_response(), too.
   *
   * @retval 0 if response was preliminary
   * @retval 1 if response was final
   * @retval 2 if response destroyed the handle, too.
   */
  int (*crm_recv)(nua_client_request_t *,
		  int status, char const *phrase,
		  sip_t const *sip);

  /** @a crm_preliminary is called each time a preliminary response is received.
   *
   * A preliminary response is in range 101 .. 199.
   *
   * crm_preliminary() should call nua_base_client_response() or
   * nua_base_client_tresponse().
   *
   * @retval 0 if response was preliminary
   * @retval 1 if response was final
   * @retval 2 if response destroyed the handle, too.
   */
  int (*crm_preliminary)(nua_client_request_t *,
			 int status, char const *phrase,
			 sip_t const *sip);

  /** @a crm_report is called each time a response is received and it is
   * reported to the application.
   *
   * The status and phrase may be different from the status and phrase
   * received from the network, e.g., when the request is restarted.
   *
   * @return The return value should be 0. It is currently ignored.
   */
  int (*crm_report)(nua_client_request_t *,
		    int status, char const *phrase,
		    sip_t const *sip,
		    nta_outgoing_t *orq,
		    tagi_t const *tags);

218 219 220 221 222 223
  /** @a crm_deinit is called when a client-side request is destroyed.
   *
   * @return The return value should be 0. It is currently ignored.
   */
  int (*crm_deinit)(nua_client_request_t *);

224 225 226
} nua_client_methods_t;

/* Client-side request. Documented by nua_client_create() */
227 228
struct nua_client_request
{
229 230
  nua_client_request_t *cr_next, **cr_prev; /**< Linked list of requests */
  nua_owner_t        *cr_owner;
231
  nua_dialog_usage_t *cr_usage;
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252

  nua_saved_signal_t cr_signal;
  tagi_t const      *cr_tags;

  nua_client_methods_t const *cr_methods;

  msg_t              *cr_msg;
  sip_t              *cr_sip;

  nta_outgoing_t     *cr_orq;

  /*nua_event_t*/ int cr_event;		/**< Request event */
  sip_method_t        cr_method;
  char const         *cr_method_name;

  url_t              *cr_target;

  uint32_t            cr_seq;

  unsigned short      cr_status;        /**< Latest status */

253 254 255 256 257 258
  unsigned short      cr_retry_count;   /**< Retry count for this request */

  /* Flags used with offer-answer */
  unsigned short      cr_answer_recv;   /**< Recv answer in response 
					 *  with this status.
					 */
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
  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 */

  /* Lifelong flags? */
  unsigned cr_auto:1;		/**< Request was generated by stack */
  unsigned cr_has_contact:1;	/**< Request has user Contact */
  unsigned cr_contactize:1;	/**< Request needs Contact */

  /* Current state */
  unsigned cr_challenged:1;	/**< Request was challenged, pending auth */
  unsigned cr_restarting:1;	/**< Request is being restarted */
  unsigned cr_reporting:1;	/**< Reporting in progress */
  unsigned cr_terminating:1;	/**< Request terminates the usage */
  signed int cr_terminated:2;	/**< Response terminated usage (1) or 
				    whole dialog (-1) */
  unsigned cr_graceful:1;	/**< Graceful termination required */
277 278 279
};


280 281 282 283 284
struct nua_dialog_state
{
  /** Dialog usages. */
  nua_dialog_usage_t     *ds_usage;

285 286 287 288 289
  /** Client requests */
  nua_client_request_t   *ds_cr;
  /** Server requests */
  nua_server_request_t *ds_sr;

290 291 292 293 294 295 296
  /* 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 */
297

298
  unsigned ds_got_referrals:1;	/**< We have (or have had) referrals */
299

300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
  unsigned :0;

  unsigned ds_has_events;	/**< We have events */
  unsigned ds_has_subscribes;   /**< We have subscriptions */
  unsigned ds_has_notifys;	/**< We have notifiers */

  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];
};

323
typedef void nh_pending_f(nua_owner_t *, 
324 325 326
			  nua_dialog_usage_t *du,
			  sip_time_t now);

327
/** Virtual function pointer table for dialog usage. */
328 329
typedef struct {
  unsigned usage_size, usage_class_size;
330 331 332 333
  int (*usage_add)(nua_owner_t *, 
		   nua_dialog_state_t *ds,
		   nua_dialog_usage_t *du);
  void (*usage_remove)(nua_owner_t *, 
334 335 336
		       nua_dialog_state_t *ds,
		       nua_dialog_usage_t *du);
  char const *(*usage_name)(nua_dialog_usage_t const *du);
337 338 339
  void (*usage_peer_info)(nua_dialog_usage_t *du,
			  nua_dialog_state_t const *ds,
			  sip_t const *sip);
340 341 342 343
  void (*usage_refresh)(nua_owner_t *, nua_dialog_state_t *ds,
			nua_dialog_usage_t *, sip_time_t now);
  int (*usage_shutdown)(nua_owner_t *, nua_dialog_state_t *ds, 
			nua_dialog_usage_t *);
344 345
} nua_usage_class;

346 347

/** Base structure for dialog usage. */
348 349 350
struct nua_dialog_usage {
  nua_dialog_usage_t *du_next;
  nua_usage_class const *du_class;
351
  nua_client_request_t *du_cr;	        /**< Client request bound with usage */
352 353

  unsigned     du_ready:1;	        /**< Established usage */
354
  unsigned     du_shutdown:1;	        /**< Shutdown in progress */
355 356
  unsigned:0;

357 358 359
  /** When usage expires.
   * Non-zero if the usage is established, SIP_TIME_MAX if there no
   * expiration time.
360
   */
361 362 363
  sip_time_t      du_expires;		

  sip_time_t      du_refresh;		/**< When to refresh */
364 365

  sip_event_t const *du_event;		/**< Event of usage */
366

367 368
};

369 370 371 372 373 374
void nua_dialog_uac_route(nua_owner_t *, nua_dialog_state_t *ds,
			  sip_t const *sip, int rtag);
void nua_dialog_uas_route(nua_owner_t *, nua_dialog_state_t *ds,
			  sip_t const *sip, int rtag);
void nua_dialog_store_peer_info(nua_owner_t *, nua_dialog_state_t *ds,
				sip_t const *sip);
375 376 377
int nua_dialog_remove(nua_owner_t *own,
		      nua_dialog_state_t *ds,
		      nua_dialog_usage_t *usage);
378 379 380

char const *nua_dialog_usage_name(nua_dialog_usage_t const *du);

381
nua_dialog_usage_t *nua_dialog_usage_add(nua_owner_t *, 
382 383 384 385 386 387 388 389
					 struct nua_dialog_state *ds,
					 nua_usage_class const *uclass,
					 sip_event_t const *event);

nua_dialog_usage_t *nua_dialog_usage_get(nua_dialog_state_t const *ds, 
					 nua_usage_class const *uclass,
					 sip_event_t const *event);

390
void nua_dialog_usage_remove(nua_owner_t *, 
391 392 393
			     nua_dialog_state_t *ds,
			     nua_dialog_usage_t *du);

394 395 396
void nua_dialog_deinit(nua_owner_t *own,
		       nua_dialog_state_t *ds);

397
void nua_dialog_terminated(nua_owner_t *,
398 399 400 401
			   struct nua_dialog_state *ds,
			   int status,
			   char const *phrase);

402 403
void nua_dialog_usage_set_expires(nua_dialog_usage_t *du, unsigned delta);

404 405
void nua_dialog_usage_set_refresh(nua_dialog_usage_t *du, unsigned delta);

406 407 408
void nua_dialog_usage_refresh_range(nua_dialog_usage_t *du, 
				    unsigned min, unsigned max);

409 410
void nua_dialog_usage_reset_refresh(nua_dialog_usage_t *du);

411
void nua_dialog_usage_refresh(nua_owner_t *owner,
412
			      nua_dialog_state_t *ds,
413 414 415
			      nua_dialog_usage_t *du, 
			      sip_time_t now);

416 417 418 419
void nua_dialog_usage_terminate(nua_owner_t *owner,
				nua_dialog_state_t *ds,
				nua_dialog_usage_t *du);

420 421 422 423 424 425 426 427 428 429
static inline
int nua_dialog_is_established(nua_dialog_state_t const *ds)
{
  return ds->ds_remote_tag != NULL;
}

#if 0
static inline
void *nua_dialog_usage_private(nua_dialog_usage_t const *du)
{
430 431 432 433 434 435 436
  return du ? (void *)(du + 1) : NULL;
}

static inline
nua_dialog_usage_t *nua_dialog_usage_public(void const *p)
{
  return p ? (nua_dialog_usage_t *)p - 1 : NULL;
437 438
}
#else
439 440
#define nua_dialog_usage_private(du) ((du) ? (void*)((du) + 1) : NULL)
#define nua_dialog_usage_public(p) ((p) ? (nua_dialog_usage_t*)(p) - 1 : NULL)
441 442
#endif

443 444
/* ---------------------------------------------------------------------- */

445 446 447 448 449 450 451 452 453 454 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 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552
int nua_client_create(nua_owner_t *owner,
		      int event,
		      nua_client_methods_t const *methods,
		      tagi_t const *tags);

int nua_client_tcreate(nua_owner_t *nh, 
		       int event,
		       nua_client_methods_t const *methods,
		       tag_type_t tag, tag_value_t value, ...);

static inline 
void *nua_private_client_request(nua_client_request_t const *cr)
{
  return (void *)(cr + 1);
}

void nua_client_request_destroy(nua_client_request_t *);

int nua_client_request_queue(nua_client_request_t *cr);

static inline int nua_client_is_queued(nua_client_request_t const *cr)
{
  return cr && cr->cr_prev;
}

nua_client_request_t *nua_client_request_remove(nua_client_request_t *cr);

int nua_client_bind(nua_client_request_t *cr, nua_dialog_usage_t *du);

static inline int nua_client_is_bound(nua_client_request_t const *cr)
{
  return cr && cr->cr_usage && cr->cr_usage->du_cr == cr;
}

static inline int nua_client_is_reporting(nua_client_request_t const *cr)
{
  return cr && cr->cr_reporting;
}

/** Mark client request as a terminating one */
static inline void nua_client_terminating(nua_client_request_t *cr)
{
  cr->cr_terminating = 1;
}

int nua_client_init_request(nua_client_request_t *cr);

int nua_client_resend_request(nua_client_request_t *cr,
			      int terminating,
			      tagi_t const *tags);

int nua_base_client_request(nua_client_request_t *cr,
			    msg_t *msg,
			    sip_t *sip,
			    tagi_t const *tags);

int nua_base_client_trequest(nua_client_request_t *cr,
			     msg_t *msg,
			     sip_t *sip,
			     tag_type_t tag, tag_value_t value, ...);

extern nta_response_f nua_client_orq_response;

int nua_client_return(nua_client_request_t *cr,
		      int status,
		      char const *phrase,
		      msg_t *to_be_destroyed);

int nua_client_response(nua_client_request_t *cr,
			int status,
			char const *phrase,
			sip_t const *sip);

int nua_client_check_restart(nua_client_request_t *cr,
			     int status,
			     char const *phrase,
			     sip_t const *sip);

int nua_base_client_check_restart(nua_client_request_t *cr,
				  int status,
				  char const *phrase,
				  sip_t const *sip);

int nua_client_restart(nua_client_request_t *cr,
		       int status, char const *phrase);

int nua_base_client_response(nua_client_request_t *cr,
			     int status, char const *phrase,
			     sip_t const *sip,
			     tagi_t const *tags);

int nua_base_client_tresponse(nua_client_request_t *cr,
			      int status, char const *phrase,
			      sip_t const *sip,
			      tag_type_t tag, tag_value_t value, ...);

int nua_client_set_target(nua_client_request_t *cr, url_t const *target);

int nua_client_report(nua_client_request_t *cr,
		      int status, char const *phrase,
		      sip_t const *sip,
		      nta_outgoing_t *orq,
		      tagi_t const *tags);

nua_client_request_t *nua_client_request_pending(nua_client_request_t const *);

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

553 554 555 556 557 558 559 560 561 562 563 564 565 566
void nua_server_request_destroy(nua_server_request_t *sr);

int nua_server_respond(nua_server_request_t *sr,
		       int status, char const *phrase,
		       tag_type_t tag, tag_value_t value, ...);

msg_t *nua_server_response(nua_server_request_t *sr,
			   int status, char const *phrase,
			   tag_type_t tag, tag_value_t value, ...);

int nua_default_respond(nua_server_request_t *sr,
			tagi_t const *tags);


567 568
/* ---------------------------------------------------------------------- */

569
#endif /* NUA_DIALOG_H */