+/*
+ * Copyright (c) 2010, Sangoma Technologies
+ * Moises Silva <moy@sangoma.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the original author; nor the names of any contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+ * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * Sample program for the boost signaling absraction.
+ * Usage: boostsample <span name>
+ * The span name must be a valid span defined in freetdm.conf
+ * compile this program linking to the freetdm library (ie -lfreetdm)
+ **/
+
#include "freetdm.h"
-static FIO_SIGNAL_CB_FUNCTION(on_signal)
+/* arbitrary limit for max calls in this sample program */
+#define MAX_CALLS 255
+
+/* some timers (in seconds) to fake responses in incoming calls */
+#define PROGRESS_TIMER 1
+#define ANSWER_TIMER 5
+#define HANGUP_TIMER 15
+
+/* simple variable used to stop the application */
+static int app_running = 0;
+
+typedef void (*expired_function_t)(ftdm_channel_t *channel);
+typedef struct dummy_timer_s {
+ int time;
+ ftdm_channel_t *channel;
+ expired_function_t expired;
+} dummy_timer_t;
+
+/* dummy second resolution timers */
+static dummy_timer_t g_timers[MAX_CALLS];
+
+/* mutex to protect the timers (both, the test thread and the signaling thread may modify them) */
+static ftdm_mutex_t *g_schedule_mutex;
+
+static void schedule_timer(ftdm_channel_t *channel, int sec, expired_function_t expired)
{
- return FTDM_FAIL;
+ int i;
+ ftdm_mutex_lock(g_schedule_mutex);
+ for (i = 0; i < sizeof(g_timers)/sizeof(g_timers[0]); i++) {
+ /* check the timer slot is free to use */
+ if (!g_timers[i].time) {
+ g_timers[i].time = sec;
+ g_timers[i].channel = channel;
+ g_timers[i].expired = expired;
+ ftdm_mutex_unlock(g_schedule_mutex);
+ return;
+ }
+ }
+ ftdm_log(FTDM_LOG_ERROR, "Failed to schedule timer\n");
+ ftdm_mutex_unlock(g_schedule_mutex);
+}
+
+static void run_timers(void)
+{
+ int i;
+ void *channel;
+ expired_function_t expired_func = NULL;
+ ftdm_mutex_lock(g_schedule_mutex);
+ for (i = 0; i < sizeof(g_timers)/sizeof(g_timers[0]); i++) {
+ /* if there's time left, decrement */
+ if (g_timers[i].time) {
+ g_timers[i].time--;
+ }
+
+ /* if time expired and we have an expired function, call it */
+ if (!g_timers[i].time && g_timers[i].expired) {
+ expired_func = g_timers[i].expired;
+ channel = g_timers[i].channel;
+ memset(&g_timers[i], 0, sizeof(g_timers[i]));
+ expired_func(channel);
+ }
+ }
+ ftdm_mutex_unlock(g_schedule_mutex);
+}
+
+static void release_timers(ftdm_channel_t *channel)
+{
+ int i;
+ ftdm_mutex_lock(g_schedule_mutex);
+ for (i = 0; i < sizeof(g_timers)/sizeof(g_timers[0]); i++) {
+ /* clear any timer belonging to the given channel */
+ if (g_timers[i].channel == channel) {
+ memset(&g_timers[i], 0, sizeof(g_timers[i]));
+ }
+ }
+ ftdm_mutex_unlock(g_schedule_mutex);
+}
+
+/* hangup the call */
+static void send_hangup(ftdm_channel_t *channel)
+{
+ ftdm_log(FTDM_LOG_NOTICE, "-- Requesting hangup in channel %d:%d\n", channel->span_id, channel->chan_id);
+ ftdm_set_state_locked(channel, FTDM_CHANNEL_STATE_HANGUP);
+}
+
+/* send answer for an incoming call */
+static void send_answer(ftdm_channel_t *channel)
+{
+ /* we move the channel signaling state machine to UP (answered) */
+ ftdm_log(FTDM_LOG_NOTICE, "-- Requesting answer in channel %d:%d\n", channel->span_id, channel->chan_id);
+ ftdm_set_state_locked(channel, FTDM_CHANNEL_STATE_UP);
+ schedule_timer(channel, HANGUP_TIMER, send_hangup);
+}
+
+/* send progress for an incoming */
+static void send_progress(ftdm_channel_t *channel)
+{
+ /* we move the channel signaling state machine to UP (answered) */
+ ftdm_log(FTDM_LOG_NOTICE, "-- Requesting progress\n", channel->span_id, channel->chan_id);
+ ftdm_set_state_locked(channel, FTDM_CHANNEL_STATE_PROGRESS);
+ schedule_timer(channel, ANSWER_TIMER, send_answer);
}
-static int R = 0;
-#if 0
-static void handle_SIGINT(int sig)
+/* This function will be called in an undetermined signaling thread, you must not do
+ * any blocking operations here or the signaling stack may delay other call event processing
+ * The arguments for this function are defined in FIO_SIGNAL_CB_FUNCTION prototype, I just
+ * name them here for your convenience:
+ * ftdm_sigmsg_t *sigmsg
+ * - The sigmsg structure contains the ftdm_channel structure that represents the channel where
+ * the event occurred and the event_id of the signaling event that just occurred.
+ * */
+static FIO_SIGNAL_CB_FUNCTION(on_signaling_event)
{
- if (sig);
- R = 0;
- return;
+ switch (sigmsg->event_id) {
+ /* This event signals the start of an incoming call */
+ case FTDM_SIGEVENT_START:
+ ftdm_log(FTDM_LOG_NOTICE, "FTDM_SIGEVENT_START received in channel %d:%d\n", sigmsg->span_id, sigmsg->chan_id);
+ schedule_timer(sigmsg->channel, PROGRESS_TIMER, send_progress);
+ break;
+ /* This event signals progress on an outgoing call */
+ case FTDM_SIGEVENT_PROGRESS_MEDIA:
+ ftdm_log(FTDM_LOG_NOTICE, "FTDM_SIGEVENT_PROGRESS_MEDIA received in channel %d:%d\n", sigmsg->span_id, sigmsg->chan_id);
+ break;
+ /* This event signals answer in an outgoing call */
+ case FTDM_SIGEVENT_UP:
+ ftdm_log(FTDM_LOG_NOTICE, "FTDM_SIGEVENT_UP received in channel %d:%d\n", sigmsg->span_id, sigmsg->chan_id);
+ break;
+ /* This event signals hangup from the other end */
+ case FTDM_SIGEVENT_STOP:
+ ftdm_log(FTDM_LOG_NOTICE, "FTDM_SIGEVENT_STOP received in channel %d:%d\n", sigmsg->span_id, sigmsg->chan_id);
+ /* release any timer for this channel */
+ release_timers(sigmsg->channel);
+ break;
+ default:
+ break;
+ }
+ return FTDM_FAIL;
}
-#endif
+
int main(int argc, char *argv[])
{
ftdm_conf_parameter_t parameters[20];
ftdm_span_t *span;
- int local_port, remote_port;
-
- local_port = remote_port = 53000;
- ftdm_global_set_default_logger(FTDM_LOG_LEVEL_DEBUG);
-#if 0
if (argc < 2) {
- printf("invalid arguments\n");
+ fprintf(stderr, "Usage: boostsample <span name>\n");
exit(-1);
}
-#endif
+ /* clear any outstanding timers */
+ memset(&g_timers, 0, sizeof(g_timers));
+
+ /* set the logging level to use */
+ ftdm_global_set_default_logger(FTDM_LOG_LEVEL_DEBUG);
+
+ /* Initialize the FTDM library */
if (ftdm_global_init() != FTDM_SUCCESS) {
fprintf(stderr, "Error loading FreeTDM\n");
exit(-1);
}
+
+ /* create the schedule mutex */
+ ftdm_mutex_create(&g_schedule_mutex);
+
+ /* Load the FreeTDM configuration */
if (ftdm_global_configuration() != FTDM_SUCCESS) {
fprintf(stderr, "Error configuring FreeTDM\n");
exit(-1);
}
- printf("FreeTDM loaded\n");
+ /* At this point FreeTDM is ready to be used, the spans defined in freetdm.conf have the basic I/O board configuration
+ * but no telephony signaling configuration at all. */
+ printf("FreeTDM loaded ...\n");
- if (ftdm_span_find_by_name("wp1", &span) != FTDM_SUCCESS) {
+ /* Retrieve a span by name (according to freetdm.conf) */
+ if (ftdm_span_find_by_name(argv[1], &span) != FTDM_SUCCESS) {
fprintf(stderr, "Error finding FreeTDM span %s\n", argv[1]);
goto done;
}
+
+ /* prepare the configuration parameters that will be sent down to the signaling stack, the array of paramters must be terminated by an
+ * array element with a null .var member */
+
+ /* for sangoma_boost signaling (abstraction signaling used by Sangoma for PRI, BRI and SS7) the first parameter you must send
+ * is sigmod, which must be either sangoma_prid, if you have the PRI stack available, or sangoma_brid for the BRI stack */
parameters[0].var = "sigmod";
parameters[0].val = "sangoma_prid";
- parameters[1].var = "switchtype";
- parameters[1].val = "euroisdn";
- parameters[1].var = "signalling";
- parameters[1].val = "pri_cpe";
- parameters[2].var = NULL;
- if (ftdm_configure_span_signaling("sangoma_boost", span, on_signal, parameters) == FTDM_SUCCESS) {
- ftdm_span_start(span);
- } else {
- fprintf(stderr, "Error starting SS7_BOOST\n");
+
+ /* following parameters are signaling stack specific, this ones are for PRI */
+ parameters[1].var = "switchtype";
+ parameters[1].val = "euroisdn";
+
+ parameters[2].var = "signalling";
+ parameters[2].val = "pri_cpe";
+
+ /* the last parameter .var member must be NULL! */
+ parameters[3].var = NULL;
+
+ /* send the configuration values down to the stack */
+ if (ftdm_configure_span_signaling("sangoma_boost", span, on_signaling_event, parameters) != FTDM_SUCCESS) {
+ fprintf(stderr, "Error configuring sangoma_boost signaling abstraction in span %s\n", span->name);
goto done;
}
- while(ftdm_running() && R) {
+ /* configuration succeeded, we can proceed now to start the span
+ * This step will launch at least 1 background (may be more, depending on the signaling stack used)
+ * to handle *ALL* signaling events for this span, your on_signaling_event callback will be called always
+ * in one of those infraestructure threads and you MUST NOT block in that handler to avoid delays and errors
+ * in the signaling processing for any call.
+ * */
+ ftdm_span_start(span);
+
+ app_running = 1;
+
+ /* The application thread can go on and do anything else, like waiting for a shutdown signal */
+ while(ftdm_running() && app_running) {
ftdm_sleep(1 * 1000);
+ run_timers();
}
done:
+ ftdm_mutex_destroy(&g_schedule_mutex);
+
+ /* whenever you're done, this function will shutdown the signaling threads in any span that was started */
ftdm_global_destroy();
return 0;
projects / thirdparty / freeswitch.git / commitdiff
