CoreSession Class Reference

#include <switch_cpp.h>

Collaboration diagram for CoreSession:

Public Member Functions
	CoreSession ()
	CoreSession (char *nuuid, CoreSession *a_leg=NULL)
	CoreSession (switch_core_session_t *new_session)
virtual	~ CoreSession ()
int	insertFile (const char *file, const char *insert_file, int sample_point)
int	answer ()
int	print (char *txt)
int	preAnswer ()
void	hangup (const char *cause="normal_clearing")
void	hangupState (void)
void	setVariable (char *var, char *val)
void	setPrivate (char *var, void *val)
void *	getPrivate (char *var)
const char *	getVariable (char *var)
switch_status_t	process_callback_result (char *result)
void	say (const char *tosay, const char *module_name, const char *say_type, const char *say_method, const char *say_gender=NULL)
void	sayPhrase (const char *phrase_name, const char *phrase_data="", const char *phrase_lang=NULL)
const char *	hangupCause ()
const char *	getState ()
int	recordFile (char *file_name, int time_limit=0, int silence_threshold=0, int silence_hits=0)
	Record to a file. More...
int	originate (CoreSession *a_leg_session, char *dest, int timeout=60, switch_state_handler_table_t *handlers=NULL)
	Set attributes of caller data for purposes of outgoing calls. More...
virtual void	destroy (void)
void	setDTMFCallback (void *cbfunc, char *funcargs)
	set a DTMF callback function More...
int	speak (char *text)
void	set_tts_parms (char *tts_name, char *voice_name)
void	set_tts_params (char *tts_name, char *voice_name)
int	collectDigits (int abs_timeout)
int	collectDigits (int digit_timeout, int abs_timeout)
char *	getDigits (int maxdigits, char *terminators, int timeout)
char *	getDigits (int maxdigits, char *terminators, int timeout, int interdigit)
char *	getDigits (int maxdigits, char *terminators, int timeout, int interdigit, int abstimeout)
int	transfer (char *extension, char *dialplan=NULL, char *context=NULL)
char *	read (int min_digits, int max_digits, const char *prompt_audio_file, int timeout, const char *valid_terminators, int digit_timeout=0)
void	detectSpeech (char *arg0, char *arg1=NULL, char *arg2=NULL, char *arg3=NULL)
char *	playAndGetDigits (int min_digits, int max_digits, int max_tries, int timeout, char *terminators, char *audio_files, char *bad_input_audio_files, char *digits_regex, const char *var_name=NULL, int digit_timeout=0, const char *transfer_on_failure=NULL)
	Play a file into channel and collect dtmfs. More...
char *	playAndDetectSpeech (char *file, char *engine, char *grammar)
	Play a file and detect speech See API docs switch_ivr_play_and_detect_speech(...) More...
int	streamFile (char *file, int starting_sample_count=0)
	Play a file that resides on disk into the channel. More...
int	sleep (int ms, int sync=0)
int	flushEvents ()
	flush any pending events More...
int	flushDigits ()
	flush any pending digits More...
int	setAutoHangup (bool val)
void	setHangupHook (void *hangup_func)
	Set the hangup callback function. More...
bool	ready ()
bool	bridged ()
bool	answered ()
bool	mediaReady ()
void	waitForAnswer (CoreSession *calling_session)
void	execute (const char *app, const char *data=NULL)
void	sendEvent (Event *sendME)
void	setEventData (Event *e)
char *	getXMLCDR ()
virtual bool	begin_allow_threads ()=0
virtual bool	end_allow_threads ()=0
const char *	get_uuid () const
	Get the uuid of this session. More...
const switch_input_args_t &	get_cb_args () const
	Get the callback function arguments associated with this session. More...
virtual void	check_hangup_hook ()=0
	Callback to the language specific hangup callback. More...
virtual switch_status_t	run_dtmf_callback (void *input, switch_input_type_t itype)=0
void	consoleLog (char *level_str, char *msg)
void	consoleLog2 (char *level_str, char *file, char *func, int line, char *msg)

Data Fields
switch_core_session_t *	session
switch_channel_t *	channel
unsigned int	flags
int	allocated
input_callback_state	cb_state
switch_channel_state_t	hook_state
switch_call_cause_t	cause
char *	uuid
char *	tts_name
char *	voice_name

Protected Member Functions
void	store_file_handle (switch_file_handle_t *fh)

Protected Attributes
switch_input_args_t	args
switch_input_args_t *	ap
char *	xml_cdr_text
void *	on_hangup
switch_file_handle_t *	fhp
char	dtmf_buf [512]

Detailed Description

Definition at line 206 of file switch_cpp.h.

Constructor & Destructor Documentation

CoreSession() [1/3]

CoreSession::CoreSession

(

)

Definition at line 620 of file switch_cpp.cpp.

References init_vars.

{
        init_vars();
}

CoreSession() [2/3]

CoreSession::CoreSession	(	char *	nuuid,
		CoreSession *	a_leg = NULL
	)

Definition at line 625 of file switch_cpp.cpp.

References CS_SOFT_EXECUTE, init_vars, S_HUP, session, SOF_NONE, SWITCH_CAUSE_DESTINATION_OUT_OF_ORDER, switch_channel_set_state, switch_channel_wait_for_state(), switch_core_session_force_locate, switch_core_session_get_channel(), switch_core_session_get_uuid(), switch_ivr_originate(), switch_set_flag, and SWITCH_STATUS_SUCCESS.

