retronetworking
/
freeswitch
13
0
Fork 0
Code Pull Requests Releases Activity
freeswitch/libs/sofia-sip/libsofia-sip-ua/nua/nua_stack.h

464 lines
13 KiB
C
Raw Blame History

/*
* 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
*
*/
#ifndef NUA_STACK_H
/** Defined when <nua_stack.h> has been included. */
#define NUA_STACK_H
/**@IFILE nua_stack.h
* @brief Sofia-SIP User Agent Engine - internal stack interface
*
* @author Pekka Pessi <Pekka.Pessi@nokia.com>
* @author Kai Vehmanen <Kai.Vehmanen@nokia.com>
*
* @date Created: Wed Feb 14 17:09:44 2001 ppessi
*/
#ifndef SU_CONFIG_H
#include <su_config.h>
#endif
#ifndef SU_OS_NW_H
#include <sofia-sip/su_os_nw.h>
#endif
#ifndef SOA_H
#include "sofia-sip/soa.h"
#endif
#ifndef NTA_H
#include <sofia-sip/nta.h>
#endif
#ifndef AUTH_CLIENT_H
#include <sofia-sip/auth_client.h>
#endif
#ifndef NEA_H
#include <sofia-sip/nea.h>
#endif
#ifndef NUA_H
#include <sofia-sip/nua.h>
#endif
#define SU_LOG (nua_log)
#include <sofia-sip/su_debug.h>
#ifndef NUA_DIALOG_H
#define NUA_OWNER_T struct nua_handle_s
#include "nua_dialog.h"
#endif
SOFIA_BEGIN_DECLS
#if HAVE_SIGCOMP
#include <sigcomp.h>
#endif
#ifndef NUA_PARAMS_H
#include "nua_params.h"
#endif
typedef struct event_s event_t, nua_signal_data_t;
#define NONE ((void *)-1)
typedef struct register_usage nua_registration_t;
#define \
NH_ACTIVE_MEDIA_TAGS(include, soa) \
TAG_IF((include) && (soa) && soa_is_audio_active(soa) >= 0, \
SOATAG_ACTIVE_AUDIO(soa_is_audio_active(soa))), \
TAG_IF((include) && (soa) && soa_is_video_active(soa) >= 0, \
SOATAG_ACTIVE_VIDEO(soa_is_video_active(soa))), \
TAG_IF((include) && (soa) && soa_is_image_active(soa) >= 0, \
SOATAG_ACTIVE_IMAGE(soa_is_image_active(soa))), \
TAG_IF((include) && (soa) && soa_is_chat_active(soa) >= 0, \
SOATAG_ACTIVE_CHAT(soa_is_chat_active(soa)))
#define \
NH_REMOTE_MEDIA_TAGS(include, soa) \
TAG_IF((include) && (soa) && soa_is_remote_audio_active(soa) >= 0, \
SOATAG_ACTIVE_AUDIO(soa_is_remote_audio_active(soa))), \
TAG_IF((include) && (soa) && soa_is_remote_video_active(soa) >= 0, \
SOATAG_ACTIVE_VIDEO(soa_is_remote_video_active(soa))), \
TAG_IF((include) && (soa) && soa_is_remote_image_active(soa) >= 0, \
SOATAG_ACTIVE_IMAGE(soa_is_remote_image_active(soa))), \
TAG_IF((include) && (soa) && soa_is_remote_chat_active(soa) >= 0, \
SOATAG_ACTIVE_CHAT(soa_is_remote_chat_active(soa)))
#if HAVE_NUA_HANDLE_DEBUG
#define nua_handle_ref(nh) nua_handle_ref_by((nh), __func__)
#define nua_handle_unref(nh) nua_handle_unref_by((nh), __func__)
su_inline nua_handle_t *nua_handle_ref_by(nua_handle_t *nh,
char const *by)
{
if (nh)
SU_DEBUG_0(("nua_handle_ref(%p) => "MOD_ZU" by %s\n", nh,
su_home_refcount((su_home_t *)nh) + 1,
by));
return (nua_handle_t *)su_home_ref((su_home_t *)nh);
}
su_inline int nua_handle_unref_by(nua_handle_t *nh, char const *by)
{
if (nh) {
size_t refcount = su_home_refcount((su_home_t *)nh) - 1;
int freed = su_home_unref((su_home_t *)nh);
if (freed) refcount = 0;
SU_DEBUG_0(("nua_handle_unref(%p) => "MOD_ZU" by %s\n",
nh, refcount, by));
return freed;
}
return 0;
}
#endif
/** @internal @brief 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; /**< Cookie */
#define nua_valid_handle_cookie ((void *)(intptr_t)nua_handle)
nua_hmagic_t *nh_magic; /**< Application context */
tagi_t *nh_tags; /**< Initial tags */
tagi_t *nh_ptags; /**< Initial parameters */
nua_handle_t *nh_identity; /**< Identity */
nua_handle_preferences_t *nh_prefs; /**< Preferences */
/* Handle type is determined by special event and flags. */
nua_event_t nh_special; /**< Special event */
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 */
/* Call status */
unsigned nh_active_call:1;
unsigned nh_hold_remote:1;
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 */
unsigned :0;
nua_dialog_state_t nh_ds[1];
auth_client_t *nh_auth; /**< Authorization objects */
soa_session_t *nh_soa; /**< Media session */
struct nua_referral {
nua_handle_t *ref_handle; /**< Referring handle */
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 == nua_valid_handle_cookie)
#define NH_STATUS(nh) \
(nh)->nh_status, \
(nh)->nh_phrase, \
SIPTAG_WARNING_STR(nh->nh_warning)
#define NH_IS_DEFAULT(nh) ((nh) == (nh)->nh_nua->nua_handles)
su_inline
int nh_is_special(nua_handle_t *nh)
{
return nh == NULL || nh->nh_special;
}
typedef struct nua_event_frame_s nua_event_frame_t;
extern char const nua_internal_error[];
#define NUA_INTERNAL_ERROR 900, nua_internal_error
#define NUA_ERROR_AT(file, line) 900, "Internal error at " file ":" #line
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;
su_network_changed_t *nua_nw_changed;
nua_callback_f nua_callback;
nua_magic_t *nua_magic;
nua_event_frame_t *nua_current;
nua_saved_event_t nua_signal[1];
/* Engine state flags */
unsigned nua_shutdown_started:1; /**< Shutdown initiated */
unsigned nua_shutdown_final:1; /**< Shutdown is complete */
unsigned nua_from_is_set;
unsigned :0;
/**< Used by stop-and-wait args calls */
tagi_t const *nua_args;
/**< Local SIP address. Contents are kept around for ever. */
sip_from_t nua_from[1];
/* Protocol (server) side */
nua_registration_t *nua_registrations; /**< Active registrations */
/* Constants */
sip_accept_t *nua_invite_accept; /* What we accept for invite */
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;
/* User-agent parameters */
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;
};
#define nua_dhandle nua_handles
#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))
#define __func__ __FUNCTION__
#else
#define enter ((void)0)
#define nh_enter ((void)0)
#define __func__ "nua"
#endif
su_inline nua_t *nua_stack_ref(nua_t *nua)
{
return (nua_t *)su_home_ref(nua->nua_home);
}
su_inline void nua_stack_unref(nua_t *nua)
{
su_home_unref(nua->nua_home);
}
/* Internal prototypes */
int nua_stack_init(su_root_t *root, nua_t *nua);
void nua_stack_deinit(su_root_t *root, nua_t *nua);
int nua_stack_init_transport(nua_t *nua, tagi_t const *tags);
int nua_stack_init_registrations(nua_t *nua);
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);
sip_contact_t const *nua_registration_contact(nua_registration_t const *nr);
int nua_registration_process_request(nua_registration_t *nr,
nta_incoming_t *irq,
sip_t const *sip);
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 *);
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]);
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_prack,
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, NULL)
#define UA_EVENT2(e, status, phrase) \
nua_stack_event(nua, nh, NULL, e, status, phrase, NULL)
#define UA_EVENT3(e, status, phrase, tag) \
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, ...);
int nua_stack_event(nua_t *nua, nua_handle_t *nh, msg_t *msg,
nua_event_t event, int status, char const *phrase,
tagi_t const *tags);
void nua_move_event(nua_saved_event_t a[1], nua_saved_event_t b[1]);
nua_handle_t *nh_create_handle(nua_t *nua, nua_hmagic_t *hmagic, tagi_t *tags);
nua_handle_t *nua_stack_incoming_handle(nua_t *nua,
nta_incoming_t *irq,
sip_t const *sip,
int create_dialog);
int nua_stack_init_handle(nua_t *nua, nua_handle_t *nh, tagi_t const *tags);
enum nh_kind {
nh_has_nothing,
nh_has_invite,
nh_has_subscribe,
nh_has_notify,
nh_has_register,
nh_has_streaming
};
int nua_stack_set_handle_special(nua_handle_t *nh,
enum nh_kind kind,
nua_event_t special);
int nua_handle_save_tags(nua_handle_t *h, tagi_t *tags);
void nh_destroy(nua_t *nua, nua_handle_t *nh);
nua_handle_t *nh_validate(nua_t *nua, nua_handle_t *maybe);
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);
/* ---------------------------------------------------------------------- */
int nua_stack_set_defaults(nua_handle_t *nh, nua_handle_preferences_t *nhp);
int nua_stack_set_from(nua_t *, int initial, tagi_t const *tags);
int nua_stack_init_instance(nua_handle_t *nh, tagi_t const *tags);
int nua_stack_process_request(nua_handle_t *nh,
nta_leg_t *leg,
nta_incoming_t *irq,
sip_t const *sip);
int nua_stack_launch_network_change_detector(nua_t *nua);
sip_contact_t const *nua_stack_get_contact(nua_registration_t const *nr);
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);
/* ---------------------------------------------------------------------- */
#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;
/* ---------------------------------------------------------------------- */
typedef unsigned longlong ull;
#define SET_STATUS(_status, _phrase) status = _status, phrase = _phrase
#define SET_STATUS2(_status, _phrase) status = _status, phrase = _phrase
/* 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 */
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, ...);
SOFIA_END_DECLS
#endif /* NUA_STACK_H */
View Git Blame Copy Permalink