added sangoma boost sigmod interface

git-svn-id: http://svn.openzap.org/svn/openzap/branches/sangoma_boost@856 a93c3328-9c30-0410-af19-c9cd2b2d52af

diff --git a/libs/freetdm/src/include/zap_types.h b/libs/freetdm/src/include/zap_types.h
index 72c467c398b6e12e58d1dc121233b96990773e03..bff84883791a72e6882270482507cdec3650f774 100644 (file)
--- a/libs/freetdm/src/include/zap_types.h
+++ b/libs/freetdm/src/include/zap_types.h
@@ -179,6 +179,18 @@ typedef enum {
        ZAP_SIGTYPE_R2
 } zap_signal_type_t;
 
+/*!
+  \brief Signaling status on the channel
+ */
+typedef enum {
+       /* The channel signaling link is down (no d-chans up in the span/group, MFC-R2 bit pattern unidentified) */
+       ZAP_SIG_STATE_DOWN,
+       /* The channel signaling link is suspended (MFC-R2 bit pattern blocked, ss7 blocked?) */
+       ZAP_SIG_STATE_SUSPENDED,
+       /* The channel signaling link is ready and calls can be placed */
+       ZAP_SIG_STATE_UP
+} zap_channel_sig_status_t;
+
 typedef enum {
        ZAP_SIGEVENT_START,
        ZAP_SIGEVENT_STOP,

diff --git a/libs/freetdm/src/ozmod/ozmod_sangoma_boost/sangoma_boost_client.c b/libs/freetdm/src/ozmod/ozmod_sangoma_boost/sangoma_boost_client.c
index f0ecef1b97f73de34942307695e54f7ee791a9ae..164156b5c19004f8c9a0047c869c25c97a5fad9d 100644 (file)
--- a/libs/freetdm/src/ozmod/ozmod_sangoma_boost/sangoma_boost_client.c
+++ b/libs/freetdm/src/ozmod/ozmod_sangoma_boost/sangoma_boost_client.c
@@ -36,7 +36,7 @@
 #endif
 
 #include "openzap.h"
-#include <sangoma_boost_client.h>
+#include "sangoma_boost_client.h"
 
 
 #ifndef HAVE_GETHOSTBYNAME_R

diff --git a/libs/freetdm/src/ozmod/ozmod_sangoma_boost/sangoma_boost_client.h b/libs/freetdm/src/ozmod/ozmod_sangoma_boost/sangoma_boost_client.h
index 1b86c5df01020f9c03996cccdb869f463a002cc2..9ed2c5f35eab490baf5bfb36259ef97e92090331 100644 (file)
--- a/libs/freetdm/src/ozmod/ozmod_sangoma_boost/sangoma_boost_client.h
+++ b/libs/freetdm/src/ozmod/ozmod_sangoma_boost/sangoma_boost_client.h
@@ -34,6 +34,8 @@
 #ifndef _SANGOMABC_H
 #define _SANGOMABC_H
 
+#include "sangoma_boost_sigmod.h"
+
 #include <ctype.h>
 #include <string.h>
 #include <unistd.h>
@@ -104,6 +106,8 @@ struct sangomabc_connection {
        unsigned int rxseq_reset;
        sangomabc_ip_cfg_t cfg;
        uint32_t hb_elapsed;
+       /* boost signaling mod interface pointer (if not working in TCP mode) */
+       boost_sigmod_interface_t *sigmod;
 };
 
 typedef struct sangomabc_connection sangomabc_connection_t;

diff --git a/libs/freetdm/src/ozmod/ozmod_sangoma_boost/sangoma_boost_sigmod.h b/libs/freetdm/src/ozmod/ozmod_sangoma_boost/sangoma_boost_sigmod.h
new file mode 100644 (file)
index 0000000..072558b
--- /dev/null
+++ b/libs/freetdm/src/ozmod/ozmod_sangoma_boost/sangoma_boost_sigmod.h
@@ -0,0 +1,161 @@
+/*
+ * Copyright (c) 2009, 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.
+ */
+
+#ifndef SANGOMA_BOOST_SIGMOD_H
+#define SANGOMA_BOOST_SIGMOD_H
+
+#include "zap_types.h"
+
+/*! 
+  \brief Callback used to notify signaling status changes on a channel
+  \param zchan The openzap channel where the signaling status just changed
+  \param status The new signaling status
+ */
+#define BOOST_SIG_STATUS_CB_ARGS (zap_channel_t *zchan, zap_channel_sig_status_t status)
+typedef void (*boost_sig_status_cb_func_t) BOOST_SIG_STATUS_CB_ARGS;
+#define BOOST_SIG_STATUS_CB_FUNCTION(name) void name BOOST_SIG_STATUS_CB_ARGS
+
+/*! 
+  \brief Write a boost msg to a boost endpoint 
+  \param msg The generic message pointer, owned by the caller
+  \param msglen The length of the provided structure pointed by msg
+  \return ZAP_SUCCESS or ZAP_FAIL
+
+   The msg buffer is owned by the caller and it should
+   be either t_sigboost_callstart or t_sigboost_short
+   the endpoint receiving the msg will first cast to
+   t_sigboost_short, check the event type, and if needed.
+ */
+#define BOOST_WRITE_MSG_ARGS (void *msg, zap_size_t msglen)
+typedef zap_status_t (*boost_write_msg_func_t) BOOST_WRITE_MSG_ARGS;
+#define BOOST_WRITE_MSG_FUNCTION(name) zap_status_t name BOOST_WRITE_MSG_ARGS
+
+/*! 
+  \brief Set the callback to be used by a signaling module to write boost messages
+  \param callback The callback to be used by the signaling module
+
+   The provided callback will be used for the signaling boost module to notify the
+   user with boost messages.
+ */
+#define BOOST_SET_WRITE_MSG_CB_ARGS (boost_write_msg_func_t callback)
+typedef void (*boost_set_write_msg_cb_func_t) BOOST_SET_WRITE_MSG_CB_ARGS;
+#define BOOST_SET_WRITE_MSG_CB_FUNCTION(name) void name BOOST_SET_WRITE_MSG_CB_ARGS
+
+/*! 
+  \brief Set signaling status callback used by the signaling module to report signaling status changes
+  \param callback The callback to be used by the signaling module
+
+   The provided callback will be used for the signaling boost module to notify the
+   user with signaling link status changes.
+ */
+#define BOOST_SET_SIG_STATUS_CB_ARGS (boost_sig_status_cb_func_t callback)
+typedef void (*boost_set_sig_status_cb_func_t) BOOST_SET_SIG_STATUS_CB_ARGS;
+#define BOOST_SET_SIG_STATUS_CB_FUNCTION(name) void name BOOST_SET_SIG_STATUS_CB_ARGS
+
+/*! 
+  \brief Get the signaling status on the given channel.
+  \param zchan The openzap channel
+  \param status The status pointer where the current signaling status will be set
+  \return ZAP_SUCCESS or ZAP_FAIL 
+ */
+#define BOOST_GET_SIG_STATUS_ARGS (zap_channel_t *zchan, zap_channel_sig_status_t *status)
+typedef zap_status_t (*boost_get_sig_status_func_t) BOOST_GET_SIG_STATUS_ARGS;
+#define BOOST_GET_SIG_STATUS_FUNCTION(name) zap_status_t name BOOST_GET_SIG_STATUS_ARGS
+
+/*! 
+  \brief Set the signaling status on the given channel.
+  \param zchan The openzap channel
+  \param status The new status for the channel
+  \return ZAP_SUCCESS or ZAP_FAIL 
+ */
+#define BOOST_SET_SIG_STATUS_ARGS (zap_channel_t *zchan, zap_channel_sig_status_t status)
+typedef zap_status_t (*boost_set_sig_status_func_t) BOOST_SET_SIG_STATUS_ARGS;
+#define BOOST_SET_SIG_STATUS_FUNCTION(name) zap_status_t BOOST_SET_SIG_STATUS_ARGS
+
+/*! 
+  \brief Configure the given span signaling
+  \param span The openzap span
+  \param ap The list of configuration key,value pairs (must be null terminated)
+  \return ZAP_SUCCESS or ZAP_FAIL 
+ */
+#define BOOST_CONFIGURE_SPAN_ARGS (zap_span_t *span, va_list ap) 
+typedef zap_status_t (*boost_configure_span_func_t) BOOST_CONFIGURE_SPAN_ARGS;
+#define BOOST_CONFIGURE_SPAN_FUNCTION(name) zap_status_t name BOOST_CONFIGURE_SPAN_ARGS
+
+/*! 
+  \brief Start the given span
+  \param span The openzap span
+  \return ZAP_SUCCESS or ZAP_FAIL 
+ */
+#define BOOST_START_SPAN_ARGS (zap_span_t *span) 
+typedef zap_status_t (*boost_start_span_func_t) BOOST_START_SPAN_ARGS;
+#define BOOST_START_SPAN_FUNCTION(name) zap_status_t name BOOST_START_SPAN_ARGS
+
+/*! 
+  \brief Stop the given span
+  \param span The openzap span
+  \return ZAP_SUCCESS or ZAP_FAIL 
+ */
+#define BOOST_STOP_SPAN_ARGS (zap_span_t *span) 
+typedef zap_status_t (*boost_stop_span_func_t) BOOST_START_SPAN_ARGS;
+#define BOOST_STOP_SPAN_FUNCTION(name) zap_status_t name BOOST_STOP_SPAN_ARGS
+
+/*! 
+  \brief The boost signaling module interface 
+ */
+typedef struct boost_sigmod_interface_s {
+       const char *name;
+       boost_write_msg_func_t write_msg;       
+       boost_set_write_msg_cb_func_t set_write_msg_cb;
+       boost_set_sig_status_cb_func_t set_sig_status_cb;
+       boost_get_sig_status_func_t get_sig_status;
+       boost_set_sig_status_func_t set_sig_status;
+       boost_configure_span_func_t configure_span;
+       boost_start_span_func_t start_span;
+       boost_stop_span_func_t stop_stpan;
+} boost_sigmod_interface_t;
+
+#endif
+
+/* For Emacs:
+ * Local Variables:
+ * mode:c
+ * indent-tabs-mode:t
+ * tab-width:4
+ * c-basic-offset:4
+ * End:
+ * For VIM:
+ * vim:set softtabstop=4 shiftwidth=4 tabstop=4:
+ */
+