{
        switch_channel_t *other_channel = NULL;

        init_vars();

        if (a_leg && a_leg->session) {
                other_channel = switch_core_session_get_channel(a_leg->session);
        }

        if (!strchr(nuuid, '/') && (session = switch_core_session_force_locate(nuuid))) {
                uuid = strdup(nuuid);
                channel = switch_core_session_get_channel(session);
                allocated = 1;
    } else {
                cause = SWITCH_CAUSE_DESTINATION_OUT_OF_ORDER;
                if (switch_ivr_originate(a_leg ? a_leg->session : NULL, &session, &cause, nuuid, 60, NULL, NULL, NULL, NULL, NULL, SOF_NONE, NULL, NULL)
                        == SWITCH_STATUS_SUCCESS) {
                        channel = switch_core_session_get_channel(session);
                        allocated = 1;
                        switch_set_flag(this, S_HUP);
                        uuid = strdup(switch_core_session_get_uuid(session));
                        switch_channel_set_state(switch_core_session_get_channel(session), CS_SOFT_EXECUTE);
                        switch_channel_wait_for_state(channel, other_channel, CS_SOFT_EXECUTE);
                }
        }
}

CoreSession() [3/3]

CoreSession::CoreSession

(

switch_core_session_t *

new_session

)

Definition at line 653 of file switch_cpp.cpp.

References init_vars, switch_core_session_get_channel(), switch_core_session_get_uuid(), switch_core_session_read_lock_hangup(), SWITCH_DECLARE_CONSTRUCTOR, SWITCH_STATUS_SUCCESS, and this_check_void.

{
        init_vars();

        if (new_session && switch_core_session_read_lock_hangup(new_session) == SWITCH_STATUS_SUCCESS) {
                session = new_session;
                channel = switch_core_session_get_channel(session);
                allocated = 1;
                uuid = strdup(switch_core_session_get_uuid(session));
        }
}

~ CoreSession()

virtual CoreSession::~ CoreSession ( )

virtual

Member Function Documentation

answer()

int CoreSession::answer

(

)

Definition at line 699 of file switch_cpp.cpp.

References sanity_check, switch_channel_answer, SWITCH_STATUS_SUCCESS, and this_check.

{
    switch_status_t status;
        this_check(-1);
        sanity_check(-1);
    status = switch_channel_answer(channel);
    return status == SWITCH_STATUS_SUCCESS ? 1 : 0;
}

answered()

bool CoreSession::answered

(

)

Definition at line 1182 of file switch_cpp.cpp.

References CF_ANSWERED, sanity_check, switch_channel_test_flag(), and this_check.

                                           {

        this_check(false);
        sanity_check(false);
        return switch_channel_test_flag(channel, CF_ANSWERED) != 0;
}

begin_allow_threads()

virtual bool CoreSession::begin_allow_threads ( )

pure virtual

Referenced by bridge(), and originate().

bridged()

bool CoreSession::bridged

(

)

Definition at line 1163 of file switch_cpp.cpp.

References CF_BRIDGED, sanity_check, switch_channel_test_flag(), switch_channel_up, and this_check.

                                          {

        this_check(false);

        if (!session) {
                return false;
        }
        sanity_check(false);

        return (switch_channel_up(channel) && switch_channel_test_flag(channel, CF_BRIDGED));
}

check_hangup_hook()

virtual void CoreSession::check_hangup_hook ( )

pure virtual

Callback to the language specific hangup callback.

Referenced by hanguphook().

collectDigits() [1/2]

int CoreSession::collectDigits

(

int

abs_timeout

)

For timeout milliseconds, call the dtmf function set previously by setDTMFCallback whenever a dtmf or event is received

Definition at line 881 of file switch_cpp.cpp.

                                                              {
        return collectDigits(0, abs_timeout);
}

collectDigits() [2/2]

int CoreSession::collectDigits	(	int	digit_timeout,
		int	abs_timeout
	)

Definition at line 885 of file switch_cpp.cpp.

References sanity_check, switch_ivr_collect_digits_callback(), SWITCH_STATUS_SUCCESS, and this_check.

                                                                                 {
        this_check(-1);
        sanity_check(-1);
    begin_allow_threads();
        switch_ivr_collect_digits_callback(session, ap, digit_timeout, abs_timeout);
    end_allow_threads();
    return SWITCH_STATUS_SUCCESS;
}

consoleLog()

void CoreSession::consoleLog	(	char *	level_str,
		char *	msg
	)

Definition at line 1384 of file switch_cpp.cpp.

References SWITCH_CHANNEL_SESSION_LOG, SWITCH_LOG_DEBUG, SWITCH_LOG_INVALID, switch_log_printf(), switch_log_str2level(), and switch_str_nil.

{
        switch_log_level_t level = SWITCH_LOG_DEBUG;
        if (level_str) {
                level = switch_log_str2level(level_str);
                if (level == SWITCH_LOG_INVALID) {
                        level = SWITCH_LOG_DEBUG;
                }
        }
        switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), level, "%s", switch_str_nil(msg));
}

consoleLog2()

void CoreSession::consoleLog2	(	char *	level_str,
		char *	file,
		char *	func,
		int	line,
		char *	msg
	)

Definition at line 1396 of file switch_cpp.cpp.

References SWITCH_CHANNEL_ID_SESSION, SWITCH_LOG_DEBUG, SWITCH_LOG_INVALID, switch_log_printf(), switch_log_str2level(), and switch_str_nil.

{
        switch_log_level_t level = SWITCH_LOG_DEBUG;
        if (level_str) {
                level = switch_log_str2level(level_str);
                if (level == SWITCH_LOG_INVALID) {
                        level = SWITCH_LOG_DEBUG;
                }
        }
    switch_log_printf(SWITCH_CHANNEL_ID_SESSION, file, func, line, (const char*)session,
                                          level, "%s", switch_str_nil(msg));
}

destroy()

void CoreSession::destroy ( void  )

virtual

Definition at line 1189 of file switch_cpp.cpp.

References CF_TRANSFER, init_vars, S_HUP, SWITCH_CAUSE_NORMAL_CLEARING, switch_channel_get_name(), switch_channel_hangup, SWITCH_CHANNEL_SESSION_LOG, switch_channel_set_private(), switch_channel_test_flag(), switch_channel_up, switch_core_session_get_channel(), switch_core_session_rwunlock(), SWITCH_LOG_DEBUG, switch_log_printf(), switch_safe_free, switch_test_flag, and this_check_void.

