nua_params.h 8.7 KB
Newer Older
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) 2006 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_PARAMS_H
/** Defined when <nua_params.h> has been included. */
27 28
#define NUA_PARAMS_H

29
/**@internal @file nua_params.h
30 31 32 33 34 35 36 37
 * @brief Parameters and their 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
 */

38 39
#include <nua_types.h>

40
/**@internal @brief NUA preferences.
41 42 43 44 45 46 47 48 49 50 51 52 53 54
 *
 * This structure contains values for various preferences and a separate
 * bitmap (nhp_set) for each preference. Preferences are set using
 * nua_set_params() or nua_set_hparams() or a handle-specific operation
 * setting the preferences, including nua_invite(), nua_respond(),
 * nua_ack(), nua_prack(), nua_update(), nua_info(), nua_bye(),
 * nua_options(), nua_message(), nua_register(), nua_publish(), nua_refer(),
 * nua_subscribe(), nua_notify(), nua_refer(), and nua_notifier().
 *
 * The stack uses preference value if corresponding bit in bitmap is set,
 * otherwise it uses preference value from default handle.
 *
 * @see NHP_GET(), NH_PGET(), NHP_ISSET(), NH_PISSET()
 */
55
struct nua_handle_preferences
56 57 58 59 60
{
  unsigned         nhp_retry_count;	/**< times to retry a request */
  unsigned         nhp_max_subscriptions;

  /* Session-related preferences */
61 62
  char const      *nhp_soa_name;
  unsigned         nhp_media_enable:1;
63 64
  unsigned     	   nhp_invite_enable:1;
  unsigned     	   nhp_auto_alert:1;
65 66
  unsigned         nhp_early_answer:1; /**< Include answer in 1XX */
  unsigned         nhp_early_media:1; /**< Establish early media with 100rel */
67
  unsigned         nhp_only183_100rel:1;/**< Only 100rel 183. */
68 69 70 71
  unsigned         nhp_auto_answer:1;
  unsigned         nhp_auto_ack:1; /**< Automatically ACK a final response */
  unsigned         :0;

72
  /** INVITE timeout.
73 74 75 76 77 78 79 80 81 82
   *
   * If no response is received in nhp_invite_timeout seconds,
   * INVITE client transaction times out
   */
  unsigned         nhp_invite_timeout;
  /** Default session timer (in seconds, 0 disables) */
  unsigned         nhp_session_timer;
  /** Default Min-SE Delta value */
  unsigned         nhp_min_se;
  /** no (preference), local or remote */
83
  enum nua_session_refresher nhp_refresher;
84
  unsigned         nhp_update_refresh:1; /**< Use UPDATE to refresh */
85 86 87

  /**< Accept refreshes without SDP */
  unsigned         nhp_refresh_without_sdp:1;
88

89 90 91 92
  /* Messaging preferences */
  unsigned     	   nhp_message_enable : 1;
  /** Be bug-compatible with Windows Messenger */
  unsigned     	   nhp_win_messenger_enable : 1;
93 94
  /** PIM-IW hack */
  unsigned         nhp_message_auto_respond : 1;
95 96 97 98 99 100 101 102

  /* Preferences for registration (and dialog establishment) */
  unsigned         nhp_callee_caps:1; /**< Add callee caps to contact */
  unsigned         nhp_media_features:1;/**< Add media features to caps*/
  /** Enable Service-Route */
  unsigned         nhp_service_route_enable:1;
  /** Enable Path */
  unsigned         nhp_path_enable:1;
103 104 105
  /** Authentication cache policy */
  unsigned         nhp_auth_cache:1;

106 107
  /** Always include id with Event: refer */
  unsigned         nhp_refer_with_id:1;
108 109 110 111 112 113 114
  unsigned:0;

  /* Default lifetime for implicit subscriptions created by REFER */
  unsigned         nhp_refer_expires;

  /* Subscriber state, i.e. nua_substate_pending */
  unsigned         nhp_substate;
115
  unsigned         nhp_sub_expires;
116

117
  /* REGISTER keepalive intervals */
118 119 120
  unsigned         nhp_keepalive, nhp_keepalive_stream;
  char const      *nhp_registrar;

121 122
  sip_allow_t        *nhp_allow;
  sip_supported_t    *nhp_supported;
123
  sip_allow_events_t *nhp_allow_events;
124 125
  char const         *nhp_user_agent;
  char const         *nhp_organization;
126

127 128 129 130
  char const         *nhp_m_display;
  char const         *nhp_m_username;
  char const         *nhp_m_params;
  char const         *nhp_m_features;
131
  char const         *nhp_instance;
132

133
  /** Outbound OPTIONS */
134 135
  char const         *nhp_outbound;

136
  sip_allow_t        *nhp_appl_method;
137

138 139 140
  /** Initial route set */
  sip_route_t        *nhp_initial_route;

141 142 143
  /** Next hop URI (used instead of route). */
  url_string_t       *nhp_proxy;

144 145
  union { struct {
    /* A bit for each feature set by application */
146
    /* NOTE:
147
       Some compilers behave weird if there are bitfields
148 149 150
       together with width > 32
       So there should be a padding field (unsigned:0;)
       every 32 bits.
151
    */
152 153
    unsigned nhb_retry_count:1;
    unsigned nhb_max_subscriptions:1;
154 155 156

    unsigned nhb_soa_name:1;
    unsigned nhb_media_enable:1;
157 158
    unsigned nhb_invite_enable:1;
    unsigned nhb_auto_alert:1;
159
    unsigned nhb_early_answer:1;
160 161 162 163 164
    unsigned nhb_early_media:1;
    unsigned nhb_only183_100rel:1;
    unsigned nhb_auto_answer:1;
    unsigned nhb_auto_ack:1;
    unsigned nhb_invite_timeout:1;
165

166 167
    unsigned nhb_session_timer:1;
    unsigned nhb_min_se:1;
168
    unsigned nhb_refresher:1;
169
    unsigned nhb_update_refresh:1;
170
    unsigned nhb_refresh_without_sdp:1;
171 172
    unsigned nhb_message_enable:1;
    unsigned nhb_win_messenger_enable:1;
173
    unsigned nhb_message_auto_respond:1;
174 175 176 177
    unsigned nhb_callee_caps:1;
    unsigned nhb_media_features:1;
    unsigned nhb_service_route_enable:1;
    unsigned nhb_path_enable:1;
178
    unsigned nhb_auth_cache:1;
179 180 181
    unsigned nhb_refer_with_id:1;
    unsigned nhb_refer_expires:1;
    unsigned nhb_substate:1;
182
    unsigned nhb_sub_expires:1;
183 184 185
    unsigned nhb_keepalive:1;
    unsigned nhb_keepalive_stream:1;
    unsigned nhb_registrar:1;
186
    unsigned :0;		/* at most 32 bits before this point */
187

188
    unsigned nhb_allow:1;
189
    unsigned nhb_supported:1;
190

191
    unsigned nhb_allow_events:1;
192
    unsigned nhb_user_agent:1;
193
    unsigned nhb_organization:1;
194

195 196 197 198 199 200
    unsigned nhb_m_display:1;
    unsigned nhb_m_username:1;
    unsigned nhb_m_params:1;
    unsigned nhb_m_features:1;
    unsigned nhb_instance:1;
    unsigned nhb_outbound:1;
201
    unsigned nhb_appl_method:1;
202
    unsigned nhb_initial_route:1;
203
    unsigned nhb_proxy:1;
204
    unsigned :0;
205
  } set_bits;
206 207
    unsigned set_unsigned[2];
  } nhp_set_;
208
};
209

