nua_dialog.h 5.96 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

Pekka Pessi's avatar
Pekka Pessi committed
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 51 52 53 54 55 56 57 58 59 60 61 62
#ifndef NTA_H
#include <sofia-sip/nta.h>
#endif

struct nua_dialog_state
{
  /** Dialog usages. */
  nua_dialog_usage_t     *ds_usage;

  /* 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 */
63 64 65

  unsigned ds_has_referrals:1;	/**< We have (or have had) referrals */

66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
  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];
};

89
typedef void nh_pending_f(nua_owner_t *, 
90 91 92
			  nua_dialog_usage_t *du,
			  sip_time_t now);

93
/** Virtual function pointer table for dialog usage. */
94 95
typedef struct {
  unsigned usage_size, usage_class_size;
96 97 98 99
  int (*usage_add)(nua_owner_t *, 
		   nua_dialog_state_t *ds,
		   nua_dialog_usage_t *du);
  void (*usage_remove)(nua_owner_t *, 
100 101 102
		       nua_dialog_state_t *ds,
		       nua_dialog_usage_t *du);
  char const *(*usage_name)(nua_dialog_usage_t const *du);
103 104 105
  void (*usage_peer_info)(nua_dialog_usage_t *du,
			  nua_dialog_state_t const *ds,
			  sip_t const *sip);
Pekka Pessi's avatar
Pekka Pessi committed
106 107
  void (*usage_refresh)(nua_owner_t *, nua_dialog_usage_t *, sip_time_t now);
  int (*usage_shutdown)(nua_owner_t *, nua_dialog_usage_t *);
108 109
} nua_usage_class;

110 111

/** Base structure for dialog usage. */
112 113 114 115 116 117
struct nua_dialog_usage {
  nua_dialog_usage_t *du_next;
  nua_usage_class const *du_class;

  unsigned     du_terminating:1;	/**< Now trying to terminate usage */
  unsigned     du_ready:1;	        /**< Established usage */
Pekka Pessi's avatar
Pekka Pessi committed
118
  unsigned     du_shutdown:1;	        /**< Shutdown in progress */
119 120
  unsigned:0;

121 122 123
  /** When usage expires.
   * Non-zero if the usage is established, SIP_TIME_MAX if there no
   * expiration time.
124
   */
125 126 127
  sip_time_t      du_expires;		

  sip_time_t      du_refresh;		/**< When to refresh */
128 129

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

131 132 133
  msg_t *du_msg;			/**< Template message */
};

134 135 136 137 138 139
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);
140 141 142
int nua_dialog_remove(nua_owner_t *own,
		      nua_dialog_state_t *ds,
		      nua_dialog_usage_t *usage);
143 144 145

char const *nua_dialog_usage_name(nua_dialog_usage_t const *du);

146
nua_dialog_usage_t *nua_dialog_usage_add(nua_owner_t *, 
147 148 149 150 151 152 153 154
					 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);

155
void nua_dialog_usage_remove(nua_owner_t *, 
156 157 158
			     nua_dialog_state_t *ds,
			     nua_dialog_usage_t *du);

159 160 161
void nua_dialog_deinit(nua_owner_t *own,
		       nua_dialog_state_t *ds);

162
void nua_dialog_terminated(nua_owner_t *,
163 164 165 166
			   struct nua_dialog_state *ds,
			   int status,
			   char const *phrase);

167 168
void nua_dialog_usage_set_expires(nua_dialog_usage_t *du, unsigned delta);

169 170
void nua_dialog_usage_set_refresh(nua_dialog_usage_t *du, unsigned delta);

171 172 173
void nua_dialog_usage_refresh_range(nua_dialog_usage_t *du, 
				    unsigned min, unsigned max);

174 175 176 177
void nua_dialog_usage_refresh(nua_owner_t *owner,
			      nua_dialog_usage_t *du, 
			      sip_time_t now);

178
void nua_dialog_usage_no_refresh(nua_dialog_usage_t *du);
179 180 181 182 183 184 185 186 187 188 189

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)
{
190 191 192 193 194 195 196
  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;
197 198
}
#else
199 200
#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)
201 202 203
#endif

#endif /* NUA_DIALOG_H */