{
        this_check_void();

        if (!allocated) {
                return;
        }

        allocated = 0;

        switch_safe_free(xml_cdr_text);
        switch_safe_free(uuid);
        switch_safe_free(tts_name);
        switch_safe_free(voice_name);

        if (session) {
                if (!channel) {
                        channel = switch_core_session_get_channel(session);
                }

                if (channel) {
                        switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_DEBUG,
                                                          "%s destroy/unlink session from object\n", switch_channel_get_name(channel));
                        switch_channel_set_private(channel, "CoreSession", NULL);
                        if (switch_channel_up(channel) && switch_test_flag(this, S_HUP) && !switch_channel_test_flag(channel, CF_TRANSFER)) {
                                switch_channel_hangup(channel, SWITCH_CAUSE_NORMAL_CLEARING);
                        }
                }

        switch_core_session_rwunlock(session);
                session = NULL;
                channel = NULL;
    }

        init_vars();

}

detectSpeech()

void CoreSession::detectSpeech	(	char *	arg0,
		char *	arg1 = NULL,
		char *	arg2 = NULL,
		char *	arg3 = NULL
	)

Definition at line 1010 of file switch_cpp.cpp.

References sanity_check_noreturn, SWITCH_CHANNEL_LOG, switch_ivr_detect_speech(), switch_ivr_detect_speech_disable_all_grammars(), switch_ivr_detect_speech_disable_grammar(), switch_ivr_detect_speech_enable_grammar(), switch_ivr_detect_speech_init(), switch_ivr_detect_speech_load_grammar(), switch_ivr_detect_speech_start_input_timers(), switch_ivr_detect_speech_unload_grammar(), switch_ivr_pause_detect_speech(), switch_ivr_resume_detect_speech(), switch_ivr_set_param_detect_speech(), switch_ivr_stop_detect_speech(), switch_log_printf(), SWITCH_LOG_WARNING, and this_check_void.

{
        this_check_void();
        sanity_check_noreturn;

        begin_allow_threads();

        if (!arg0) return;

        if (!strcasecmp(arg0, "grammar") && arg1 && arg2) {
                switch_ivr_detect_speech_load_grammar(session, arg1, arg2);
        } else if (!strcasecmp(arg0, "nogrammar") && arg1) {
                switch_ivr_detect_speech_unload_grammar(session, arg1);
        } else if (!strcasecmp(arg0, "grammaron") && arg1) {
                switch_ivr_detect_speech_enable_grammar(session, arg1);
        } else if (!strcasecmp(arg0, "grammaroff") && arg1) {
                switch_ivr_detect_speech_disable_grammar(session, arg1);
        } else if (!strcasecmp(arg0, "grammarsalloff")) {
                switch_ivr_detect_speech_disable_all_grammars(session);
        } else if (!strcasecmp(arg0, "init") && arg1 && arg2) {
                switch_ivr_detect_speech_init(session, arg1, arg2, NULL);
        } else if (!strcasecmp(arg0, "pause")) {
                switch_ivr_pause_detect_speech(session);
        } else if (!strcasecmp(arg0, "resume")) {
                switch_ivr_resume_detect_speech(session);
        } else if (!strcasecmp(arg0, "stop")) {
                switch_ivr_stop_detect_speech(session);
        } else if (!strcasecmp(arg0, "param") && arg1 && arg2) {
                switch_ivr_set_param_detect_speech(session, arg1, arg2);
        } else if (!strcasecmp(arg0, "start-input-timers")) {
                switch_ivr_detect_speech_start_input_timers(session);
        } else if (!strcasecmp(arg0, "start_input_timers")) {
                switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_WARNING, "start_input_timers is deprecated, please use start-input-timers instead!\n");
                switch_ivr_detect_speech_start_input_timers(session);
        } else if (arg1 && arg2 && arg3) {
                switch_ivr_detect_speech(session, arg0, arg1, arg2, arg3, NULL);
        }

        end_allow_threads();
}

end_allow_threads()

virtual bool CoreSession::end_allow_threads ( )

pure virtual

Referenced by bridge(), and originate().

execute()

void CoreSession::execute	(	const char *	app,
		const char *	data = NULL
	)

Definition at line 785 of file switch_cpp.cpp.

References sanity_check_noreturn, SWITCH_CHANNEL_SESSION_LOG, switch_core_session_execute_application, SWITCH_LOG_ERROR, switch_log_printf(), this_check_void, and zstr.

{
        this_check_void();
        sanity_check_noreturn;

        if (zstr(app)) {
                switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_ERROR, "No application specified\n");
                return;
        }

        begin_allow_threads();
        switch_core_session_execute_application(session, app, data);
        end_allow_threads();
}

flushDigits()

int CoreSession::flushDigits

(

)

flush any pending digits

Definition at line 1337 of file switch_cpp.cpp.

References sanity_check, switch_channel_flush_dtmf(), switch_core_session_get_channel(), SWITCH_STATUS_SUCCESS, and this_check.

{
        this_check(-1);
        sanity_check(-1);
        switch_channel_flush_dtmf(switch_core_session_get_channel(session));
        return SWITCH_STATUS_SUCCESS;
}

flushEvents()

int CoreSession::flushEvents

(

)

flush any pending events

Definition at line 1320 of file switch_cpp.cpp.

References sanity_check, switch_core_session_dequeue_event(), switch_event_destroy(), SWITCH_STATUS_FALSE, SWITCH_STATUS_SUCCESS, SWITCH_TRUE, and this_check.

{
        switch_event_t *event;

        this_check(-1);
        sanity_check(-1);

        if (!session) {
                return SWITCH_STATUS_FALSE;
        }

        while (switch_core_session_dequeue_event(session, &event, SWITCH_TRUE) == SWITCH_STATUS_SUCCESS) {
                switch_event_destroy(&event);
        }
        return SWITCH_STATUS_SUCCESS;
}

get_cb_args()

const switch_input_args_t& CoreSession::get_cb_args ( ) const

inline

Get the callback function arguments associated with this session.

Returns

a const reference to the callback function arguments