210 211
#define nhp_set nhp_set_.set_bits

212
/** Global preferences for nua. */
213
struct nua_global_preferences {
214 215 216 217 218 219 220 221 222 223 224
  /** Network detection: NONE, INFORMAL, TRY_FULL */
  signed int ngp_detect_network_updates:3;
  /** Pass events during shutdown, too */
  int ngp_shutdown_events:1;

  unsigned :0;			/* pad */
  union { struct {
    /* A bit for each feature set by application */
    unsigned ngp_detect_network_updates:1;
    unsigned ngp_shutdown_events:1;
    unsigned :0;
225
  } set_bits;
226 227
    unsigned set_unsigned[2];
  } ngp_set_;
228
};
229 230 231

#define ngp_set ngp_set_.set_bits

232 233 234
#define DNHP_GET(dnhp, pref) ((dnhp)->nhp_##pref)

#define NHP_GET(nhp, dnhp, pref)					\
235
  ((nhp)->nhp_set.nhb_##pref					\
236 237 238 239
   ? (nhp)->nhp_##pref : (dnhp)->nhp_##pref)

#define NHP_SET(nhp, pref, value)					\
  ((nhp)->nhp_##pref = (value),						\
240
   (nhp)->nhp_set.nhb_##pref = 1)
241 242 243

/* Check if preference is set */
#define NHP_ISSET(nhp, pref)						\
244
  ((nhp)->nhp_set.nhb_##pref)
245

246 247
#define NHP_UNSET_ALL(nhp) (memset(&(nhp)->nhp_set, 0, sizeof (nhp)->nhp_set))
#define NHP_SET_ALL(nhp) (memset(&(nhp)->nhp_set, 255, sizeof (nhp)->nhp_set))
248 249 250

/* Get preference from handle, if set, otherwise from default handle */
#define NH_PGET(nh, pref)						\
251
  NHP_GET((nh)->nh_prefs, (nh)->nh_dprefs, pref)
252

253
/* Get preference from handle, if exists and set,
254 255 256 257 258 259
   otherwise from default handle */
#define NUA_PGET(nua, nh, pref)						\
  NHP_GET((nh) ? (nh)->nh_prefs : (nua)->nua_dhandle->nh_prefs,		\
	  (nua)->nua_dhandle->nh_prefs,					\
	  pref)

260 261 262 263 264 265 266 267
/* Get preference from default handle */
#define DNH_PGET(dnh, pref)						\
  DNHP_GET((dnh)->nh_prefs, pref)
/* Check if preference is set in the handle */
#define NH_PISSET(nh, pref)						\
  (NHP_ISSET((nh)->nh_prefs, pref) &&					\
   (nh)->nh_nua->nua_dhandle->nh_prefs != (nh)->nh_prefs)

268
/* Check if preference has been set by application */
269 270 271 272
#define NUA_PISSET(nua, nh, pref)					\
  (NHP_ISSET((nua)->nua_dhandle->nh_prefs, pref) ||			\
   ((nh) && NHP_ISSET((nh)->nh_prefs, pref)))

273
#endif /* NUA_PARAMS_H */