Definition at line 400 of file switch_cpp.h.

References bridge(), buf, buflen, console_clean_log(), console_log(), console_log2(), consoleLog(), consoleLog2(), dtmf_callback(), hanguphook(), SWITCH_DECLARE, SWITCH_DECLARE_NONSTD, and switch_msleep().

Referenced by bridge().

                                                                {
                         return args;
                 };

get_uuid()

const char* CoreSession::get_uuid ( ) const

inline

Get the uuid of this session.

Returns

the uuid of this session

Definition at line 393 of file switch_cpp.h.

                                              {
                         return uuid ? uuid : (char *) "uninitialized";
                 };

getDigits() [1/3]

char * CoreSession::getDigits	(	int	maxdigits,
		char *	terminators,
		int	timeout
	)

Collect up to maxdigits digits worth of digits and store them in dtmf_buf. In the case of mod_python, the dtmf_buf parameter is configured to act as a return value, (see mod_python.i). This does NOT call any callbacks upon receiving dtmf digits. For that, use collectDigits.

Definition at line 894 of file switch_cpp.cpp.

{
    return getDigits(maxdigits, terminators, timeout, 0);
}

getDigits() [2/3]

char * CoreSession::getDigits	(	int	maxdigits,
		char *	terminators,
		int	timeout,
		int	interdigit
	)

Definition at line 899 of file switch_cpp.cpp.

{
    return getDigits(maxdigits, terminators, timeout, interdigit, 0);
}

getDigits() [3/3]

char * CoreSession::getDigits	(	int	maxdigits,
		char *	terminators,
		int	timeout,
		int	interdigit,
		int	abstimeout
	)

Definition at line 904 of file switch_cpp.cpp.

References memset(), sanity_check, SWITCH_CHANNEL_SESSION_LOG, switch_channel_var_true(), switch_core_session_get_channel(), switch_ivr_collect_digits_count(), SWITCH_LOG_DEBUG, switch_log_printf(), SWITCH_SENSITIVE_DTMF_VARIABLE, and this_check.

{
        this_check((char *)"");
        sanity_check((char *)"");
        begin_allow_threads();
        char terminator;

        memset(dtmf_buf, 0, sizeof(dtmf_buf));
        switch_ivr_collect_digits_count(session,
                                                                        dtmf_buf,
                                                                        sizeof(dtmf_buf),
                                                                        maxdigits,
                                                                        terminators,
                                                                        &terminator,
                                                                        (uint32_t) timeout, (uint32_t)interdigit, (uint32_t)abstimeout);
                                                                        
        /* Only log DTMF buffer if sensitive_dtmf channel variable not set to true */
        if (!(switch_channel_var_true(switch_core_session_get_channel(session), SWITCH_SENSITIVE_DTMF_VARIABLE))) {
                switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_DEBUG, "getDigits dtmf_buf: %s\n", dtmf_buf);
        }
        
        end_allow_threads();
        return dtmf_buf;
}

getPrivate()

void * CoreSession::getPrivate

(

char *

var

)

Definition at line 763 of file switch_cpp.cpp.

References sanity_check, switch_channel_get_private(), and this_check.

{
        this_check(NULL);
        sanity_check(NULL);
    return switch_channel_get_private(channel, var);
}

getState()

const char * CoreSession::getState

(

)

Definition at line 1233 of file switch_cpp.cpp.

References switch_channel_get_state(), switch_channel_state_name(), and this_check.

{
        this_check(NULL);

        if (channel) {
                return switch_channel_state_name(switch_channel_get_state(channel));
        }

        return "ERROR";

}

getVariable()

const char * CoreSession::getVariable

(

char *

var

)

Definition at line 778 of file switch_cpp.cpp.

References sanity_check, switch_channel_get_variable, and this_check.

{
        this_check("");
        sanity_check("");
    return switch_channel_get_variable(channel, var);
}

getXMLCDR()

char * CoreSession::getXMLCDR

(

)

Definition at line 671 of file switch_cpp.cpp.

References sanity_check, SWITCH_FALSE, switch_ivr_generate_xml_cdr(), switch_safe_free, SWITCH_STATUS_SUCCESS, switch_xml_free(), switch_xml_toxml, and this_check.

{

        switch_xml_t cdr = NULL;

        this_check((char *)"");
        sanity_check((char *)"");

        switch_safe_free(xml_cdr_text);

        if (switch_ivr_generate_xml_cdr(session, &cdr) == SWITCH_STATUS_SUCCESS) {
                xml_cdr_text = switch_xml_toxml(cdr, SWITCH_FALSE);
                switch_xml_free(cdr);
        }

        return (char *) (xml_cdr_text ? xml_cdr_text : "");
}

hangup()

void CoreSession::hangup

(

const char *

cause = "normal_clearing"

)

Definition at line 746 of file switch_cpp.cpp.

References sanity_check_noreturn, switch_channel_hangup, SWITCH_CHANNEL_SESSION_LOG, switch_channel_str2cause(), SWITCH_LOG_DEBUG, switch_log_printf(), and this_check_void.

{
        this_check_void();
        sanity_check_noreturn;
    switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_DEBUG, "CoreSession::hangup\n");
        this->begin_allow_threads();
    switch_channel_hangup(channel, switch_channel_str2cause(cause));
        this->end_allow_threads();
}

hangupCause()

const char * CoreSession::hangupCause

(

)

Definition at line 1227 of file switch_cpp.cpp.

References switch_channel_cause2str(), and this_check.

{
        this_check(NULL);
        return switch_channel_cause2str(cause);
}

hangupState()

void CoreSession::hangupState

(

void

)

Definition at line 736 of file switch_cpp.cpp.

References sanity_check_noreturn, switch_channel_down, switch_core_session_hangup_state(), and SWITCH_FALSE.

{
        sanity_check_noreturn;
        this->begin_allow_threads();
        if (switch_channel_down(channel)) {
                switch_core_session_hangup_state(session, SWITCH_FALSE);
        }
        this->end_allow_threads();
}

insertFile()

int CoreSession::insertFile	(	const char *	file,
		const char *	insert_file,
		int	sample_point
	)

Definition at line 718 of file switch_cpp.cpp.

References sanity_check, switch_ivr_insert_file(), SWITCH_STATUS_SUCCESS, and this_check.

{
    switch_status_t status;
        this_check(-1);
        sanity_check(-1);
    status = switch_ivr_insert_file(session, file, insert_file, (switch_size_t)sample_point);
    return status == SWITCH_STATUS_SUCCESS ? 1 : 0;
}

mediaReady()

bool CoreSession::mediaReady

(

)

Definition at line 1175 of file switch_cpp.cpp.

References sanity_check, switch_channel_media_ready, and this_check.

                                             {

        this_check(false);
        sanity_check(false);
        return switch_channel_media_ready(channel) != 0;
}

originate()

int CoreSession::originate	(	CoreSession *	a_leg_session,
		char *	dest,
		int	timeout = 60,
		switch_state_handler_table_t *	handlers = NULL
	)

Set attributes of caller data for purposes of outgoing calls.

Parameters

var	- the variable name, eg, "caller_id_name"
val	- the data to set, eg, "bob"Originate a call to a destination
a_leg_session	- the session where the call is originating from and also the session in which this session was created
dest	- a string representing destination, eg, sofia/mydomain.com/foo@bar.com
timeout	- time to wait for call to be answered

Returns

an int status code indicating success or failure

Definition at line 1245 of file switch_cpp.cpp.

References begin_allow_threads(), CS_SOFT_EXECUTE, end_allow_threads(), session, SOF_NONE, SWITCH_CAUSE_DESTINATION_OUT_OF_ORDER, SWITCH_CHANNEL_LOG, switch_channel_set_state, switch_core_session_get_channel(), switch_core_session_get_uuid(), switch_ivr_originate(), switch_log_printf(), SWITCH_LOG_WARNING, switch_safe_free, SWITCH_STATUS_FALSE, SWITCH_STATUS_SUCCESS, and this_check.

{

        switch_core_session_t *aleg_core_session = NULL;

        this_check(0);

        cause = SWITCH_CAUSE_DESTINATION_OUT_OF_ORDER;

        if (a_leg_session != NULL) {
                aleg_core_session = a_leg_session->session;
        }

        // this session has no valid switch_core_session_t at this point, and therefore
        // no valid channel.  since the threadstate is stored in the channel, and there
        // is none, if we try to call begin_alllow_threads it will fail miserably.
        // use the 'a leg session' to do the thread swapping stuff.
    if (a_leg_session) a_leg_session->begin_allow_threads();

        if (switch_ivr_originate(aleg_core_session,
                                                         &session,
                                                         &cause,
                                                         dest,
                                                         timeout,
                                                         handlers,
                                                         NULL,
                                                         NULL,
                                                         NULL,
                                                         NULL,
                                                         SOF_NONE,
                                                         NULL,
                                                         NULL) != SWITCH_STATUS_SUCCESS) {
                switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_WARNING, "Error Creating Outgoing Channel! [%s]\n", dest);
                goto failed;

        }

    if (a_leg_session) a_leg_session->end_allow_threads();
        channel = switch_core_session_get_channel(session);
        allocated = 1;
        switch_safe_free(uuid);
        uuid = strdup(switch_core_session_get_uuid(session));
        switch_channel_set_state(switch_core_session_get_channel(session), CS_SOFT_EXECUTE);

        return SWITCH_STATUS_SUCCESS;

 failed:
    if (a_leg_session) a_leg_session->end_allow_threads();
        return SWITCH_STATUS_FALSE;
}

playAndDetectSpeech()

char * CoreSession::playAndDetectSpeech	(	char *	file,
		char *	engine,
		char *	grammar
	)

Play a file and detect speech See API docs switch_ivr_play_and_detect_speech(...)

Definition at line 1051 of file switch_cpp.cpp.

References sanity_check, SWITCH_CHANNEL_SESSION_LOG, switch_ivr_play_and_detect_speech(), SWITCH_LOG_ERROR, switch_log_printf(), SWITCH_STATUS_GENERR, SWITCH_STATUS_NOT_INITALIZED, SWITCH_STATUS_SUCCESS, and this_check.

{
        sanity_check((char *)"");
        this_check((char *)"");
        begin_allow_threads();

        char *result = NULL;

        switch_status_t status = switch_ivr_play_and_detect_speech(session, file, engine, grammar, &result, 0, ap);
        if (status == SWITCH_STATUS_SUCCESS) {
                // good
        } else if (status == SWITCH_STATUS_GENERR) {
                switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_ERROR, "GRAMMAR ERROR\n");
        } else if (status == SWITCH_STATUS_NOT_INITALIZED) {
                switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_ERROR, "ASR INIT ERROR\n");
        } else {
                switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_ERROR, "ERROR status = %d\n", status);
        }

        end_allow_threads();

        return result ? strdup(result) : NULL; // remeber to free me
}

playAndGetDigits()

char * CoreSession::playAndGetDigits	(	int	min_digits,
		int	max_digits,
		int	max_tries,
		int	timeout,
		char *	terminators,
		char *	audio_files,
		char *	bad_input_audio_files,
		char *	digits_regex,
		const char *	var_name = NULL,
		int	digit_timeout = 0,
		const char *	transfer_on_failure = NULL
	)

Play a file into channel and collect dtmfs.

See API docs in switch_ivr.h: switch_play_and_get_digits(..)

NOTE: this does not call any dtmf callbacks set by setDTMFCallback(..) as it uses its own internal callback handler.

Definition at line 975 of file switch_cpp.cpp.

References memset(), sanity_check, switch_play_and_get_digits(), and this_check.

{
        sanity_check((char *)"");
        this_check((char *)"");
        begin_allow_threads();
        memset(dtmf_buf, 0, sizeof(dtmf_buf));
        switch_play_and_get_digits( session,
                                                                (uint32_t) min_digits,
                                                                (uint32_t) max_digits,
                                                                (uint32_t) max_tries,
                                                                (uint32_t) timeout,
                                                                terminators,
                                                                audio_files,
                                                                bad_input_audio_files,
                                                                var_name,
                                                                dtmf_buf,
                                                                sizeof(dtmf_buf),
                                                                digits_regex,
                                                                (uint32_t) digit_timeout,
                                                                transfer_on_failure);

        end_allow_threads();
        return dtmf_buf;
}

preAnswer()

int CoreSession::preAnswer

(

)

Definition at line 727 of file switch_cpp.cpp.

References sanity_check, switch_channel_pre_answer, SWITCH_STATUS_SUCCESS, and this_check.

{
    switch_status_t status;
        this_check(-1);
        sanity_check(-1);
    status = switch_channel_pre_answer(channel);
    return status == SWITCH_STATUS_SUCCESS ? 1 : 0;
}

print()

int CoreSession::print

(

char *

txt

)

Definition at line 709 of file switch_cpp.cpp.

References sanity_check, switch_core_session_print(), SWITCH_STATUS_SUCCESS, switch_str_nil, and this_check.

{
    switch_status_t status;
        status = switch_core_session_print(session, switch_str_nil(txt));
        this_check(-1);
        sanity_check(-1);
    return status == SWITCH_STATUS_SUCCESS ? 1 : 0;
}

process_callback_result()

switch_status_t CoreSession::process_callback_result

(

char *

result

)

Definition at line 1576 of file switch_cpp.cpp.

References sanity_check, switch_ivr_process_fh(), SWITCH_STATUS_FALSE, and this_check.

{

        this_check(SWITCH_STATUS_FALSE);
        sanity_check(SWITCH_STATUS_FALSE);

        return switch_ivr_process_fh(session, result, fhp);
}

read()

char * CoreSession::read	(	int	min_digits,
		int	max_digits,
		const char *	prompt_audio_file,
		int	timeout,
		const char *	valid_terminators,
		int	digit_timeout = 0
	)

Definition at line 946 of file switch_cpp.cpp.

References sanity_check, switch_ivr_read(), and this_check.

{
        this_check((char *)"");
        sanity_check((char *)"");
        if (min_digits < 1) {
                min_digits = 1;
        }

        if (max_digits < 1) {
                max_digits = 1;
        }

        if (timeout < 1) {
                timeout = 1;
        }

    begin_allow_threads();
        switch_ivr_read(session, min_digits, max_digits, prompt_audio_file, NULL, dtmf_buf,
                                        sizeof(dtmf_buf), timeout, valid_terminators, (uint32_t)digit_timeout);
    end_allow_threads();

        return dtmf_buf;
}

ready()

bool CoreSession::ready

(

)

Definition at line 1150 of file switch_cpp.cpp.

References sanity_check, switch_channel_ready, and this_check.

                                        {

        this_check(false);

        if (!session) {
                return false;
        }
        sanity_check(false);

        return switch_channel_ready(channel) != 0;
}

recordFile()

int CoreSession::recordFile	(	char *	file_name,
		int	time_limit = 0,
		int	silence_threshold = 0,
		int	silence_hits = 0
	)

Record to a file.

Parameters

file_name
<[max_len]>	maximum length of the recording in seconds
<[silence_threshold]>	energy level audio must fall below to be considered silence (500 is a good starting point).
<[silence_secs]>	seconds of silence to interrupt the record.

Definition at line 1296 of file switch_cpp.cpp.

References memset(), sanity_check, switch_file_handle::silence_hits, switch_ivr_record_file(), SWITCH_STATUS_SUCCESS, this_check, and switch_file_handle::thresh.

{
        switch_status_t status;
        switch_file_handle_t local_fh;

        this_check(-1);
        sanity_check(-1);

        if (!file_name) return 0;
        memset(&local_fh, 0, sizeof(local_fh));
        fhp = &local_fh;
        local_fh.thresh = silence_threshold;
        local_fh.silence_hits = silence_hits;

        begin_allow_threads();
        status = switch_ivr_record_file(session, &local_fh, file_name, ap, time_limit);
        end_allow_threads();

        fhp = NULL;

    return status == SWITCH_STATUS_SUCCESS ? 1 : 0;

}

run_dtmf_callback()

virtual switch_status_t CoreSession::run_dtmf_callback ( void *  input, switch_input_type_t  itype  )

pure virtual

Referenced by dtmf_callback().

say()

void CoreSession::say	(	const char *	tosay,
		const char *	module_name,
		const char *	say_type,
		const char *	say_method,
		const char *	say_gender = NULL
	)

Definition at line 1075 of file switch_cpp.cpp.

References sanity_check_noreturn, SWITCH_CHANNEL_SESSION_LOG, switch_ivr_say(), SWITCH_LOG_ERROR, switch_log_printf(), and this_check_void.

{
        this_check_void();
        sanity_check_noreturn;
        if (!(tosay && module_name && say_type && say_method)) {
                switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_ERROR, "Error! invalid args.\n");
                return;
        }
        begin_allow_threads();
        switch_ivr_say(session, tosay, module_name, say_type, say_method, say_gender, ap);
    end_allow_threads();
}

sayPhrase()

void CoreSession::sayPhrase	(	const char *	phrase_name,
		const char *	phrase_data = "",
		const char *	phrase_lang = NULL
	)

Definition at line 1088 of file switch_cpp.cpp.

References sanity_check_noreturn, SWITCH_CHANNEL_SESSION_LOG, switch_ivr_phrase_macro, SWITCH_LOG_ERROR, switch_log_printf(), and this_check_void.

{
        this_check_void();
        sanity_check_noreturn;

        if (!(phrase_name)) {
                switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_ERROR, "Error! invalid args.\n");
                return;
        }

        begin_allow_threads();
        switch_ivr_phrase_macro(session, phrase_name, phrase_data, phrase_lang, ap);
    end_allow_threads();
}

sendEvent()

void CoreSession::sendEvent

(

Event *

sendME

)

Definition at line 823 of file switch_cpp.cpp.

References Event::event, sanity_check_noreturn, switch_core_session_receive_event(), switch_event_dup(), SWITCH_STATUS_SUCCESS, and this_check_void.

{
        this_check_void();
        sanity_check_noreturn;

        if (sendME->event) {
                switch_event_t *new_event;
                if (switch_event_dup(&new_event, sendME->event) == SWITCH_STATUS_SUCCESS) {
                        switch_core_session_receive_event(session, &new_event);
                }
        }
}

set_tts_params()

void CoreSession::set_tts_params	(	char *	tts_name,
		char *	voice_name
	)

Definition at line 871 of file switch_cpp.cpp.

References sanity_check_noreturn, switch_safe_free, switch_str_nil, and this_check_void.

{
        this_check_void();
        sanity_check_noreturn;
        switch_safe_free(tts_name);
        switch_safe_free(voice_name);
        tts_name = strdup(switch_str_nil(tts_name_p));
        voice_name = strdup(switch_str_nil(voice_name_p));
}

set_tts_parms()

void CoreSession::set_tts_parms	(	char *	tts_name,
		char *	voice_name
	)

Definition at line 860 of file switch_cpp.cpp.

References sanity_check_noreturn, SWITCH_CHANNEL_SESSION_LOG, SWITCH_LOG_ERROR, switch_log_printf(), switch_safe_free, and this_check_void.

{
        switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_ERROR, "set_tts_parms is deprecated. Use set_tts_params.\n");
        this_check_void();
        sanity_check_noreturn;
        switch_safe_free(tts_name);
        switch_safe_free(voice_name);
    tts_name = strdup(tts_name_p);
    voice_name = strdup(voice_name_p);
}

setAutoHangup()

int CoreSession::setAutoHangup

(

bool

val

)

Definition at line 1345 of file switch_cpp.cpp.

References S_HUP, sanity_check, switch_clear_flag, switch_set_flag, SWITCH_STATUS_FALSE, SWITCH_STATUS_SUCCESS, and this_check.

{
        this_check(-1);
        sanity_check(-1);

        if (!session) {
                return SWITCH_STATUS_FALSE;
        }
        if (val) {
                switch_set_flag(this, S_HUP);
        } else {
                switch_clear_flag(this, S_HUP);
        }
        return SWITCH_STATUS_SUCCESS;
}

setDTMFCallback()

void CoreSession::setDTMFCallback	(	void *	cbfunc,
		char *	funcargs
	)

set a DTMF callback function

The DTMF callback function will be set and persist for the life of the session, and be called when a dtmf is pressed by user during streamfile(), collectDigits(), and certain other methods are executing.

Definition at line 800 of file switch_cpp.cpp.

References dtmf_callback(), sanity_check_noreturn, switch_channel_set_private(), and this_check_void.

                                                                              {

        this_check_void();
        sanity_check_noreturn;

        cb_state.funcargs = funcargs;
        cb_state.function = cbfunc;

        args.buf = &cb_state;
        args.buflen = sizeof(cb_state);  // not sure what this is used for, copy mod_spidermonkey

    switch_channel_set_private(channel, "CoreSession", this);

        // we cannot set the actual callback to a python function, because
        // the callback is a function pointer with a specific signature.
        // so, set it to the following c function which will act as a proxy,
        // finding the python callback in the args callback args structure
        args.input_callback = dtmf_callback;
        ap = &args;


}

setEventData()

void CoreSession::setEventData

(

Event *

e

)

Definition at line 689 of file switch_cpp.cpp.

References Event::event, sanity_check_noreturn, switch_channel_event_set_data(), and this_check_void.

{
        this_check_void();
        sanity_check_noreturn;

        if (channel && e->event) {
                switch_channel_event_set_data(channel, e->event);
        }
}

setHangupHook()

void CoreSession::setHangupHook

(

void *

hangup_func

)

Set the hangup callback function.

Parameters

hangup_func

- language specific function ptr cast into void *

Definition at line 1370 of file switch_cpp.cpp.

References hanguphook(), sanity_check_noreturn, switch_channel_get_state(), SWITCH_CHANNEL_SESSION_LOG, switch_channel_set_private(), switch_core_session_get_channel(), SWITCH_LOG_DEBUG, switch_log_printf(), and this_check_void.

                                                                 {

        this_check_void();
        sanity_check_noreturn;

    switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_DEBUG, "CoreSession::seHangupHook, hangup_func: %p\n", hangup_func);
    on_hangup = hangup_func;
    switch_channel_t *channel = switch_core_session_get_channel(session);

    hook_state = switch_channel_get_state(channel);
    switch_channel_set_private(channel, "CoreSession", this);
    switch_core_event_hook_add_state_change(session, hanguphook);
}

setPrivate()

void CoreSession::setPrivate	(	char *	var,
		void *	val
	)

Definition at line 756 of file switch_cpp.cpp.

References sanity_check_noreturn, switch_channel_set_private(), and this_check_void.

{
        this_check_void();
        sanity_check_noreturn;
    switch_channel_set_private(channel, var, val);
}

setVariable()

void CoreSession::setVariable	(	char *	var,
		char *	val
	)

Definition at line 770 of file switch_cpp.cpp.

References sanity_check_noreturn, SWITCH_CHANNEL_SESSION_LOG, switch_channel_set_variable_var_check(), SWITCH_FALSE, SWITCH_LOG_DEBUG, switch_log_printf(), and this_check_void.

{
        this_check_void();
        sanity_check_noreturn;
        switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_DEBUG, "CoreSession::setVariable('%s', '%s')\n", var, val);
        switch_channel_set_variable_var_check(channel, var, val, SWITCH_FALSE);
}

sleep()

int CoreSession::sleep	(	int	ms,
		int	sync = 0
	)

Definition at line 1135 of file switch_cpp.cpp.

References sanity_check, switch_ivr_sleep(), SWITCH_STATUS_SUCCESS, and this_check.

                                                       {

    switch_status_t status;

        this_check(-1);
    sanity_check(-1);

    begin_allow_threads();
    status = switch_ivr_sleep(session, ms, (switch_bool_t) sync, ap);
    end_allow_threads();

    return status == SWITCH_STATUS_SUCCESS ? 1 : 0;

}

speak()

int CoreSession::speak

(

char *

text

)

Definition at line 836 of file switch_cpp.cpp.

References sanity_check, SWITCH_CHANNEL_SESSION_LOG, switch_ivr_speak_text(), SWITCH_LOG_ERROR, switch_log_printf(), SWITCH_STATUS_FALSE, SWITCH_STATUS_SUCCESS, and this_check.

{
    switch_status_t status;

        this_check(-1);
        sanity_check(-1);

        if (!tts_name) {
                switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_ERROR, "No TTS engine specified\n");
                return SWITCH_STATUS_FALSE;
        }

        if (!voice_name) {
                switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_ERROR, "No TTS voice specified\n");
                return SWITCH_STATUS_FALSE;
        }


        begin_allow_threads();
        status = switch_ivr_speak_text(session, tts_name, voice_name, text, ap);
        end_allow_threads();
    return status == SWITCH_STATUS_SUCCESS ? 1 : 0;
}

store_file_handle()

void CoreSession::store_file_handle ( switch_file_handle_t *  fh )

protected

streamFile()

int CoreSession::streamFile	(	char *	file,
		int	starting_sample_count = 0
	)

Play a file that resides on disk into the channel.

Parameters

file	- the path to the .wav/.mp3 to be played
starting_sample_count	- the index of the sample to start playing from

Returns

an int status code indicating success or failure

Definition at line 1103 of file switch_cpp.cpp.

References memset(), switch_file_handle::prebuf, switch_file_handle::samples, sanity_check, switch_channel_get_variable, switch_ivr_play_file(), SWITCH_STATUS_SUCCESS, and this_check.

                                                                                 {

    switch_status_t status;
    //switch_file_handle_t fh = { 0 };
        const char *prebuf;
        switch_file_handle_t local_fh;

        this_check(-1);
    sanity_check(-1);

        memset(&local_fh, 0, sizeof(local_fh));
        fhp = &local_fh;
    local_fh.samples = starting_sample_count;


        if ((prebuf = switch_channel_get_variable(this->channel, "stream_prebuffer"))) {
        int maybe = atoi(prebuf);
        if (maybe > 0) {
            local_fh.prebuf = maybe;
        }
        }

    begin_allow_threads();
    status = switch_ivr_play_file(session, fhp, file, ap);
    end_allow_threads();

        fhp = NULL;

    return status == SWITCH_STATUS_SUCCESS ? 1 : 0;

}

transfer()

int CoreSession::transfer	(	char *	extension,
		char *	dialplan = NULL,
		char *	context = NULL
	)

Definition at line 933 of file switch_cpp.cpp.

References sanity_check, SWITCH_CHANNEL_SESSION_LOG, switch_ivr_session_transfer(), SWITCH_LOG_DEBUG, switch_log_printf(), SWITCH_STATUS_SUCCESS, and this_check.

{
    switch_status_t status;
        this_check(-1);
        sanity_check(-1);
    begin_allow_threads();
    status = switch_ivr_session_transfer(session, extension, dialplan, context);
        switch_log_printf(SWITCH_CHANNEL_SESSION_LOG(session), SWITCH_LOG_DEBUG, "transfer result: %d\n", status);
    end_allow_threads();
    return status == SWITCH_STATUS_SUCCESS ? 1 : 0;
}

waitForAnswer()

void CoreSession::waitForAnswer

(

CoreSession *

calling_session

)

Definition at line 1361 of file switch_cpp.cpp.

References sanity_check_noreturn, session, switch_ivr_wait_for_answer(), and this_check_void.

{
        this_check_void();
        sanity_check_noreturn;

        switch_ivr_wait_for_answer(calling_session ? calling_session->session : NULL, session);

}

Field Documentation

allocated

int CoreSession::allocated

Definition at line 227 of file switch_cpp.h.

Referenced by bridge().

ap

switch_input_args_t* CoreSession::ap

protected

Definition at line 211 of file switch_cpp.h.

args

switch_input_args_t CoreSession::args

protected

Definition at line 209 of file switch_cpp.h.

cause

switch_call_cause_t CoreSession::cause

Definition at line 231 of file switch_cpp.h.

Referenced by hanguphook().

cb_state

input_callback_state CoreSession::cb_state

Definition at line 228 of file switch_cpp.h.

channel

switch_channel_t* CoreSession::channel

Definition at line 225 of file switch_cpp.h.

dtmf_buf

char CoreSession::dtmf_buf[512]

protected

Definition at line 217 of file switch_cpp.h.

fhp

switch_file_handle_t* CoreSession::fhp

protected

Definition at line 216 of file switch_cpp.h.

flags

unsigned int CoreSession::flags

Definition at line 226 of file switch_cpp.h.

hook_state

switch_channel_state_t CoreSession::hook_state

Definition at line 230 of file switch_cpp.h.

Referenced by hanguphook().

on_hangup

void* CoreSession::on_hangup

protected

Definition at line 215 of file switch_cpp.h.

session

switch_core_session_t* CoreSession::session

Definition at line 224 of file switch_cpp.h.

Referenced by API::API(), bridge(), CoreSession(), IVRMenu::execute(), originate(), and waitForAnswer().

tts_name

char* CoreSession::tts_name

Definition at line 234 of file switch_cpp.h.

uuid

char* CoreSession::uuid

Definition at line 233 of file switch_cpp.h.

voice_name

char* CoreSession::voice_name

Definition at line 235 of file switch_cpp.h.

xml_cdr_text

char* CoreSession::xml_cdr_text

protected

Definition at line 213 of file switch_cpp.h.

---

The documentation for this class was generated from the following files:

• switch_cpp.h
• switch_cpp.cpp