diff --git a/build/modules.conf.in b/build/modules.conf.in index 67e1fe62ae..37244a188a 100644 --- a/build/modules.conf.in +++ b/build/modules.conf.in @@ -105,5 +105,5 @@ say/mod_say_ru #say/mod_say_th ## Experimental Modules (don't cry if they're broken) -#../../contrib/mod/endpoints/mod_khomp +#endpoints/mod_khomp #../../contrib/mod/xml_int/mod_xml_odbc diff --git a/conf/autoload_configs/switch.conf.xml b/conf/autoload_configs/switch.conf.xml index e861b1b61a..896dd0e712 100644 --- a/conf/autoload_configs/switch.conf.xml +++ b/conf/autoload_configs/switch.conf.xml @@ -86,6 +86,7 @@ + diff --git a/docs/phrase/phrase_en.xml b/docs/phrase/phrase_en.xml index 65c70171fb..a028a2aae0 100644 --- a/docs/phrase/phrase_en.xml +++ b/docs/phrase/phrase_en.xml @@ -426,6 +426,7 @@ + @@ -437,7 +438,7 @@ - + diff --git a/libs/freetdm/configure.ac b/libs/freetdm/configure.ac index a8ed67f228..18f83d8f1d 100644 --- a/libs/freetdm/configure.ac +++ b/libs/freetdm/configure.ac @@ -205,6 +205,18 @@ if test "${have_sng_isdn}" = "yes"; then fi fi +if test "${have_sng_ss7}" = "yes"; then + if test "${build}" == "${host}" + then + case "${host}" in + x86_64-*) + # X86_64 machines need additional flags when compiling against libsng_isdn + CFLAGS="$CFLAGS -DBIT_64 -DALIGN_64BIT" + ;; + esac + fi +fi + COMP_VENDOR_CFLAGS="$COMP_VENDOR_CFLAGS" AC_SUBST(COMP_VENDOR_CFLAGS) AC_CONFIG_FILES([Makefile diff --git a/libs/freetdm/src/ftdm_sched.c b/libs/freetdm/src/ftdm_sched.c index a7736ce8a2..00a303aae6 100644 --- a/libs/freetdm/src/ftdm_sched.c +++ b/libs/freetdm/src/ftdm_sched.c @@ -55,7 +55,7 @@ struct ftdm_sched { struct ftdm_timer { char name[80]; ftdm_timer_id_t id; -#ifdef __linux__ +#if defined(__linux__) || defined(__FreeBSD__) struct timeval time; #endif void *usrdata; @@ -234,7 +234,7 @@ failed: FT_DECLARE(ftdm_status_t) ftdm_sched_run(ftdm_sched_t *sched) { ftdm_status_t status = FTDM_FAIL; -#ifdef __linux__ +#if defined(__linux__) || defined(__FreeBSD__) ftdm_timer_t *runtimer; ftdm_timer_t *timer; ftdm_sched_callback_t callback; @@ -315,7 +315,7 @@ FT_DECLARE(ftdm_status_t) ftdm_sched_timer(ftdm_sched_t *sched, const char *name int ms, ftdm_sched_callback_t callback, void *data, ftdm_timer_id_t *timerid) { ftdm_status_t status = FTDM_FAIL; -#ifdef __linux__ +#if defined(__linux__) || defined(__FreeBSD__) struct timeval now; int rc = 0; ftdm_timer_t *newtimer; @@ -396,7 +396,7 @@ done: FT_DECLARE(ftdm_status_t) ftdm_sched_get_time_to_next_timer(const ftdm_sched_t *sched, int32_t *timeto) { ftdm_status_t status = FTDM_FAIL; -#ifdef __linux__ +#if defined(__linux__) || defined(__FreeBSD__) int res = -1; int ms = 0; struct timeval currtime; diff --git a/libs/freetdm/src/ftmod/ftmod_sangoma_isdn/ftmod_sangoma_isdn_stack_hndl.c b/libs/freetdm/src/ftmod/ftmod_sangoma_isdn/ftmod_sangoma_isdn_stack_hndl.c index 827647f1f6..41833c54d3 100644 --- a/libs/freetdm/src/ftmod/ftmod_sangoma_isdn/ftmod_sangoma_isdn_stack_hndl.c +++ b/libs/freetdm/src/ftmod/ftmod_sangoma_isdn/ftmod_sangoma_isdn_stack_hndl.c @@ -79,6 +79,7 @@ void sngisdn_process_con_ind (sngisdn_event_data_t *sngisdn_event) sngisdn_info->suInstId = get_unique_suInstId(suId); sngisdn_info->spInstId = spInstId; + if (conEvnt->cdPtyNmb.eh.pres && signal_data->num_local_numbers) { uint8_t local_number_matched = 0; @@ -128,14 +129,12 @@ void sngisdn_process_con_ind (sngisdn_event_data_t *sngisdn_event) #if 0 /* Export ftdmchan variables here if we need to */ ftdm_channel_add_var(ftdmchan, "isdn_specific_var", "1"); - ftdm_channel_add_var(ftdmchan, "isdn_crap", "morecrap"); - ftdm_channel_add_var(ftdmchan, "isdn_stuff", "s"); - ftdm_channel_add_var(ftdmchan, "isdn_d", "asdsadasdasdsad"); #endif /* Fill in call information */ cpy_calling_num_from_stack(&ftdmchan->caller_data, &conEvnt->cgPtyNmb); cpy_called_num_from_stack(&ftdmchan->caller_data, &conEvnt->cdPtyNmb); cpy_calling_name_from_stack(&ftdmchan->caller_data, &conEvnt->display); + ftdm_log_chan(sngisdn_info->ftdmchan, FTDM_LOG_INFO, "Incoming call: Called No:[%s] Calling No:[%s]\n", ftdmchan->caller_data.dnis.digits, ftdmchan->caller_data.cid_num.digits); if (conEvnt->bearCap[0].eh.pres) { ftdmchan->caller_data.bearer_layer1 = sngisdn_get_infoTranCap_from_stack(conEvnt->bearCap[0].usrInfoLyr1Prot.val); diff --git a/libs/freetdm/src/ftmod/ftmod_sangoma_isdn/ftmod_sangoma_isdn_stack_out.c b/libs/freetdm/src/ftmod/ftmod_sangoma_isdn/ftmod_sangoma_isdn_stack_out.c index 80a85ceec8..3284d54165 100644 --- a/libs/freetdm/src/ftmod/ftmod_sangoma_isdn/ftmod_sangoma_isdn_stack_out.c +++ b/libs/freetdm/src/ftmod/ftmod_sangoma_isdn/ftmod_sangoma_isdn_stack_out.c @@ -143,6 +143,7 @@ void sngisdn_snd_setup(ftdm_channel_t *ftdmchan) signal_data->signalling == SNGISDN_SIGNALING_NET) { sngisdn_info->ces = CES_MNGMNT; } + ftdm_log_chan(sngisdn_info->ftdmchan, FTDM_LOG_INFO, "Outgoing call: Called No:[%s] Calling No:[%s]\n", ftdmchan->caller_data.dnis.digits, ftdmchan->caller_data.cid_num.digits); cpy_called_num_from_user(&conEvnt.cdPtyNmb, &ftdmchan->caller_data); cpy_calling_num_from_user(&conEvnt.cgPtyNmb, &ftdmchan->caller_data); diff --git a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_cli.c b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_cli.c index 92284edba3..38d3723061 100644 --- a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_cli.c +++ b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_cli.c @@ -616,8 +616,8 @@ static ftdm_status_t handle_print_usuage(ftdm_stream_handle_t *stream) stream->write_function(stream, "Sangoma SS7 CLI usuage:\n\n"); stream->write_function(stream, "Ftmod_sangoma_ss7 general control:\n"); - stream->write_function(stream, "ftdm ss7 set ftace X Y\n"); - stream->write_function(stream, "ftdm ss7 set mtace X Y\n"); + stream->write_function(stream, "ftdm ss7 set ftrace X Y\n"); + stream->write_function(stream, "ftdm ss7 set mtrace X Y\n"); stream->write_function(stream, "\n"); stream->write_function(stream, "Ftmod_sangoma_ss7 information:\n"); stream->write_function(stream, "ftdm ss7 show status link X\n"); @@ -1064,7 +1064,7 @@ static ftdm_status_t handle_show_status(ftdm_stream_handle_t *stream, int span, /* grab the signaling_status */ ftdm_channel_get_sig_status(ftdmchan, &sigstatus); - stream->write_function(stream, "span=%2d|chan=%2d|cic=%4d|sig_status=%s|state=%s|", + stream->write_function(stream, "span=%2d|chan=%2d|cic=%4d|sig_status=%4s|state=%s|", ckt->span, ckt->chan, ckt->cic, @@ -1281,13 +1281,17 @@ static ftdm_status_t handle_status_link(ftdm_stream_handle_t *stream, char *name (sta.t.ssta.s.snDLSAP.remBlkd) ? "Y":"N", (sta.t.ssta.s.snDLSAP.locInhbt) ? "Y":"N", (sta.t.ssta.s.snDLSAP.rmtInhbt) ? "Y":"N"); - break; + + goto success; } /* move to the next link */ x++; } /* while (id != 0) */ + stream->write_function(stream, "Failed to find link=\"%s\"\n", name); + +success: return FTDM_SUCCESS; } @@ -1313,13 +1317,17 @@ static ftdm_status_t handle_status_linkset(ftdm_stream_handle_t *stream, char *n name, DECODE_LSN_LINKSET_STATUS(sta.t.ssta.s.snLnkSet.state), sta.t.ssta.s.snLnkSet.nmbActLnks); - break; + + goto success; } /* move to the next linkset */ x++; } /* while (id != 0) */ + stream->write_function(stream, "Failed to find link=\"%s\"\n", name); + +success: return FTDM_SUCCESS; } @@ -1342,13 +1350,16 @@ static ftdm_status_t handle_set_inhibit(ftdm_stream_handle_t *stream, char *name /* print the new status of the link */ handle_status_link(stream, &name[0]); - break; + goto success; } /* move to the next linkset */ x++; } /* while (id != 0) */ + stream->write_function(stream, "Failed to find link=\"%s\"\n", name); + +success: return FTDM_SUCCESS; } @@ -1371,13 +1382,16 @@ static ftdm_status_t handle_set_uninhibit(ftdm_stream_handle_t *stream, char *na /* print the new status of the link */ handle_status_link(stream, &name[0]); - break; + goto success; } /* move to the next linkset */ x++; } /* while (id != 0) */ + stream->write_function(stream, "Failed to find link=\"%s\"\n", name); + +success: return FTDM_SUCCESS; } @@ -1440,6 +1454,10 @@ static ftdm_status_t handle_tx_rsc(ftdm_stream_handle_t *stream, int span, int c /* go the next circuit */ x++; } /* while (g_ftdm_sngss7_data.cfg.isupCkt[x]id != 0) */ + + /* print the status of channels */ + handle_show_status(stream, span, chan, verbose); + return FTDM_SUCCESS; @@ -1505,6 +1523,24 @@ static ftdm_status_t handle_tx_grs(ftdm_stream_handle_t *stream, int span, int c x++; } /* while (g_ftdm_sngss7_data.cfg.isupCkt[x]id != 0) */ + x=1; + while (g_ftdm_sngss7_data.cfg.isupCkt[x].id != 0) { + if (g_ftdm_sngss7_data.cfg.isupCkt[x].type == VOICE) { + + sngss7_info = (sngss7_chan_data_t *)g_ftdm_sngss7_data.cfg.isupCkt[x].obj; + ftdmchan = sngss7_info->ftdmchan; + sngss7_span = ftdmchan->span->mod_data; + + if ((ftdmchan->physical_span_id == span) && + ((ftdmchan->physical_chan_id >= chan) && (ftdmchan->physical_chan_id < (chan+range)))) { + + handle_show_status(stream, span, chan, verbose); + } + } /* if ( cic == voice) */ + + /* go the next circuit */ + x++; + } /* while (g_ftdm_sngss7_data.cfg.isupCkt[x]id != 0) */ return FTDM_SUCCESS; } @@ -1585,6 +1621,25 @@ static ftdm_status_t handle_tx_cgb(ftdm_stream_handle_t *stream, int span, int c /* send the circuit group block */ ft_to_sngss7_cgb(main_chan); + + x=1; + while (g_ftdm_sngss7_data.cfg.isupCkt[x].id != 0) { + if (g_ftdm_sngss7_data.cfg.isupCkt[x].type == VOICE) { + + sngss7_info = (sngss7_chan_data_t *)g_ftdm_sngss7_data.cfg.isupCkt[x].obj; + ftdmchan = sngss7_info->ftdmchan; + sngss7_span = ftdmchan->span->mod_data; + + if ((ftdmchan->physical_span_id == span) && + ((ftdmchan->physical_chan_id >= chan) && (ftdmchan->physical_chan_id < (chan+range)))) { + + handle_show_status(stream, span, chan, verbose); + } + } /* if ( cic == voice) */ + + /* go the next circuit */ + x++; + } /* while (g_ftdm_sngss7_data.cfg.isupCkt[x]id != 0) */ return FTDM_SUCCESS; @@ -1666,6 +1721,25 @@ static ftdm_status_t handle_tx_cgu(ftdm_stream_handle_t *stream, int span, int c /* send the circuit group block */ ft_to_sngss7_cgu(main_chan); + + x=1; + while (g_ftdm_sngss7_data.cfg.isupCkt[x].id != 0) { + if (g_ftdm_sngss7_data.cfg.isupCkt[x].type == VOICE) { + + sngss7_info = (sngss7_chan_data_t *)g_ftdm_sngss7_data.cfg.isupCkt[x].obj; + ftdmchan = sngss7_info->ftdmchan; + sngss7_span = ftdmchan->span->mod_data; + + if ((ftdmchan->physical_span_id == span) && + ((ftdmchan->physical_chan_id >= chan) && (ftdmchan->physical_chan_id < (chan+range)))) { + + handle_show_status(stream, span, chan, verbose); + } + } /* if ( cic == voice) */ + + /* go the next circuit */ + x++; + } /* while (g_ftdm_sngss7_data.cfg.isupCkt[x]id != 0) */ return FTDM_SUCCESS; diff --git a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_handle.c b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_handle.c index ac58abd412..807b3b62c7 100644 --- a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_handle.c +++ b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_handle.c @@ -51,6 +51,8 @@ ftdm_status_t handle_dat_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circ ftdm_status_t handle_fac_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, uint8_t evntType, SiFacEvnt *siFacEvnt); ftdm_status_t handle_fac_cfm(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, uint8_t evntType, SiFacEvnt *siFacEvnt); ftdm_status_t handle_umsg_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit); +ftdm_status_t handle_susp_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, SiSuspEvnt *siSuspEvnt); +ftdm_status_t handle_resm_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, SiResmEvnt *siResmEvnt); ftdm_status_t handle_sta_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, uint8_t globalFlg, uint8_t evntType, SiStaEvnt *siStaEvnt); ftdm_status_t handle_reattempt(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, uint8_t globalFlg, uint8_t evntType, SiStaEvnt *siStaEvnt); @@ -298,8 +300,21 @@ ftdm_status_t handle_con_sta(uint32_t suInstId, uint32_t spInstId, uint32_t circ /* need to grab the sp instance id */ sngss7_info->spInstId = spInstId; - /* go to PROGRESS */ - ftdm_set_state_locked(ftdmchan, FTDM_CHANNEL_STATE_PROGRESS); + if ((siCnStEvnt->optBckCalInd.eh.pres) && + (siCnStEvnt->optBckCalInd.inbndInfoInd.pres)) { + + if (siCnStEvnt->optBckCalInd.inbndInfoInd.val) { + /* go to PROGRESS_MEDIA */ + ftdm_set_state_locked(ftdmchan, FTDM_CHANNEL_STATE_PROGRESS_MEDIA); + } else { + /* go to PROGRESS */ + ftdm_set_state_locked(ftdmchan, FTDM_CHANNEL_STATE_PROGRESS); + } /* if (inband) */ + } else { + /* go to PROGRESS_MEDIA */ + ftdm_set_state_locked(ftdmchan, FTDM_CHANNEL_STATE_PROGRESS_MEDIA); + } + break; /**********************************************************************/ default: /* incorrect state...reset the CIC */ @@ -733,6 +748,60 @@ ftdm_status_t handle_umsg_ind(uint32_t suInstId, uint32_t spInstId, uint32_t cir return FTDM_SUCCESS; } +/******************************************************************************/ +ftdm_status_t handle_susp_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, SiSuspEvnt *siSuspEvnt) +{ + SS7_FUNC_TRACE_ENTER(__FUNCTION__); + + sngss7_chan_data_t *sngss7_info ; + ftdm_channel_t *ftdmchan; + + /* get the ftdmchan and ss7_chan_data from the circuit */ + if (extract_chan_data(circuit, &sngss7_info, &ftdmchan)) { + SS7_ERROR("Failed to extract channel data for circuit = %d!\n", circuit); + SS7_FUNC_TRACE_EXIT(__FUNCTION__); + return FTDM_FAIL; + } + + /* lock the channel */ + ftdm_mutex_lock(ftdmchan->mutex); + + SS7_INFO_CHAN(ftdmchan,"[CIC:%d]Rx Call-Suspend msg\n", sngss7_info->circuit->cic); + + /* unlock the channel */ + ftdm_mutex_unlock(ftdmchan->mutex); + + SS7_FUNC_TRACE_EXIT(__FUNCTION__); + return FTDM_SUCCESS; +} + +/******************************************************************************/ +ftdm_status_t handle_resm_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, SiResmEvnt *siResmEvnt) +{ + SS7_FUNC_TRACE_ENTER(__FUNCTION__); + + sngss7_chan_data_t *sngss7_info ; + ftdm_channel_t *ftdmchan; + + /* get the ftdmchan and ss7_chan_data from the circuit */ + if (extract_chan_data(circuit, &sngss7_info, &ftdmchan)) { + SS7_ERROR("Failed to extract channel data for circuit = %d!\n", circuit); + SS7_FUNC_TRACE_EXIT(__FUNCTION__); + return FTDM_FAIL; + } + + /* lock the channel */ + ftdm_mutex_lock(ftdmchan->mutex); + + SS7_INFO_CHAN(ftdmchan,"[CIC:%d]Rx Call-Resume msg\n", sngss7_info->circuit->cic); + + /* unlock the channel */ + ftdm_mutex_unlock(ftdmchan->mutex); + + SS7_FUNC_TRACE_EXIT(__FUNCTION__); + return FTDM_SUCCESS; +} + /******************************************************************************/ ftdm_status_t handle_sta_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, uint8_t globalFlg, uint8_t evntType, SiStaEvnt *siStaEvnt) { diff --git a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_in.c b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_in.c index 34893cf5aa..06fae0cd37 100644 --- a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_in.c +++ b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_in.c @@ -52,7 +52,9 @@ void sngss7_dat_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, SiIn void sngss7_fac_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, uint8_t evntType, SiFacEvnt *siFacEvnt); void sngss7_fac_cfm(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, uint8_t evntType, SiFacEvnt *siFacEvnt); void sngss7_umsg_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit); - +void sngss7_resm_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, SiResmEvnt *siResmEvnt); +void sngss7_susp_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, SiSuspEvnt *siSuspEvnt); +void sngss7_ssp_sta_cfm(uint32_t infId); /******************************************************************************/ /* FUNCTIONS ******************************************************************/ @@ -442,7 +444,127 @@ void sngss7_sta_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, uint } /******************************************************************************/ +void sngss7_susp_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, SiSuspEvnt *siSuspEvnt) +{ + SS7_FUNC_TRACE_ENTER(__FUNCTION__); + sngss7_chan_data_t *sngss7_info = NULL; + ftdm_channel_t *ftdmchan = NULL; + sngss7_event_data_t *sngss7_event = NULL; + + /* get the ftdmchan and ss7_chan_data from the circuit */ + if (extract_chan_data(circuit, &sngss7_info, &ftdmchan)) { + SS7_ERROR("Failed to extract channel data for circuit = %d!\n", circuit); + SS7_FUNC_TRACE_EXIT(__FUNCTION__); + return; + } + + /* initalize the sngss7_event */ + sngss7_event = ftdm_malloc(sizeof(*sngss7_event)); + if (sngss7_event == NULL) { + SS7_ERROR("Failed to allocate memory for sngss7_event!\n"); + SS7_FUNC_TRACE_EXIT(__FUNCTION__); + return; + } + memset(sngss7_event, 0x0, sizeof(*sngss7_event)); + + /* fill in the sngss7_event struct */ + sngss7_event->spInstId = spInstId; + sngss7_event->suInstId = suInstId; + sngss7_event->circuit = circuit; + sngss7_event->event_id = SNGSS7_SUSP_IND_EVENT; + if (siSuspEvnt != NULL) { + memcpy(&sngss7_event->event.siSuspEvnt, siSuspEvnt, sizeof(*siSuspEvnt)); + } + + /* enqueue this event */ + ftdm_queue_enqueue(((sngss7_span_data_t*)sngss7_info->ftdmchan->span->mod_data)->event_queue, sngss7_event); + + SS7_FUNC_TRACE_EXIT(__FUNCTION__); + +} + +/******************************************************************************/ +void sngss7_resm_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, SiResmEvnt *siResmEvnt) +{ + SS7_FUNC_TRACE_ENTER(__FUNCTION__); + + sngss7_chan_data_t *sngss7_info = NULL; + ftdm_channel_t *ftdmchan = NULL; + sngss7_event_data_t *sngss7_event = NULL; + + /* get the ftdmchan and ss7_chan_data from the circuit */ + if (extract_chan_data(circuit, &sngss7_info, &ftdmchan)) { + SS7_ERROR("Failed to extract channel data for circuit = %d!\n", circuit); + SS7_FUNC_TRACE_EXIT(__FUNCTION__); + return; + } + + /* initalize the sngss7_event */ + sngss7_event = ftdm_malloc(sizeof(*sngss7_event)); + if (sngss7_event == NULL) { + SS7_ERROR("Failed to allocate memory for sngss7_event!\n"); + SS7_FUNC_TRACE_EXIT(__FUNCTION__); + return; + } + memset(sngss7_event, 0x0, sizeof(*sngss7_event)); + + /* fill in the sngss7_event struct */ + sngss7_event->spInstId = spInstId; + sngss7_event->suInstId = suInstId; + sngss7_event->circuit = circuit; + sngss7_event->event_id = SNGSS7_RESM_IND_EVENT; + if (siResmEvnt != NULL) { + memcpy(&sngss7_event->event.siResmEvnt, siResmEvnt, sizeof(*siResmEvnt)); + } + + /* enqueue this event */ + ftdm_queue_enqueue(((sngss7_span_data_t*)sngss7_info->ftdmchan->span->mod_data)->event_queue, sngss7_event); + + SS7_FUNC_TRACE_EXIT(__FUNCTION__); + +} + +/******************************************************************************/ +void sngss7_ssp_sta_cfm(uint32_t infId) +{ + SS7_FUNC_TRACE_ENTER(__FUNCTION__); +#if 0 + sngss7_chan_data_t *sngss7_info = NULL; + ftdm_channel_t *ftdmchan = NULL; + sngss7_event_data_t *sngss7_event = NULL; + + /* get the ftdmchan and ss7_chan_data from the circuit */ + if (extract_chan_data(circuit, &sngss7_info, &ftdmchan)) { + SS7_ERROR("Failed to extract channel data for circuit = %d!\n", circuit); + SS7_FUNC_TRACE_EXIT(__FUNCTION__); + return; + } + + /* initalize the sngss7_event */ + sngss7_event = ftdm_malloc(sizeof(*sngss7_event)); + if (sngss7_event == NULL) { + SS7_ERROR("Failed to allocate memory for sngss7_event!\n"); + SS7_FUNC_TRACE_EXIT(__FUNCTION__); + return; + } + memset(sngss7_event, 0x0, sizeof(*sngss7_event)); + + /* fill in the sngss7_event struct */ + sngss7_event->spInstId = spInstId; + sngss7_event->suInstId = suInstId; + sngss7_event->circuit = circuit; + sngss7_event->event_id = SNGSS7_RESM_IND_EVENT; + if (siSuspEvnt != NULL) { + memcpy(&sngss7_event->event.siResmEvnt, siResmEvnt, sizeof(*siResmEvnt)); + } + + /* enqueue this event */ + ftdm_queue_enqueue(((sngss7_span_data_t*)sngss7_info->ftdmchan->span->mod_data)->event_queue, sngss7_event); +#endif + SS7_FUNC_TRACE_EXIT(__FUNCTION__); + +} /******************************************************************************/ /* For Emacs: * Local Variables: diff --git a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_main.c b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_main.c index 30cb31691d..587242d94e 100644 --- a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_main.c +++ b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_main.c @@ -208,7 +208,7 @@ ftdm_state_map_t sangoma_ss7_state_map = { {FTDM_CHANNEL_STATE_SUSPENDED, FTDM_CHANNEL_STATE_RESTART, FTDM_CHANNEL_STATE_CANCEL, FTDM_CHANNEL_STATE_TERMINATING, FTDM_CHANNEL_STATE_HANGUP, FTDM_CHANNEL_STATE_PROGRESS, - FTDM_CHANNEL_STATE_UP, FTDM_END} + FTDM_CHANNEL_STATE_PROGRESS_MEDIA ,FTDM_CHANNEL_STATE_UP, FTDM_END} }, { ZSD_OUTBOUND, @@ -448,6 +448,17 @@ static void ftdm_sangoma_ss7_process_stack_event (sngss7_event_data_t *sngss7_ev handle_sta_ind(sngss7_event->suInstId, sngss7_event->spInstId, sngss7_event->circuit, sngss7_event->globalFlg, sngss7_event->evntType, &sngss7_event->event.siStaEvnt); break; /**************************************************************************/ + case (SNGSS7_SUSP_IND_EVENT): + handle_susp_ind(sngss7_event->suInstId, sngss7_event->spInstId, sngss7_event->circuit, &sngss7_event->event.siSuspEvnt); + break; + /**************************************************************************/ + case (SNGSS7_RESM_IND_EVENT): + handle_resm_ind(sngss7_event->suInstId, sngss7_event->spInstId, sngss7_event->circuit, &sngss7_event->event.siResmEvnt); + break; + /**************************************************************************/ + case (SNGSS7_SSP_STA_CFM_EVENT): + break; + /**************************************************************************/ default: SS7_ERROR("Unknown Event Id!\n"); break; @@ -469,6 +480,7 @@ static void ftdm_sangoma_ss7_process_stack_event (sngss7_event_data_t *sngss7_ev void ftdm_sangoma_ss7_process_state_change (ftdm_channel_t * ftdmchan) { sngss7_chan_data_t *sngss7_info = ftdmchan->call_data; + sng_isup_inf_t *isup_intf = NULL; int i = 0; ftdm_sigmsg_t sigev; @@ -589,17 +601,16 @@ void ftdm_sangoma_ss7_process_state_change (ftdm_channel_t * ftdmchan) } /*check if the channel is inbound or outbound */ - if (ftdm_test_flag (ftdmchan, FTDM_CHANNEL_OUTBOUND)) { + if (ftdm_test_flag (ftdmchan, FTDM_CHANNEL_OUTBOUND)) { /*OUTBOUND...so we were told by the line of this so noifiy the user */ sigev.event_id = FTDM_SIGEVENT_PROGRESS; ftdm_span_send_signal (ftdmchan->span, &sigev); + /* move to progress media */ ftdm_set_state_locked (ftdmchan, FTDM_CHANNEL_STATE_PROGRESS_MEDIA); } else { /* inbound call so we need to send out ACM */ - ft_to_sngss7_acm (ftdmchan); - - ftdm_set_state_locked (ftdmchan, FTDM_CHANNEL_STATE_PROGRESS_MEDIA); + ft_to_sngss7_acm(ftdmchan); } break; @@ -611,6 +622,13 @@ void ftdm_sangoma_ss7_process_state_change (ftdm_channel_t * ftdmchan) break; } + if (ftdm_test_flag (ftdmchan, FTDM_CHANNEL_OUTBOUND)) { + /* inform the user there is media avai */ + sigev.event_id = FTDM_SIGEVENT_PROGRESS_MEDIA; + ftdm_span_send_signal (ftdmchan->span, &sigev); + } + + /* nothing to do at this time */ break; /**************************************************************************/ @@ -1155,11 +1173,15 @@ suspend_goto_restart: ftdm_set_state_locked (ftdmchan, FTDM_CHANNEL_STATE_RESTART); break; -/**************************************************************************/ + /**************************************************************************/ case FTDM_CHANNEL_STATE_IN_LOOP: /* COT test */ - /* send the lpa */ - ft_to_sngss7_lpa (ftdmchan); + isup_intf = &g_ftdm_sngss7_data.cfg.isupIntf[sngss7_info->circuit->infId]; + + if (sngss7_test_options(isup_intf, SNGSS7_LPA_FOR_COT)) { + /* send the lpa */ + ft_to_sngss7_lpa (ftdmchan); + } break; /**************************************************************************/ @@ -1332,7 +1354,7 @@ static ftdm_status_t ftdm_sangoma_ss7_start(ftdm_span_t * span) sngss7_clear_flag(sngss7_info, FLAG_INFID_PAUSED); sngss7_set_flag(sngss7_info, FLAG_INFID_RESUME); } -#if 1 +#if 0 /* throw the grp reset flag */ sngss7_set_flag(sngss7_info, FLAG_GRP_RESET_TX); if (x == 1) { @@ -1480,7 +1502,7 @@ static FIO_SIG_LOAD_FUNCTION(ftdm_sangoma_ss7_init) sngss7_id = 0; - cmbLinkSetId = 1; + cmbLinkSetId = 0; /* initalize the global gen_config flag */ g_ftdm_sngss7_data.gen_config = 0; @@ -1507,9 +1529,9 @@ static FIO_SIG_LOAD_FUNCTION(ftdm_sangoma_ss7_init) sng_event.cc.sng_fac_cfm = sngss7_fac_cfm; sng_event.cc.sng_sta_ind = sngss7_sta_ind; sng_event.cc.sng_umsg_ind = sngss7_umsg_ind; - sng_event.cc.sng_susp_ind = NULL; - sng_event.cc.sng_resm_ind = NULL; - sng_event.cc.sng_ssp_sta_cfm = NULL; + sng_event.cc.sng_susp_ind = sngss7_susp_ind; + sng_event.cc.sng_resm_ind = sngss7_resm_ind; + sng_event.cc.sng_ssp_sta_cfm = sngss7_ssp_sta_cfm; sng_event.sm.sng_log = handle_sng_log; sng_event.sm.sng_mtp1_alarm = handle_sng_mtp1_alarm; diff --git a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_main.h b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_main.h index a358236ed0..27833cb2a2 100644 --- a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_main.h +++ b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_main.h @@ -58,6 +58,8 @@ #define SNGSS7_EVENT_QUEUE_SIZE 100 +#define MAX_SIZEOF_SUBADDR_IE 24 /* as per Q931 4.5.9 */ + typedef enum { SNGSS7_CON_IND_EVENT = 0, SNGSS7_CON_CFM_EVENT, @@ -68,7 +70,10 @@ typedef enum { SNGSS7_FAC_IND_EVENT, SNGSS7_FAC_CFM_EVENT, SNGSS7_UMSG_IND_EVENT, - SNGSS7_STA_IND_EVENT + SNGSS7_STA_IND_EVENT, + SNGSS7_SUSP_IND_EVENT, + SNGSS7_RESM_IND_EVENT, + SNGSS7_SSP_STA_CFM_EVENT } sng_event_type_t; typedef enum { @@ -83,6 +88,16 @@ typedef enum { SNGSS7_PAUSED = (1 << 7) } sng_flag_t; +typedef enum { + SNGSS7_LPA_FOR_COT = (1 << 0), /* send LPA when COT arrives */ + SNGSS7_ACM_OBCI_BITA = (1 << 10) /* in-band indication */ +} sng_intf_options_t; + +typedef enum { + SNG_CALLED = 1, + SNG_CALLING = 2 +} sng_addr_type_t; + typedef struct sng_mtp_link { char name[MAX_NAME_LEN]; uint32_t id; @@ -198,6 +213,7 @@ typedef struct sng_route { typedef struct sng_isup_intf { uint32_t id; char name[MAX_NAME_LEN]; + uint32_t options; uint32_t flags; uint32_t spc; uint32_t dpc; @@ -385,6 +401,8 @@ typedef struct sngss7_event_data SiInfoEvnt siInfoEvnt; SiFacEvnt siFacEvnt; SiStaEvnt siStaEvnt; + SiSuspEvnt siSuspEvnt; + SiResmEvnt siResmEvnt; } event; } sngss7_event_data_t; @@ -514,6 +532,9 @@ void sngss7_fac_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, uint void sngss7_fac_cfm(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, uint8_t evntType, SiFacEvnt *siFacEvnt); void sngss7_sta_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, uint8_t globalFlg, uint8_t evntType, SiStaEvnt *siStaEvnt); void sngss7_umsg_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit); +void sngss7_resm_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, SiResmEvnt *siResmEvnt); +void sngss7_susp_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, SiSuspEvnt *siSuspEvnt); +void sngss7_ssp_sta_cfm(uint32_t infId); /* in ftmod_sangoma_ss7_handle.c */ ftdm_status_t handle_con_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, SiConEvnt *siConEvnt); @@ -525,6 +546,8 @@ ftdm_status_t handle_dat_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circ ftdm_status_t handle_fac_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, uint8_t evntType, SiFacEvnt *siFacEvnt); ftdm_status_t handle_fac_cfm(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, uint8_t evntType, SiFacEvnt *siFacEvnt); ftdm_status_t handle_umsg_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit); +ftdm_status_t handle_susp_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, SiSuspEvnt *siSuspEvnt); +ftdm_status_t handle_resm_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, SiResmEvnt *siResmEvnt); ftdm_status_t handle_sta_ind(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, uint8_t globalFlg, uint8_t evntType, SiStaEvnt *siStaEvnt); ftdm_status_t handle_reattempt(uint32_t suInstId, uint32_t spInstId, uint32_t circuit, uint8_t globalFlg, uint8_t evntType, SiStaEvnt *siStaEvnt); @@ -579,6 +602,8 @@ ftdm_status_t clear_rx_grs_data(sngss7_chan_data_t *sngss7_info); ftdm_status_t clear_rx_gra_data(sngss7_chan_data_t *sngss7_info); ftdm_status_t clear_tx_grs_data(sngss7_chan_data_t *sngss7_info); +ftdm_status_t encode_subAddrIE_nsap(const char *subAddr, char *subAddrIE, int type); +ftdm_status_t encode_subAddrIE_nat(const char *subAddr, char *subAddrIE, int type); /* in ftmod_sangoma_ss7_timers.c */ void handle_isup_t35(void *userdata); @@ -712,6 +737,11 @@ void handle_isup_t35(void *userdata); #define sngss7_clear_flag(obj, flag) ((obj)->flags &= ~(flag)) #define sngss7_set_flag(obj, flag) ((obj)->flags |= (flag)) +#define sngss7_test_options(obj, option) ((obj)->options & option) +#define sngss7_clear_options(obj, option) ((obj)->options &= ~(option)) +#define sngss7_set_options(obj, option) ((obj)->options |= (option)) + + #ifdef SS7_PRODUCTION # define SS7_ASSERT \ SS7_INFO_CHAN(ftdmchan,"Production Mode, continuing%s\n", ""); diff --git a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_out.c b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_out.c index 973fbf47c7..8cbe6d9498 100644 --- a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_out.c +++ b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_out.c @@ -76,6 +76,9 @@ void ft_to_sngss7_iam (ftdm_channel_t * ftdmchan) sngss7_chan_data_t *sngss7_info = ftdmchan->call_data;; const char *clg_nadi = NULL; const char *cld_nadi = NULL; + const char *clg_subAddr = NULL; + const char *cld_subAddr = NULL; + char subAddrIE[MAX_SIZEOF_SUBADDR_IE]; SiConEvnt iam; sngss7_info->suInstId = get_unique_id (); @@ -186,7 +189,7 @@ void ft_to_sngss7_iam (ftdm_channel_t * ftdmchan) /* check if the user would like a custom NADI value for the calling Pty Num */ clg_nadi = ftdm_channel_get_var(ftdmchan, "ss7_clg_nadi"); if ((clg_nadi != NULL) && (*clg_nadi)) { - SS7_DEBUG_CHAN(ftdmchan,"Found user supplied NADI value \"%s\"\n", clg_nadi); + SS7_DEBUG_CHAN(ftdmchan,"Found user supplied Calling NADI value \"%s\"\n", clg_nadi); iam.cgPtyNum.natAddrInd.val = atoi(clg_nadi); } else { iam.cgPtyNum.natAddrInd.val = g_ftdm_sngss7_data.cfg.isupIntf[sngss7_info->circuit->infId].clg_nadi; @@ -195,14 +198,93 @@ void ft_to_sngss7_iam (ftdm_channel_t * ftdmchan) cld_nadi = ftdm_channel_get_var(ftdmchan, "ss7_cld_nadi"); if ((cld_nadi != NULL) && (*cld_nadi)) { - SS7_DEBUG_CHAN(ftdmchan,"Found user supplied NADI value \"%s\"\n", cld_nadi); + SS7_DEBUG_CHAN(ftdmchan,"Found user supplied Called NADI value \"%s\"\n", cld_nadi); iam.cdPtyNum.natAddrInd.val = atoi(cld_nadi); } else { iam.cdPtyNum.natAddrInd.val = g_ftdm_sngss7_data.cfg.isupIntf[sngss7_info->circuit->infId].cld_nadi; SS7_DEBUG_CHAN(ftdmchan,"No user supplied NADI value found for CLD, using \"%d\"\n", iam.cdPtyNum.natAddrInd.val); - } + /* check if the user would like us to send a clg_sub-address */ + clg_subAddr = ftdm_channel_get_var(ftdmchan, "ss7_clg_subaddr"); + if ((clg_subAddr != NULL) && (*clg_subAddr)) { + SS7_DEBUG_CHAN(ftdmchan,"Found user supplied Calling Sub-Address value \"%s\"\n", clg_subAddr); + + /* clean out the subAddrIE */ + memset(subAddrIE, 0x0, sizeof(subAddrIE)); + + /* check the first character in the sub-address to see what type of encoding to use */ + switch (clg_subAddr[0]) { + case '0': /* NSAP */ + encode_subAddrIE_nsap(&clg_subAddr[1], subAddrIE, SNG_CALLING); + break; + case '1': /* national variant */ + encode_subAddrIE_nat(&clg_subAddr[1], subAddrIE, SNG_CALLING); + break; + default: + SS7_ERROR_CHAN(ftdmchan,"Invalid Calling Sub-Address encoding requested: %c\n", clg_subAddr[0]); + break; + } /* switch (cld_subAddr[0]) */ + + + /* if subaddIE is still empty don't copy it in */ + if (subAddrIE[0] != '0') { + /* check if the clg_subAddr has already been added */ + if (iam.accTrnspt.eh.pres == PRSNT_NODEF) { + /* append the subAddrIE */ + memcpy(&iam.accTrnspt.infoElmts.val[iam.accTrnspt.infoElmts.len], subAddrIE, (subAddrIE[1] + 2)); + iam.accTrnspt.infoElmts.len = iam.accTrnspt.infoElmts.len +subAddrIE[1] + 2; + } else { + /* fill in from the beginning */ + iam.accTrnspt.eh.pres = PRSNT_NODEF; + iam.accTrnspt.infoElmts.pres = PRSNT_NODEF; + memcpy(iam.accTrnspt.infoElmts.val, subAddrIE, (subAddrIE[1] + 2)); + iam.accTrnspt.infoElmts.len = subAddrIE[1] + 2; + } /* if (iam.accTrnspt.eh.pres */ + } /* if (subAddrIE[0] != '0') */ + } + + /* check if the user would like us to send a cld_sub-address */ + cld_subAddr = ftdm_channel_get_var(ftdmchan, "ss7_cld_subaddr"); + if ((cld_subAddr != NULL) && (*cld_subAddr)) { + SS7_DEBUG_CHAN(ftdmchan,"Found user supplied Called Sub-Address value \"%s\"\n", cld_subAddr); + + /* clean out the subAddrIE */ + memset(subAddrIE, 0x0, sizeof(subAddrIE)); + + /* check the first character in the sub-address to see what type of encoding to use */ + switch (cld_subAddr[0]) { + case '0': /* NSAP */ + encode_subAddrIE_nsap(&cld_subAddr[1], subAddrIE, SNG_CALLED); + break; + case '1': /* national variant */ + encode_subAddrIE_nat(&cld_subAddr[1], subAddrIE, SNG_CALLED); + break; + default: + SS7_ERROR_CHAN(ftdmchan,"Invalid Called Sub-Address encoding requested: %c\n", cld_subAddr[0]); + break; + } /* switch (cld_subAddr[0]) */ + + /* if subaddIE is still empty don't copy it in */ + if (subAddrIE[0] != '0') { + /* check if the cld_subAddr has already been added */ + if (iam.accTrnspt.eh.pres == PRSNT_NODEF) { + /* append the subAddrIE */ + memcpy(&iam.accTrnspt.infoElmts.val[iam.accTrnspt.infoElmts.len], subAddrIE, (subAddrIE[1] + 2)); + iam.accTrnspt.infoElmts.len = iam.accTrnspt.infoElmts.len +subAddrIE[1] + 2; + } else { + /* fill in from the beginning */ + iam.accTrnspt.eh.pres = PRSNT_NODEF; + iam.accTrnspt.infoElmts.pres = PRSNT_NODEF; + memcpy(iam.accTrnspt.infoElmts.val, subAddrIE, (subAddrIE[1] + 2)); + iam.accTrnspt.infoElmts.len = subAddrIE[1] + 2; + } /* if (iam.accTrnspt.eh.pres */ + } /* if (subAddrIE[0] != '0') */ + } /* if ((cld_subAddr != NULL) && (*cld_subAddr)) */ + + + + sng_cc_con_request (sngss7_info->spId, sngss7_info->suInstId, sngss7_info->spInstId, @@ -226,7 +308,8 @@ void ft_to_sngss7_acm (ftdm_channel_t * ftdmchan) { SS7_FUNC_TRACE_ENTER (__FUNCTION__); - sngss7_chan_data_t *sngss7_info = ftdmchan->call_data; + sngss7_chan_data_t *sngss7_info = ftdmchan->call_data; + sng_isup_inf_t *isup_intf = &g_ftdm_sngss7_data.cfg.isupIntf[sngss7_info->circuit->infId]; SiCnStEvnt acm; memset (&acm, 0x0, sizeof (acm)); @@ -255,7 +338,18 @@ void ft_to_sngss7_acm (ftdm_channel_t * ftdmchan) acm.bckCallInd.echoCtrlDevInd.val = 0x1; /* ec device present */ acm.bckCallInd.sccpMethInd.pres = PRSNT_NODEF; acm.bckCallInd.sccpMethInd.val = SCCPMTH_NOIND; - + + /* fill in any optional parameters */ + if (sngss7_test_options(isup_intf, SNGSS7_ACM_OBCI_BITA)) { + acm.optBckCalInd.eh.pres = PRSNT_NODEF; + acm.optBckCalInd.inbndInfoInd.pres = PRSNT_NODEF; + acm.optBckCalInd.inbndInfoInd.val = sngss7_test_options(isup_intf, SNGSS7_ACM_OBCI_BITA); + acm.optBckCalInd.caFwdMayOcc.pres = PRSNT_DEF; + acm.optBckCalInd.simpleSegmInd.pres = PRSNT_DEF; + acm.optBckCalInd.mlppUserInd.pres = PRSNT_DEF; + acm.optBckCalInd.usrNetIneractInd.pres = PRSNT_DEF; + } /* if (sngss7_test_options(isup_intf, SNGSS7_ACM_OBCI_BITA)) */ + /* send the ACM request to LibSngSS7 */ sng_cc_con_status (1, sngss7_info->suInstId, diff --git a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_sta.c b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_sta.c index d238462046..1235238452 100644 --- a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_sta.c +++ b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_sta.c @@ -50,27 +50,41 @@ int ftmod_ss7_mtplinkSet_sta(uint32_t id, SnMngmt *cfm); int ftmod_ss7_mtplink_sta(uint32_t id, SnMngmt *cfm) { SnMngmt sta; + Pst pst; memset(&sta, 0x0, sizeof(sta)); + /* initalize the post structure */ + smPstInit(&pst); + + /* insert the destination Entity */ + pst.dstEnt = ENTSN; + sta.hdr.elmId.elmnt = STDLSAP; sta.hdr.elmId.elmntInst1 = g_ftdm_sngss7_data.cfg.mtpLink[id].id; - return(sng_sta_mtp3(&sta, cfm)); + return(sng_sta_mtp3(&pst, &sta, cfm)); } /******************************************************************************/ int ftmod_ss7_mtplinkSet_sta(uint32_t id, SnMngmt *cfm) { SnMngmt sta; + Pst pst; memset(&sta, 0x0, sizeof(sta)); + /* initalize the post structure */ + smPstInit(&pst); + + /* insert the destination Entity */ + pst.dstEnt = ENTSN; + sta.hdr.elmId.elmnt = STLNKSET; sta.hdr.elmId.elmntInst1 = g_ftdm_sngss7_data.cfg.mtpLinkSet[id].id; sta.hdr.elmId.elmntInst2 = g_ftdm_sngss7_data.cfg.mtpLinkSet[id].links[0]; - return(sng_sta_mtp3(&sta, cfm)); + return(sng_sta_mtp3(&pst, &sta, cfm)); } /******************************************************************************/ diff --git a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_support.c b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_support.c index 41db1fe140..718663950a 100644 --- a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_support.c +++ b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_support.c @@ -71,6 +71,9 @@ ftdm_status_t clear_tx_rsc_flags(sngss7_chan_data_t *sngss7_info); ftdm_status_t clear_rx_grs_data(sngss7_chan_data_t *sngss7_info); ftdm_status_t clear_rx_gra_data(sngss7_chan_data_t *sngss7_info); ftdm_status_t clear_tx_grs_data(sngss7_chan_data_t *sngss7_info); + +ftdm_status_t encode_subAddrIE_nsap(const char *subAddr, char *subAddrIE, int type); +ftdm_status_t encode_subAddrIE_nat(const char *subAddr, char *subAddrIE, int type); /******************************************************************************/ /* FUNCTIONS ******************************************************************/ @@ -884,6 +887,214 @@ ftdm_status_t clear_tx_rsc_flags(sngss7_chan_data_t *sngss7_info) } /******************************************************************************/ +ftdm_status_t encode_subAddrIE_nsap(const char *subAddr, char *subAddrIE, int type) +{ + /* Q931 4.5.9 + * 8 7 6 5 4 3 2 1 (octet) + * + * 0 1 1 1 0 0 0 1 (spare 8) ( IE id 1-7) + * X X X X X X X X (length of IE contents) + * 1 0 0 0 Z 0 0 0 (ext 8) (NSAP type 5-7) (odd/even 4) (spare 1-3) + * X X X X X X X X (sub address encoded in ia5) + */ + + int x = 0; + int p = 0; + int len = 0; + char tmp[2]; + + /* initalize the second element of tmp to \0 so that atoi doesn't go to far */ + tmp[1]='\0'; + + /* set octet 1 aka IE id */ + p = 0; + switch(type) { + /**************************************************************************/ + case SNG_CALLED: /* called party sub address */ + subAddrIE[p] = 0x71; + break; + /**************************************************************************/ + case SNG_CALLING: /* calling party sub address */ + subAddrIE[p] = 0x6d; + break; + /**************************************************************************/ + default: /* not good */ + SS7_ERROR("Sub-Address type is invalid: %d\n", type); + return FTDM_FAIL; + break; + /**************************************************************************/ + } /* switch(type) */ + + /* set octet 3 aka type and o/e */ + p = 2; + subAddrIE[p] = 0x80; + + /* set the subAddrIE pointer octet 4 */ + p = 3; + + /* loop through all digits in subAddr and insert them into subAddrIE */ + while (subAddr[x] != '\0') { + + /* grab a character */ + tmp[0] = subAddr[x]; + + /* confirm it is a digit */ + if (!isdigit(tmp[0])) { + /* move to the next character in subAddr */ + x++; + + /* restart the loop */ + continue; + } + + /* convert the character to IA5 encoding and write into subAddrIE */ + subAddrIE[p] = atoi(&tmp[0]); /* lower nibble is the digit */ + subAddrIE[p] |= 0x3 << 4; /* upper nibble is 0x3 */ + + /* increment address length counter */ + len++; + + /* increment the subAddrIE pointer */ + p++; + + /* move to the next character in subAddr */ + x++; + + } /* while (subAddr[x] != '\0') */ + + /* set octet 2 aka length of subaddr */ + p = 1; + subAddrIE[p] = len + 1; + + + return FTDM_SUCCESS; +} + +/******************************************************************************/ +ftdm_status_t encode_subAddrIE_nat(const char *subAddr, char *subAddrIE, int type) +{ + /* Q931 4.5.9 + * 8 7 6 5 4 3 2 1 (octet) + * + * 0 1 1 1 0 0 0 1 (spare 8) ( IE id 1-7) + * X X X X X X X X (length of IE contents) + * 1 0 0 0 Z 0 0 0 (ext 8) (NSAP type 5-7) (odd/even 4) (spare 1-3) + * X X X X X X X X (sub address encoded in ia5) + */ + + int x = 0; + int p = 0; + int len = 0; + char tmp[2]; + int flag = 0; + int odd = 0; + uint8_t lower = 0x0; + uint8_t upper = 0x0; + + /* initalize the second element of tmp to \0 so that atoi doesn't go to far */ + tmp[1]='\0'; + + /* set octet 1 aka IE id */ + p = 0; + switch(type) { + /**************************************************************************/ + case SNG_CALLED: /* called party sub address */ + subAddrIE[p] = 0x71; + break; + /**************************************************************************/ + case SNG_CALLING: /* calling party sub address */ + subAddrIE[p] = 0x6d; + break; + /**************************************************************************/ + default: /* not good */ + SS7_ERROR("Sub-Address type is invalid: %d\n", type); + return FTDM_FAIL; + break; + /**************************************************************************/ + } /* switch(type) */ + + /* set the subAddrIE pointer octet 4 */ + p = 3; + + /* loop through all digits in subAddr and insert them into subAddrIE */ + while (1) { + + /* grab a character */ + tmp[0] = subAddr[x]; + + /* confirm it is a hex digit */ + while ((!isxdigit(tmp[0])) && (tmp[0] != '\0')) { + /* move to the next character in subAddr */ + x++; + tmp[0] = subAddr[x]; + } + + /* check if tmp is null or a digit */ + if (tmp[0] != '\0') { + /* push it into the lower nibble using strtol to allow a-f chars */ + lower = strtol(&tmp[0], (char **)NULL, 16); + /* move to the next digit */ + x++; + /* grab a digit from the ftdm digits */ + tmp[0] = subAddr[x]; + + /* check if the digit is a hex digit and that is not null */ + while (!(isxdigit(tmp[0])) && (tmp[0] != '\0')) { + x++; + tmp[0] = subAddr[x]; + } /* while(!(isdigit(tmp))) */ + + /* check if tmp is null or a digit */ + if (tmp[0] != '\0') { + /* push the digit into the upper nibble using strtol to allow a-f chars */ + upper = (strtol(&tmp[0], (char **)NULL, 16)) << 4; + } else { + /* there is no upper ... fill in spare */ + upper = 0x00; + /* throw the odd flag since we need to buffer */ + odd = 1; + /* throw the end flag */ + flag = 1; + } /* if (tmp != '\0') */ + } else { + /* keep the odd flag down */ + odd = 0; + + /* throw the flag */ + flag = 1; + + /* bounce out right away */ + break; + } + + /* fill in the octet */ + subAddrIE[p] = upper | lower; + + /* increment address length counter */ + len++; + + /* if the flag is we're through all the digits */ + if (flag) break; + + /* increment the subAddrIE pointer */ + p++; + + /* move to the next character in subAddr */ + x++; + + } /* while (subAddr[x] != '\0') */ + + /* set octet 2 aka length of subaddr */ + p = 1; + subAddrIE[p] = len + 1; + + /* set octet 3 aka type and o/e */ + p = 2; + subAddrIE[p] = 0xa0 | (odd << 3); + + + return FTDM_SUCCESS; +} /******************************************************************************/ /* For Emacs: diff --git a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_xml.c b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_xml.c index 359055fe2a..0f81d61f25 100644 --- a/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_xml.c +++ b/libs/freetdm/src/ftmod/ftmod_sangoma_ss7/ftmod_sangoma_ss7_xml.c @@ -1249,6 +1249,30 @@ static int ftmod_ss7_parse_isup_interface(ftdm_conf_node_t *isup_interface) sng_isup.cld_nadi = atoi(parm->val); SS7_DEBUG("\tFound default CLD_NADI value = %d\n", sng_isup.cld_nadi); /**********************************************************************/ + } else if (!strcasecmp(parm->var, "obci_bita")) { + /**********************************************************************/ + if (*parm->val == '1') { + sngss7_set_options(&sng_isup, SNGSS7_ACM_OBCI_BITA); + SS7_DEBUG("\tFound Optional Backwards Indicator: Bit A (early media) enable option\n"); + } else if (*parm->val == '0') { + sngss7_clear_options(&sng_isup, SNGSS7_ACM_OBCI_BITA); + SS7_DEBUG("\tFound Optional Backwards Indicator: Bit A (early media) disable option\n"); + } else { + SS7_DEBUG("\tInvalid value for \"obci_bita\" option\n"); + } + /**********************************************************************/ + } else if (!strcasecmp(parm->var, "lpa_on_cot")) { + /**********************************************************************/ + if (*parm->val == '1') { + sngss7_set_options(&sng_isup, SNGSS7_LPA_FOR_COT); + SS7_DEBUG("\tFound Tx LPA on COT enable option\n"); + } else if (*parm->val == '0') { + sngss7_clear_options(&sng_isup, SNGSS7_LPA_FOR_COT); + SS7_DEBUG("\tFound Tx LPA on COT disable option\n"); + } else { + SS7_DEBUG("\tInvalid value for \"lpa_on_cot\" option\n"); + } + /**********************************************************************/ } else { SS7_ERROR("\tFound an invalid parameter \"%s\"!\n", parm->val); return FTDM_FAIL; @@ -1671,7 +1695,7 @@ static int ftmod_ss7_fill_in_isup_interface(sng_isup_inf_t *sng_isup) g_ftdm_sngss7_data.cfg.isupIntf[i].isap = sng_isup->isap; g_ftdm_sngss7_data.cfg.isupIntf[i].cld_nadi = sng_isup->cld_nadi; g_ftdm_sngss7_data.cfg.isupIntf[i].clg_nadi = sng_isup->clg_nadi; - + g_ftdm_sngss7_data.cfg.isupIntf[i].options = sng_isup->options; if (sng_isup->t4 != 0) { g_ftdm_sngss7_data.cfg.isupIntf[i].t4 = sng_isup->t4; } else { diff --git a/libs/freetdm/src/ftmod/ftmod_wanpipe/ftmod_wanpipe.c b/libs/freetdm/src/ftmod/ftmod_wanpipe/ftmod_wanpipe.c index 23463e9088..314a34a091 100644 --- a/libs/freetdm/src/ftmod/ftmod_wanpipe/ftmod_wanpipe.c +++ b/libs/freetdm/src/ftmod/ftmod_wanpipe/ftmod_wanpipe.c @@ -1166,6 +1166,11 @@ FIO_SPAN_NEXT_EVENT_FUNCTION(wanpipe_next_event) char tmp_dtmf[2] = { tdm_api.wp_tdm_cmd.event.wp_tdm_api_event_dtmf_digit, 0 }; event_id = FTDM_OOB_NOOP; + if (tmp_dtmf[0] == 'f') { + ftdm_log_chan(ftdmchan, FTDM_LOG_DEBUG, "Ignoring wanpipe DTMF: %c, fax tones will be passed through!\n", tmp_dtmf[0]); + break; + } + if (tdm_api.wp_tdm_cmd.event.wp_tdm_api_event_dtmf_type == WAN_EC_TONE_PRESENT) { ftdm_set_flag_locked(ftdmchan, FTDM_CHANNEL_MUTE); } diff --git a/libs/openzap/src/ozmod/ozmod_wanpipe/ozmod_wanpipe.c b/libs/openzap/src/ozmod/ozmod_wanpipe/ozmod_wanpipe.c index 40cf2a5a7c..8423aac34b 100644 --- a/libs/openzap/src/ozmod/ozmod_wanpipe/ozmod_wanpipe.c +++ b/libs/openzap/src/ozmod/ozmod_wanpipe/ozmod_wanpipe.c @@ -1119,7 +1119,14 @@ ZIO_SPAN_NEXT_EVENT_FUNCTION(wanpipe_next_event) event_id = ZAP_OOB_NOOP; //zap_log(ZAP_LOG_WARNING, "%d:%d queue hardware dtmf %s %s\n", zchan->span_id, zchan->chan_id, tmp_dtmf, - //tdm_api.wp_tdm_cmd.event.wp_tdm_api_event_dtmf_type == WAN_EC_TONE_PRESENT ? "on" : "off"); + //tdm_api.wp_tdm_cmd.event.wp_tdm_api_event_dtmf_type == WAN_EC_TONE_PRESENT ? "on" : "off"); + if (tmp_dtmf[0] == 'f') { + if (zap_test_flag(zchan, ZAP_CHANNEL_INUSE)) { + zap_channel_queue_dtmf(zchan, tmp_dtmf); + } + break; + } + if (tdm_api.wp_tdm_cmd.event.wp_tdm_api_event_dtmf_type == WAN_EC_TONE_PRESENT) { zap_set_flag_locked(zchan, ZAP_CHANNEL_MUTE); } diff --git a/libs/win32/json/libjson.2008.vcproj b/libs/win32/json/libjson.2008.vcproj index 91a371b48c..5c09e5413c 100644 --- a/libs/win32/json/libjson.2008.vcproj +++ b/libs/win32/json/libjson.2008.vcproj @@ -172,7 +172,7 @@ Optimization="2" EnableIntrinsicFunctions="true" AdditionalIncludeDirectories="." - PreprocessorDefinitions="WIN32;_DEBUG;_LIB;HAVE_CONFIG_H;HAVE_STDARG_H;STDC_HEADERS" + PreprocessorDefinitions="WIN32;NDEBUG;_LIB;HAVE_CONFIG_H;HAVE_STDARG_H;STDC_HEADERS" RuntimeLibrary="2" EnableFunctionLevelLinking="true" UsePrecompiledHeader="0" @@ -236,7 +236,7 @@ Optimization="2" EnableIntrinsicFunctions="true" AdditionalIncludeDirectories="." - PreprocessorDefinitions="WIN32;_DEBUG;_LIB;HAVE_CONFIG_H;HAVE_STDARG_H;STDC_HEADERS" + PreprocessorDefinitions="WIN32;NDEBUG;_LIB;HAVE_CONFIG_H;HAVE_STDARG_H;STDC_HEADERS" RuntimeLibrary="2" EnableFunctionLevelLinking="true" UsePrecompiledHeader="0" diff --git a/libs/win32/json/libjson.2010.vcxproj b/libs/win32/json/libjson.2010.vcxproj index 5846ff3e92..a371ac2f46 100644 --- a/libs/win32/json/libjson.2010.vcxproj +++ b/libs/win32/json/libjson.2010.vcxproj @@ -96,7 +96,7 @@ MaxSpeed true .;%(AdditionalIncludeDirectories) - WIN32;_DEBUG;_LIB;HAVE_CONFIG_H;HAVE_STDARG_H;STDC_HEADERS;%(PreprocessorDefinitions) + WIN32;NDEBUG;_LIB;HAVE_CONFIG_H;HAVE_STDARG_H;STDC_HEADERS;%(PreprocessorDefinitions) MultiThreadedDLL true Level3 @@ -110,7 +110,7 @@ MaxSpeed true .;%(AdditionalIncludeDirectories) - WIN32;_DEBUG;_LIB;HAVE_CONFIG_H;HAVE_STDARG_H;STDC_HEADERS;%(PreprocessorDefinitions) + WIN32;NDEBUG;_LIB;HAVE_CONFIG_H;HAVE_STDARG_H;STDC_HEADERS;%(PreprocessorDefinitions) MultiThreadedDLL true Level3 diff --git a/src/include/private/switch_core_pvt.h b/src/include/private/switch_core_pvt.h index ea02f22fa0..3df9001b0c 100644 --- a/src/include/private/switch_core_pvt.h +++ b/src/include/private/switch_core_pvt.h @@ -193,6 +193,11 @@ struct switch_media_bug { struct switch_media_bug *next; }; +typedef enum { + DBTYPE_DEFAULT = 0, + DBTYPE_MSSQL = 1, +} switch_dbtype_t; + struct switch_runtime { switch_time_t initiated; switch_time_t reference; @@ -237,6 +242,7 @@ struct switch_runtime { double min_idle_time; int sql_buffer_len; int max_sql_buffer_len; + switch_dbtype_t odbc_dbtype; }; extern struct switch_runtime runtime; diff --git a/src/include/switch_event.h b/src/include/switch_event.h index 1864e397e6..41bc75cada 100644 --- a/src/include/switch_event.h +++ b/src/include/switch_event.h @@ -345,11 +345,15 @@ SWITCH_DECLARE(switch_status_t) switch_event_create_pres_in_detailed(_In_z_ char */ #define switch_event_create(event, id) switch_event_create_subclass(event, id, SWITCH_EVENT_SUBCLASS_ANY) - static inline switch_status_t switch_event_create_plain(switch_event_t **event, switch_event_types_t event_id) +static inline switch_status_t switch_event_create_plain(switch_event_t **event, switch_event_types_t event_id) { switch_status_t status = switch_event_create(event, SWITCH_EVENT_CLONE); if (status == SWITCH_STATUS_SUCCESS) { (*event)->event_id = event_id; + + if (event_id == SWITCH_EVENT_REQUEST_PARAMS || event_id == SWITCH_EVENT_CHANNEL_DATA) { + (*event)->flags |= EF_UNIQ_HEADERS; + } } return status; diff --git a/src/include/switch_odbc.h b/src/include/switch_odbc.h index 81039f113d..b8d4bc2f17 100644 --- a/src/include/switch_odbc.h +++ b/src/include/switch_odbc.h @@ -58,6 +58,8 @@ SWITCH_DECLARE(switch_odbc_status_t) switch_odbc_handle_exec(switch_odbc_handle_ char **err); SWITCH_DECLARE(switch_odbc_status_t) switch_odbc_handle_exec_string(switch_odbc_handle_t *handle, const char *sql, char *resbuf, size_t len, char **err); SWITCH_DECLARE(switch_bool_t) switch_odbc_available(void); +SWITCH_DECLARE(switch_odbc_status_t) switch_odbc_SQLSetAutoCommitAttr(switch_odbc_handle_t *handle, switch_bool_t on); +SWITCH_DECLARE(switch_odbc_status_t) switch_odbc_SQLEndTran(switch_odbc_handle_t *handle, switch_bool_t commit); SWITCH_DECLARE(switch_odbc_status_t) switch_odbc_statement_handle_free(switch_odbc_statement_handle_t *stmt); /*! diff --git a/src/include/switch_utils.h b/src/include/switch_utils.h index 945583ee07..924dcd2b9b 100644 --- a/src/include/switch_utils.h +++ b/src/include/switch_utils.h @@ -322,7 +322,7 @@ SWITCH_DECLARE(unsigned char) switch_char_to_rfc2833(char key); \param key the key to test \return TRUE or FALSE */ -#define is_dtmf(key) ((key > 47 && key < 58) || (key > 64 && key < 69) || (key > 96 && key < 101) || key == 35 || key == 42 || key == 87 || key == 119 || key == 70) +#define is_dtmf(key) ((key > 47 && key < 58) || (key > 64 && key < 69) || (key > 96 && key < 101) || key == 35 || key == 42 || key == 87 || key == 119 || key == 70 || key == 102) #define end_of(_s) *(*_s == '\0' ? _s : _s + strlen(_s) - 1) #define end_of_p(_s) (*_s == '\0' ? _s : _s + strlen(_s) - 1) diff --git a/src/mod/applications/mod_callcenter/mod_callcenter.c b/src/mod/applications/mod_callcenter/mod_callcenter.c index 56c817ab33..5abc567149 100644 --- a/src/mod/applications/mod_callcenter/mod_callcenter.c +++ b/src/mod/applications/mod_callcenter/mod_callcenter.c @@ -850,7 +850,7 @@ cc_status_t cc_agent_del(const char *agent) return result; } -cc_agent_status_t cc_agent_get(const char *key, const char *agent, char *ret_result, size_t ret_result_size) +cc_status_t cc_agent_get(const char *key, const char *agent, char *ret_result, size_t ret_result_size) { cc_status_t result = CC_STATUS_SUCCESS; char *sql; diff --git a/src/mod/codecs/mod_sangoma_codec/mod_sangoma_codec.c b/src/mod/codecs/mod_sangoma_codec/mod_sangoma_codec.c index 4b43487034..63086d6018 100644 --- a/src/mod/codecs/mod_sangoma_codec/mod_sangoma_codec.c +++ b/src/mod/codecs/mod_sangoma_codec/mod_sangoma_codec.c @@ -408,9 +408,9 @@ static switch_status_t switch_sangoma_encode(switch_codec_t *codec, switch_codec * whether the buffer passed in by the core (encoded_data) will be big enough */ switch_frame_t ulaw_frame; switch_frame_t encoded_frame; - switch_status_t sres; - switch_time_t now_time, difftime; - switch_time_t func_start_time, func_end_time; + switch_status_t sres = SWITCH_STATUS_FALSE; + switch_time_t now_time = 0, difftime = 0; + switch_time_t func_start_time = 0, func_end_time = 0; unsigned char ebuf_ulaw[decoded_data_len / 2]; short *dbuf_linear; int i = 0; @@ -596,9 +596,9 @@ static switch_status_t switch_sangoma_decode(switch_codec_t *codec, /* codec ses * whether the buffer passed in by the core will be enough */ switch_frame_t encoded_frame; switch_frame_t ulaw_frame; - switch_status_t sres; - switch_time_t now_time, difftime; - switch_time_t func_start_time, func_end_time; + switch_status_t sres = SWITCH_STATUS_FALSE; + switch_time_t now_time = 0, difftime = 0; + switch_time_t func_start_time = 0, func_end_time = 0; short *dbuf_linear; int i = 0; int res = 0; diff --git a/src/mod/endpoints/mod_gsmopen/alsa_nogsmlib_nocplusplus/mod_gsmopen/Makefile b/src/mod/endpoints/mod_gsmopen/alsa_nogsmlib_nocplusplus/mod_gsmopen/Makefile index 070f941a94..d67bdbbabf 100644 --- a/src/mod/endpoints/mod_gsmopen/alsa_nogsmlib_nocplusplus/mod_gsmopen/Makefile +++ b/src/mod/endpoints/mod_gsmopen/alsa_nogsmlib_nocplusplus/mod_gsmopen/Makefile @@ -1,6 +1,7 @@ MODNAME=mod_gsmopen SVNDEF := -D'GSMOPEN_SVN_VERSION="$(shell svnversion -n .)"' -LOCAL_CFLAGS += $(SVNDEF) -Wno-error=address -DNO_GSMLIB -I../../../../../../libs/spandsp/src -I../../../../../..//libs/tiff-3.8.2/libtiff +#LOCAL_CFLAGS += $(SVNDEF) -Wno-error=address -DNO_GSMLIB -I../../../../../../libs/spandsp/src -I../../../../../..//libs/tiff-3.8.2/libtiff +LOCAL_CFLAGS += $(SVNDEF) -DNO_GSMLIB -I../../../../../../libs/spandsp/src -I../../../../../..//libs/tiff-3.8.2/libtiff LOCAL_LDFLAGS=-lasound -L../../../../../../libs/spandsp/src -lspandsp LOCAL_OBJS=gsmopen_protocol.o include ../../../../../../build/modmake.rules diff --git a/src/mod/endpoints/mod_gsmopen/mod_gsmopen.cpp b/src/mod/endpoints/mod_gsmopen/mod_gsmopen.cpp index 40a716671d..cb440d3bcb 100644 --- a/src/mod/endpoints/mod_gsmopen/mod_gsmopen.cpp +++ b/src/mod/endpoints/mod_gsmopen/mod_gsmopen.cpp @@ -1209,7 +1209,7 @@ static switch_call_cause_t channel_outgoing_channel(switch_core_session_t *sessi switch_call_cause_t *cancel_cause) { private_t *tech_pvt = NULL; - if ((*new_session = switch_core_session_request(gsmopen_endpoint_interface, SWITCH_CALL_DIRECTION_OUTBOUND, pool)) != 0) { + if ((*new_session = switch_core_session_request(gsmopen_endpoint_interface, SWITCH_CALL_DIRECTION_OUTBOUND, flags, pool)) != 0) { switch_channel_t *channel = NULL; switch_caller_profile_t *caller_profile; char *rdest; diff --git a/src/mod/endpoints/mod_khomp/Install/files/khomp.conf.xml b/src/mod/endpoints/mod_khomp/Install/files/khomp.conf.xml new file mode 100644 index 0000000000..7255fb8555 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/Install/files/khomp.conf.xml @@ -0,0 +1,549 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/mod/endpoints/mod_khomp/Makefile b/src/mod/endpoints/mod_khomp/Makefile new file mode 100644 index 0000000000..94923c7cda --- /dev/null +++ b/src/mod/endpoints/mod_khomp/Makefile @@ -0,0 +1,41 @@ +MODNAME := mod_khomp +VERBOSE := 1 + +ifeq ($(strip $(FREESWITCH_PATH)),) + BASE := ../../../../ +else + BASE := $(FREESWITCH_PATH) +endif + +curr_dir := $(shell pwd) + +versions := -DFS_VERSION_MAJOR=$(shell bash $(curr_dir)/tools/getversion.sh "SWITCH_VERSION_MAJOR" $(BASE)) -DFS_VERSION_MINOR=$(shell bash $(curr_dir)/tools/getversion.sh "SWITCH_VERSION_MINOR" $(BASE)) -DFS_VERSION_MICRO=$(shell bash $(curr_dir)/tools/getversion.sh "SWITCH_VERSION_MICRO" $(BASE)) + +LOCAL_CFLAGS = -I./ -I./include -I./commons -I./support -D_REENTRANT -D_GNU_SOURCE -D_FILE_OFFSET_BITS=64 -D_LARGEFILE_SOURCE -DK3L_HOSTSYSTEM -DCOMMONS_LIBRARY_USING_FREESWITCH -g -ggdb #-DDEBUG_FLAGS +LOCAL_CFLAGS += $(versions) + +LOCAL_LDFLAGS = -lk3l + +LOCAL_OBJS = ./commons/k3lapi.o ./commons/k3lutil.o ./commons/config_options.o ./commons/format.o ./commons/strings.o ./commons/ringbuffer.o ./commons/verbose.o ./commons/saved_condition.o ./commons/regex.o ./commons/timer.o ./commons/configurator/configfile.o ./commons/configurator/option.o ./commons/configurator/section.o ./commons/configurator/restriction.o +LOCAL_OBJS += ./support/klog-config.o ./support/klog-options.o ./support/config_defaults.o +LOCAL_OBJS += ./src/globals.o ./src/opt.o ./src/frame.o ./src/utils.o ./src/lock.o ./src/spec.o ./src/applications.o ./src/khomp_pvt_fxo.o ./src/khomp_pvt_gsm.o ./src/khomp_pvt_kxe1.o ./src/khomp_pvt_passive.o ./src/khomp_pvt.o ./src/logger.o ./src/cli.o + +conf_file_name := khomp.conf.xml +conf_file_dir := $(curr_dir)/Install/files +conf_file_dir_alt := $(curr_dir)/conf +conf_file_install = $(sysconfdir)/autoload_configs + +include $(BASE)/build/modmake.rules + +depend_install: + @echo "Copy $(conf_file_name)" + @if test -d $(conf_file_install) ; then \ + if test -f $(conf_file_dir)/$(conf_file_name) ; then \ + cp $(conf_file_dir)/$(conf_file_name) $(conf_file_install)/$(conf_file_name).new ;\ + else \ + cp $(conf_file_dir_alt)/$(conf_file_name) $(conf_file_install)/$(conf_file_name).new ;\ + fi; \ + if test ! -f "$(conf_file_install)/$(conf_file_name)" ; then \ + mv $(conf_file_install)/$(conf_file_name).new $(conf_file_install)/$(conf_file_name) ;\ + fi; \ + fi; diff --git a/src/mod/endpoints/mod_khomp/commons/atomic.hpp b/src/mod/endpoints/mod_khomp/commons/atomic.hpp new file mode 100644 index 0000000000..daa598c9b4 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/atomic.hpp @@ -0,0 +1,189 @@ +/* + KHOMP generic endpoint/channel library. + + This code was based on FreeBSD 7.X SVN (sys/i386/include/atomic.h), + with changes regarding optimizations and generalizations, and a + remake of the interface to fit use C++ features. + + Code is distributed under original license. + Original copyright follows: + + * Copyright (c) 1998 Doug Rabson + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. 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. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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 _ATOMIC_HPP_ +#define _ATOMIC_HPP_ + +namespace Atomic +{ + // Macros used to insert compare and exchange instructions easily into functions. + + #define MAKE_CMPXCHG_FUNCTION(INS, PTR, EXP, VAL, TYPE) \ + PunnedType pexp; pexp.valtype = EXP; \ + PunnedType pval; pval.valtype = VAL; \ + TYPE vexp = *(pexp.podtype); \ + TYPE vval = *(pval.podtype); \ + TYPE res; \ + unsigned char chg = 0; \ + asm volatile("lock;" INS "sete %1;" \ + : "=a" (res), /* 0 */ \ + "=q" (chg), /* 1 */ \ + "=m" (*(unsigned char **)(PTR)) /* 2 */ \ + : "r" (vval), /* 3 */ \ + "a" (vexp), /* 4 */ \ + "m" (*(unsigned char **)(PTR)) /* 5 */ \ + : "memory"); \ + *(pexp.podtype) = res; \ + return (chg != 0 ? true : false); + + #define MAKE_CMPXCHG8B_FUNCTION(PTR,EXP,VAL) \ + PunnedType pexp; pexp.valtype = EXP; \ + PunnedType pval; pval.valtype = VAL; \ + unsigned long long vexp = *(pexp.podtype); \ + unsigned long long vval = *(pval.podtype); \ + unsigned long long res = (unsigned long long)exp; \ + unsigned char chg = 0; \ + asm volatile("lock; cmpxchg8b %2; sete %1;" \ + : "+A" (vexp), /* 0 (result) */ \ + "=q" (chg) /* 1 */ \ + : "m" (*(unsigned char**)(PTR)), /* 2 */ \ + "b" ((unsigned long)(vval)), \ + "c" ((unsigned long)(vval >> 32))); \ + *(pexp.podtype) = vexp; \ + return (chg != 0 ? true : false); + + // Types used for making CMPXCHG instructions independent from base type. + + template < typename ValType, typename PodType > + union PunnedTypeTemplate + { + ValType * valtype; + PodType * podtype; + }; + + template < int SizeOfType, typename ReturnType > + struct HelperCreateCAS; + + template < typename ValType > + struct HelperCreateCAS<4, ValType> + { + #if !defined(__LP64__) && !defined(__LP64) + typedef unsigned long BaseType; + #else + typedef unsigned int BaseType; + #endif + + typedef PunnedTypeTemplate< ValType, BaseType > PunnedType; + + inline static bool apply(volatile void *p, ValType * exp, ValType now) + { + #if !defined(__LP64__) && !defined(__LP64) + MAKE_CMPXCHG_FUNCTION("cmpxchgl %3,%5;", p, exp, &now, BaseType); + #else + MAKE_CMPXCHG_FUNCTION("cmpxchgl %k3,%5;", p, exp, &now, BaseType); + #endif + } + }; + + template < typename ValType > + struct HelperCreateCAS<8, ValType> + { + #if !defined(__LP64__) && !defined(__LP64) + typedef unsigned long long BaseType; + #else + typedef unsigned long BaseType; + #endif + + typedef PunnedTypeTemplate< ValType, BaseType > PunnedType; + + inline static volatile ValType apply(volatile void *p, ValType * exp, ValType now) + { + #if !defined(__LP64__) && !defined(__LP64) + MAKE_CMPXCHG8B_FUNCTION(p, exp, &now); + #else + MAKE_CMPXCHG_FUNCTION("cmpxchgq %3,%5;", p, exp, &now, BaseType); + #endif + } + + }; + + // The CAS function itself. + + template < typename ValType > + inline bool doCAS(volatile ValType * p, ValType * o, ValType n) + { + return HelperCreateCAS::apply(static_cast(p), o, n); + }; + + template < typename ValType > + inline bool doCAS(volatile ValType * p, ValType o, ValType n) + { + return HelperCreateCAS::apply(static_cast(p), &o, n); + }; + + #undef MAKE_CMPXCHG_32_FUNCTION + #undef MAKE_CMPXCHG_64_FUNCTION + + #define MAKE_LOCKED_TEMPLATE(NAME) \ + template < typename ValType > inline void do##NAME(volatile ValType * p, ValType v); \ + template < typename ValType > inline void do##NAME(volatile ValType * p); + + #define MAKE_LOCKED_FUNCTION(NAME, TYPE, INS, CONS, VAL) \ + template < > inline void do##NAME < TYPE > (volatile TYPE * p, TYPE v){ asm volatile("lock;" INS : "=m" (*p) : CONS (VAL), "m" (*p)); } \ + template < > inline void do##NAME < TYPE > (volatile TYPE * p) { asm volatile("lock;" INS : "=m" (*p) : CONS (1), "m" (*p)); } + + #define MAKE_LOCKED_FUNCTIONS(NAME, TYPE, INS, CONS, VAL) \ + MAKE_LOCKED_FUNCTION(NAME, TYPE, INS, CONS, VAL) \ + MAKE_LOCKED_FUNCTION(NAME, unsigned TYPE, INS, CONS, VAL) + + MAKE_LOCKED_TEMPLATE(Add); + MAKE_LOCKED_TEMPLATE(Sub); + MAKE_LOCKED_TEMPLATE(SetBits); + MAKE_LOCKED_TEMPLATE(ClearBits); + + MAKE_LOCKED_FUNCTIONS(Add, int, "addl %1,%0", "ir", v); + MAKE_LOCKED_FUNCTIONS(Sub, int, "subl %1,%0", "ir", v); + MAKE_LOCKED_FUNCTIONS(SetBits, int, "orl %1,%0", "ir", v); + MAKE_LOCKED_FUNCTIONS(ClearBits, int, "andl %1,%0", "ir", ~v); + + #if !defined(__LP64__) && !defined(__LP64) + + MAKE_LOCKED_FUNCTIONS(Add, long, "addl %1,%0", "ir", v); + MAKE_LOCKED_FUNCTIONS(Sub, long, "subl %1,%0", "ir", v); + MAKE_LOCKED_FUNCTIONS(SetBits, long, "orl %1,%0", "ir", v); + MAKE_LOCKED_FUNCTIONS(ClearBits, long, "andl %1,%0", "ir", ~v); + + #else + + MAKE_LOCKED_FUNCTIONS(Add, long, "addq %1,%0", "ir", v); + MAKE_LOCKED_FUNCTIONS(Sub, long, "subq %1,%0", "ir", v); + MAKE_LOCKED_FUNCTIONS(SetBits, long, "orq %1,%0", "ir", v); + MAKE_LOCKED_FUNCTIONS(ClearBits, long, "andq %1,%0", "ir", ~v); + + #endif +}; + +#endif /* _ATOMIC_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/config_commons.hpp b/src/mod/endpoints/mod_khomp/commons/config_commons.hpp new file mode 100644 index 0000000000..de8f327df4 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/config_commons.hpp @@ -0,0 +1,69 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#ifndef _CONFIG_COMMONS_HPP_ +#define _CONFIG_COMMONS_HPP_ + +/****************************************************************************/ +/* ASTERISK */ +#if defined(COMMONS_LIBRARY_USING_ASTERISK) + #define COMMONS_IMPLEMENTATION asterisk +/****************************************************************************/ +/* CALLWEAVER */ +#elif defined(COMMONS_LIBRARY_USING_CALLWEAVER) + #define COMMONS_IMPLEMENTATION callweaver +/****************************************************************************/ +/* FREESWITCH */ +#elif defined(COMMONS_LIBRARY_USING_FREESWITCH) + #define COMMONS_IMPLEMENTATION freeswitch +/****************************************************************************/ +/* GNU/LINUX (generic) */ +#elif defined(COMMONS_LIBRARY_USING_GNU_LINUX) + #define COMMONS_IMPLEMENTATION gnulinux +/****************************************************************************/ +#else + #error Unknown implementation selected. Please define COMMONS_LIBRARY_USING_* correctly. +#endif + +#define COMMONS_INCLUDE(file) + +#endif /* _CONFIG_COMMONS_HPP_ */ + diff --git a/src/mod/endpoints/mod_khomp/commons/config_options.cpp b/src/mod/endpoints/mod_khomp/commons/config_options.cpp new file mode 100644 index 0000000000..5383855f65 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/config_options.cpp @@ -0,0 +1,710 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +ConfigOption::ConfigOption(std::string name, const ConfigOption::StringType & value, const ConfigOption::StringType defvalue, string_allowed_type allowed, bool list_me) +: _my_name(name), _value_data(new StringData(const_cast(value), defvalue, allowed), true), + _list_me(list_me), _values(NULL), _loaded(false) +{}; + +ConfigOption::ConfigOption(std::string name, const ConfigOption::StringType & value, const ConfigOption::StringType defvalue, bool list_me) +: _my_name(name), _value_data(new StringData(const_cast(value), defvalue, string_allowed_type()), true), + _list_me(list_me), _values(NULL), _loaded(false) +{}; + +ConfigOption::ConfigOption(std::string name, const ConfigOption::SignedIntType & value, const ConfigOption::SignedIntType defvalue, + ConfigOption::SignedIntType min, ConfigOption::SignedIntType max, ConfigOption::SignedIntType step, bool list_me) +: _my_name(name), _value_data(new SignedIntData(const_cast(value), defvalue, Range(min, max, step)), true), + _list_me(list_me), _values(NULL), _loaded(false) +{}; + +ConfigOption::ConfigOption(std::string name, const ConfigOption::UnsignedIntType & value, const ConfigOption::UnsignedIntType defvalue, + ConfigOption::UnsignedIntType min, ConfigOption::UnsignedIntType max, ConfigOption::UnsignedIntType step, bool list_me) +: _my_name(name), _value_data(new UnsignedIntData(const_cast(value), defvalue, Range(min, max, step)), true), + _list_me(list_me), _values(NULL), _loaded(false) +{}; + +ConfigOption::ConfigOption(std::string name, const ConfigOption::BooleanType & value, const ConfigOption::BooleanType defvalue, bool list_me) +: _my_name(name), _value_data(new BooleanData(const_cast(value), defvalue), true), + _list_me(list_me), _values(NULL), _loaded(false) +{}; + +ConfigOption::ConfigOption(std::string name, ConfigOption::FunctionType fun, std::string defvalue, string_allowed_type allowed, bool list_me) +: _my_name(name), _value_data(new FunctionData(fun, defvalue, allowed), true), + _list_me(list_me), _values(NULL), _loaded(false) +{}; + +ConfigOption::ConfigOption(std::string name, ConfigOption::FunctionType fun, std::string defvalue, bool list_me) +: _my_name(name), _value_data(new FunctionData(fun, defvalue, string_allowed_type()), true), + _list_me(list_me), _values(NULL), _loaded(false) +{}; + +ConfigOption::ConfigOption(const ConfigOption & o) +: _my_name(o._my_name), _value_data(o._value_data), + _list_me(o._list_me), _values(o._values), _loaded(o._loaded) +{}; + +ConfigOption::~ConfigOption(void) +{ + if (_values) + { + for (unsigned int i = 0; _values[i] != NULL; i++) + delete _values[i]; + + delete[] _values; + _values = NULL; + } +}; + +void ConfigOption::set(ConfigOption::StringType value) +{ + switch (_value_data.which()) + { + case ID_STRING: + { + try + { + StringData & tmp = _value_data.get(); + + if (tmp.string_allowed.empty()) + { + tmp.string_val = value; + _loaded = true; + } + else + { + if (tmp.string_allowed.find(value) != tmp.string_allowed.end()) + { + tmp.string_val = value; + _loaded = true; + return; + } + + std::string allowed_string; + + for (string_allowed_type::iterator i = tmp.string_allowed.begin(); i != tmp.string_allowed.end(); i++) + { + allowed_string += " '"; + allowed_string += (*i); + allowed_string += "'"; + } + + throw ConfigProcessFailure(STG(FMT("value '%s' not allowed for option '%s' (allowed values:%s)") + % value % _my_name % allowed_string)); + } + break; + } + catch(ValueType::InvalidType & e) + { + throw; + } + } + + case ID_FUN: + { + try + { + FunctionData & tmp = _value_data.get(); + tmp.fun_val(value); + _loaded = true; + break; + } + catch(ValueType::InvalidType & e) + { + throw; + } + + } + + default: + { + throw ConfigProcessFailure(STG(FMT("option '%s' is not of type string, nor function defined") % _my_name)); + } + } +} + +void ConfigOption::set(ConfigOption::SignedIntType value) +{ + try + { + SignedIntData & tmp = _value_data.get(); + + if (value < tmp.sint_Range.minimum) + throw ConfigProcessFailure(STG(FMT("value '%d' out-of-Range for option '%s' (too low)") % value % _my_name)); + + if (value > tmp.sint_Range.maximum) + throw ConfigProcessFailure(STG(FMT("value '%d' out-of-Range for option '%s' (too high)") % value % _my_name)); + + if (((value - tmp.sint_Range.minimum) % tmp.sint_Range.step) != 0) + throw ConfigProcessFailure(STG(FMT("value '%d' out-of-Range for option '%s' (outside allowed step)") % value % _my_name)); + + tmp.sint_val = value; + _loaded = true; + } + catch(ValueType::InvalidType & e) + { + throw; + } +} + +void ConfigOption::set(ConfigOption::UnsignedIntType value) +{ + try + { + UnsignedIntData & tmp = _value_data.get(); + + if (value < tmp.uint_Range.minimum) + throw ConfigProcessFailure(STG(FMT("value '%d' out-of-Range for option '%s' (too low)") % value % _my_name)); + + if (value > tmp.uint_Range.maximum) + throw ConfigProcessFailure(STG(FMT("value '%d' out-of-Range for option '%s' (too high)") % value % _my_name)); + + if (((value - tmp.uint_Range.minimum) % tmp.uint_Range.step) != 0) + throw ConfigProcessFailure(STG(FMT("value '%d' out-of-Range for option '%s' (outside allowed step)") % value % _my_name)); + + tmp.uint_val = value; + _loaded = true; + } + catch(ValueType::InvalidType & e) + { + throw; + } +} + +void ConfigOption::set(ConfigOption::BooleanType value) +{ + try + { + BooleanData & tmp = _value_data.get(); + tmp.bool_val = value; + _loaded = true; + } + catch(ValueType::InvalidType & e) + { + throw; + } +} + +std::string & ConfigOption::name(void) { return _my_name; }; + +ConfigOption::value_id_type ConfigOption::type(void) +{ + return (value_id_type) _value_data.which(); +}; + +const char ** ConfigOption::values(void) +{ + if (_values != NULL) + return _values; + + switch ((value_id_type) _value_data.which()) + { + case ConfigOption::ID_BOOL: + { + _values = new const char*[3]; + + _values[0] = strdup("yes"); + _values[1] = strdup("no"); + _values[2] = NULL; + + return _values; + } + + case ConfigOption::ID_SINT: + { + try + { + SignedIntData & tmp = _value_data.get(); + + + unsigned int count = ((tmp.sint_Range.maximum - tmp.sint_Range.minimum) / tmp.sint_Range.step) + 1; + unsigned int index = 0; + + _values = new const char*[count + 1]; + + for (SignedIntType i = tmp.sint_Range.minimum; i <= tmp.sint_Range.maximum; i += tmp.sint_Range.step, index++) + _values[index] = strdup(STG(FMT("%d") % i).c_str()); + + _values[index] = NULL; + + return _values; + } + catch(ValueType::InvalidType & e) + { + throw; + } + } + + case ConfigOption::ID_UINT: + { + try + { + UnsignedIntData & tmp = _value_data.get(); + + unsigned int count = ((tmp.uint_Range.maximum - tmp.uint_Range.minimum) / tmp.uint_Range.step) + 1; + unsigned int index = 0; + + _values = new const char*[count + 1]; + + for (UnsignedIntType i = tmp.uint_Range.minimum; i <= tmp.uint_Range.maximum; i += tmp.uint_Range.step, index++) + _values[index] = strdup(STG(FMT("%d") % i).c_str()); + + _values[index] = NULL; + + return _values; + } + catch(ValueType::InvalidType & e) + { + throw; + } + } + + case ConfigOption::ID_STRING: + { + try + { + StringData & tmp = _value_data.get(); + + _values = new const char*[ tmp.string_allowed.size() + 1 ]; + + unsigned int index = 0; + + for (string_allowed_type::iterator i = tmp.string_allowed.begin(); i != tmp.string_allowed.end(); i++, index++) + _values[index] = strdup((*i).c_str()); + + _values[index] = NULL; + + return _values; + } + catch(ValueType::InvalidType & e) + { + throw; + } + } + + case ConfigOption::ID_FUN: + { + try + { + FunctionData & tmp = _value_data.get(); + + _values = new const char*[ tmp.fun_allowed.size() + 1 ]; + + unsigned int index = 0; + + for (string_allowed_type::iterator i = tmp.fun_allowed.begin(); i != tmp.fun_allowed.end(); i++, index++) + _values[index] = strdup((*i).c_str()); + + _values[index] = NULL; + return _values; + } + catch(ValueType::InvalidType & e) + { + throw; + } + + } + + default: + throw ConfigProcessFailure(STG(FMT("unknown type identifier '%d'") % _value_data.which())); + } +}; + +void ConfigOption::reset(void) +{ + _loaded = false; +}; + +void ConfigOption::commit(void) +{ + if (_loaded) + return; + + switch ((value_id_type) _value_data.which()) + { + case ConfigOption::ID_BOOL: + { + try + { + BooleanData & tmp = _value_data.get(); + tmp.bool_val = tmp.bool_default; + } + catch(ValueType::InvalidType & e) + { + throw; + } + + break; + } + + case ConfigOption::ID_SINT: + { + try + { + SignedIntData & tmp = _value_data.get(); + tmp.sint_val = tmp.sint_default; + } + catch(ValueType::InvalidType & e) + { + throw; + } + break; + } + + case ConfigOption::ID_UINT: + { + try + { + UnsignedIntData & tmp = _value_data.get(); + tmp.uint_val = tmp.uint_default; + } + catch(ValueType::InvalidType & e) + { + throw; + } + break; + } + + case ConfigOption::ID_STRING: + { + try + { + StringData & tmp = _value_data.get(); + tmp.string_val = tmp.string_default; + } + catch(ValueType::InvalidType & e) + { + throw; + } + break; + } + + case ConfigOption::ID_FUN: + { + try + { + FunctionData & tmp = _value_data.get(); + tmp.fun_val(tmp.fun_default); + } + catch(ValueType::InvalidType & e) + { + throw; + } + break; + } + + default: + throw ConfigProcessFailure(STG(FMT("unknown type identifier '%d'") % _value_data.which())); + } + + _loaded = true; +}; + +void ConfigOption::copy_from(ConfigOption & src) +{ + if (src._value_data.which() != _value_data.which()) + throw ConfigProcessFailure(STG(FMT("unable to copy options, source type differs from destination."))); + + if (!src._loaded) + return; + + switch ((value_id_type) _value_data.which()) + { + case ConfigOption::ID_BOOL: + { + try + { + BooleanData & stmp = src._value_data.get(); + BooleanData & dtmp = _value_data.get(); + /* do not copy references, but values.. */ + bool tmpval = stmp.bool_val; + dtmp.bool_val = tmpval; + } + catch(ValueType::InvalidType & e) + { + throw; + } + + break; + } + + case ConfigOption::ID_SINT: + { + try + { + SignedIntData & stmp = src._value_data.get(); + SignedIntData & dtmp = _value_data.get(); + /* do not copy references, but values.. */ + int tmpval = stmp.sint_val; + dtmp.sint_val = tmpval; + } + catch(ValueType::InvalidType & e) + { + throw; + } + + break; + } + + case ConfigOption::ID_UINT: + { + try + { + UnsignedIntData & stmp = src._value_data.get(); + UnsignedIntData & dtmp = _value_data.get(); + /* do not copy references, but values.. */ + unsigned int tmpval = stmp.uint_val; + dtmp.uint_val = tmpval; + } + catch(ValueType::InvalidType & e) + { + throw; + } + + + break; + } + + case ConfigOption::ID_STRING: + { + try + { + StringData & stmp = src._value_data.get(); + StringData & dtmp = _value_data.get(); + /* do not copy references, but values.. */ + std::string tmpval = stmp.string_val; + dtmp.string_val = tmpval; + } + catch(ValueType::InvalidType & e) + { + throw; + } + + break; + } + + case ConfigOption::ID_FUN: + { + /* TO IMPLEMENT (NEEDS ANOTHER METHOD ON FUNCTION FOR GETTING VALUE) */ + +// FunctionData & tmp = boost::get(_value_data); +// +// if (!tmp.loaded) +// { +// tmp.fun_val(tmp.fun_default); +// tmp.loaded = true; +// } + break; + } + + default: + throw ConfigProcessFailure(STG(FMT("unknown type identifier '%d'") % _value_data.which())); + } + + _loaded = true; +}; + +/*********************************/ + +bool ConfigOptions::add(ConfigOption option) +{ + //option_map_type::iterator iter2 = _map.begin(); + + //boost::tie(iter2, ok2) + std::pair ret = _map.insert(option_pair_type(option.name(), option)); + + return ret.second; +} + +bool ConfigOptions::synonym(std::string equiv_opt, std::string main_opt) +{ + //syn_option_map_type::iterator iter = _syn_map.begin(); + + //boost::tie(iter, ok) + std::pair ret = _syn_map.insert(syn_option_pair_type(equiv_opt, main_opt)); + + return ret.second; +} + +ConfigOptions::string_set ConfigOptions::options(void) +{ + string_set res; + + for (option_map_type::iterator i = _map.begin(); i != _map.end(); i++) + res.insert((*i).first); + + return res; +} + +void ConfigOptions::process(const char * name, const char * value) +{ + option_map_type::iterator iter = find_option(name); + + if (iter == _map.end()) + throw ConfigProcessFailure(STG(FMT("unknown option '%s'") % name)); + + try + { + switch ((*iter).second.type()) + { + case ConfigOption::ID_SINT: + set((*iter).first, Strings::toulong(value)); + return; + case ConfigOption::ID_UINT: + set((*iter).first, Strings::tolong(value)); + return; + case ConfigOption::ID_BOOL: + set((*iter).first, Strings::toboolean(value)); + return; + case ConfigOption::ID_STRING: + case ConfigOption::ID_FUN: + set((*iter).first, std::string(value)); + return; + default: + throw ConfigProcessFailure(STG(FMT("unknown type identifier '%d'") % (*iter).second.type())); + } + } + catch (Strings::invalid_value & e) + { + throw ConfigProcessFailure(STG(FMT("invalid value '%s' for option '%s'") % value % name)); + } +} + +const char ** ConfigOptions::values(const char * name) +{ + option_map_type::iterator iter = find_option(name); + + if (iter == _map.end()) + throw ConfigProcessFailure(STG(FMT("unknown option '%s'") % name)); + + return (*iter).second.values(); +} + +const char ** ConfigOptions::values(void) +{ + if (_values != NULL) + return _values; + + unsigned int count = 0; + + for (option_map_type::iterator i = _map.begin(); i != _map.end(); i++) + if ((*i).second.list_me()) + ++count; + + _values = new const char*[ count + 1 ]; + + unsigned int index = 0; + + for (option_map_type::iterator i = _map.begin(); i != _map.end(); i++) + { + if ((*i).second.list_me()) + { + _values[index] = strdup((*i).first.c_str()); + ++index; + } + } + + _values[index] = NULL; + + return _values; +} + +void ConfigOptions::reset(void) +{ + for (option_map_type::iterator i = _map.begin(); i != _map.end(); i++) + (*i).second.reset(); +} + +ConfigOptions::messages_type ConfigOptions::commit(void) +{ + messages_type msgs; + + for (option_map_type::iterator i = _map.begin(); i != _map.end(); i++) + { + try + { + (*i).second.commit(); + } + catch (ConfigProcessFailure & e) + { + msgs.push_back(e.msg); + } + } + + return msgs; +} + +bool ConfigOptions::loaded(std::string name) +{ + option_map_type::iterator iter = find_option(name); + + if (iter == _map.end()) + return false; + + return iter->second.loaded(); +} + +void ConfigOptions::copy_from(ConfigOptions & source, std::string name) +{ + option_map_type::iterator iter_src = source.find_option(name); + option_map_type::iterator iter_dst = find_option(name); + + if (iter_src == source._map.end()) + throw ConfigProcessFailure(STG(FMT("unknown option '%s' on source") % name)); + + if (iter_dst == _map.end()) + throw ConfigProcessFailure(STG(FMT("unknown option '%s' on destination") % name)); + + iter_dst->second.copy_from(iter_src->second); +} + +ConfigOptions::option_map_type::iterator ConfigOptions::find_option(std::string name) +{ + syn_option_map_type::iterator syn_iter = _syn_map.find(name); + + if (syn_iter != _syn_map.end()) + name = syn_iter->second; + + option_map_type::iterator iter = _map.find(name); + + return iter; +} diff --git a/src/mod/endpoints/mod_khomp/commons/config_options.hpp b/src/mod/endpoints/mod_khomp/commons/config_options.hpp new file mode 100644 index 0000000000..3cfe2e1c78 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/config_options.hpp @@ -0,0 +1,286 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include +#include +#include + +#include + +#include +#include +#include + +#ifndef _CONFIG_OPTIONS_HPP_ +#define _CONFIG_OPTIONS_HPP_ + +struct ConfigProcessFailure +{ + ConfigProcessFailure(std::string _msg): msg(_msg) {}; + std::string msg; +}; + +struct ConfigOption +{ + typedef int SignedIntType; + typedef unsigned int UnsignedIntType; + typedef bool BooleanType; + typedef std::string StringType; + + typedef Function::Function1 < void, std::string > FunctionType; + + typedef std::set < StringType > string_allowed_type; + + /* this should reflect 'variant.which()'! */ + typedef enum + { + ID_SINT = 0, + ID_UINT = 1, + ID_BOOL = 2, + ID_STRING = 3, + ID_FUN = 4, + } + value_id_type; + + template < typename number_type > + struct Range + { + Range(number_type _minimum, number_type _maximum, number_type _step) + : minimum(_minimum), maximum(_maximum), step(_step) {}; + + number_type minimum, maximum, step; + }; + + struct SignedIntData : public VariantBaseType < void > + { + SignedIntData(SignedIntType & _sint_val, SignedIntType _sint_default, Range< SignedIntType > _sint_Range) + : sint_val(_sint_val), sint_default(_sint_default), sint_Range(_sint_Range) {}; + + int which() + { + return ID_SINT; + } + + SignedIntType & sint_val; + SignedIntType sint_default; + Range sint_Range; + }; + + struct UnsignedIntData : public VariantBaseType < void > + { + UnsignedIntData(UnsignedIntType & _uint_val, UnsignedIntType _uint_default, Range< UnsignedIntType > _uint_Range) + : uint_val(_uint_val), uint_default(_uint_default), uint_Range(_uint_Range) {}; + + int which() + { + return ID_UINT; + } + + UnsignedIntType & uint_val; + UnsignedIntType uint_default; + Range uint_Range; + }; + + struct BooleanData : public VariantBaseType < void > + { + BooleanData(BooleanType & _bool_val, BooleanType _bool_default) + : bool_val(_bool_val), bool_default(_bool_default) {}; + + int which() + { + return ID_BOOL; + } + + BooleanType & bool_val; + BooleanType bool_default; + }; + + struct StringData : public VariantBaseType < void > + { + StringData(std::string & _string_val, std::string _string_default, string_allowed_type _string_allowed) + : string_val(_string_val), string_default(_string_default), string_allowed(_string_allowed) {}; + + int which() + { + return ID_STRING; + } + + std::string & string_val; + std::string string_default; + string_allowed_type string_allowed; + }; + + struct FunctionData : public VariantBaseType < void > + { + FunctionData(FunctionType _fun_val, std::string _fun_default, string_allowed_type _fun_allowed) + : fun_val(_fun_val), fun_default(_fun_default), fun_allowed(_fun_allowed) {}; + + int which() + { + return ID_FUN; + } + + FunctionType fun_val; + std::string fun_default; + string_allowed_type fun_allowed; + }; + + + typedef Variant < VariantBaseType < void > > ValueType; + + ConfigOption(std::string, const StringType &, const StringType, string_allowed_type allowed, bool list_me = true); + ConfigOption(std::string, const StringType &, const StringType = "", bool list_me = true); + ConfigOption(std::string, const SignedIntType &, const SignedIntType = 0, SignedIntType min = -INT_MAX, SignedIntType max = INT_MAX, SignedIntType step = 1, bool list_me = true); + ConfigOption(std::string, const UnsignedIntType &, const UnsignedIntType = 0, UnsignedIntType min = 0, UnsignedIntType max = UINT_MAX, UnsignedIntType step = 1, bool list_me = true); + ConfigOption(std::string, const BooleanType &, const BooleanType = false, bool list_me = true); + ConfigOption(std::string, FunctionType, std::string defvalue, string_allowed_type allowed, bool list_me = true); + ConfigOption(std::string, FunctionType, std::string defvalue = "", bool list_me = true); + + ConfigOption(const ConfigOption & o); + + ~ConfigOption(void); + + void set(StringType value); + + void set(SignedIntType value); + void set(UnsignedIntType value); + void set(BooleanType value); + + BooleanType get_bool(){ return _value_data.get().bool_val; } + std::string get_str(){ return _value_data.get().string_val; } + SignedIntType get_sint(){ return _value_data.get().sint_val; } + UnsignedIntType get_uint(){ return _value_data.get().uint_val; } + + std::string & name(void); + value_id_type type(void); + + const char ** values(void); + + void reset(void); + void commit(void); + + bool list_me(void) { return _list_me; }; + bool loaded(void) { return _loaded; }; + + void copy_from(ConfigOption &); + + protected: + std::string _my_name; + ValueType _value_data; + + bool _list_me; + const char ** _values; + bool _loaded; +}; + +struct ConfigOptions +{ + typedef std::vector < std::string > messages_type; + + ConfigOptions(void): _values(NULL) {}; + + typedef std::set < std::string > string_set; + + typedef std::map < std::string, ConfigOption > option_map_type; + typedef std::pair < std::string, ConfigOption > option_pair_type; + + typedef std::map < std::string, std::string > syn_option_map_type; + typedef std::pair < std::string, std::string > syn_option_pair_type; + + bool add(ConfigOption option); + + /* only valid in "process" (for backwards compatibility config files) */ + bool synonym(std::string, std::string); + + template + void set(std::string name, ValueType value) + { + option_map_type::iterator iter = _map.find(name); + + if (iter == _map.end()) + throw ConfigProcessFailure(STG(FMT("unknown option: %s") % name)); + + (*iter).second.set(value); + } + + std::string get(std::string name) + { + option_map_type::iterator iter = _map.find(name); + + if (iter == _map.end()) + throw ConfigProcessFailure(STG(FMT("unknown option: %s") % name)); + + switch((*iter).second.type()) + { + case ConfigOption::ID_BOOL: return (*iter).second.get_bool() ? "yes" : "no"; + case ConfigOption::ID_STRING: return (*iter).second.get_str(); + case ConfigOption::ID_UINT: return STG(FMT("%d") % (*iter).second.get_uint()); + case ConfigOption::ID_SINT: return STG(FMT("%d") % (*iter).second.get_sint()); + case ConfigOption::ID_FUN: return ""; + } + } + + string_set options(void); + + void process(const char *, const char *); /* process option from file */ + + void reset(void); /* reset loaded opts */ + messages_type commit(void); /* set defaults */ + + const char ** values(const char *); /* option value */ + const char ** values(void); /* values from options */ + + bool loaded(std::string); /* return if config was loaded */ + + void copy_from(ConfigOptions &, std::string); + + protected: + option_map_type::iterator find_option(std::string); + + protected: + option_map_type _map; + syn_option_map_type _syn_map; + + const char ** _values; +}; + +#endif /* _CONFIG_OPTIONS_HPP_ */ + diff --git a/src/mod/endpoints/mod_khomp/commons/configurator/configfile.cpp b/src/mod/endpoints/mod_khomp/commons/configurator/configfile.cpp new file mode 100644 index 0000000000..6aa2e59201 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/configurator/configfile.cpp @@ -0,0 +1,241 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ +#include + +#include + +#if _MSC_VER >= 1400 +#undef close +#endif + +void Configfile::ignore(std::string str) +{ + _ignores.insert(str); +}; + +bool Configfile::select(Section **ptr, std::string str) +{ + /* default section == this! */ + *ptr = this; + + /* always success by default */ + return true; +}; + +bool Configfile::adjust(Section * section, std::string & opt, std::string & val) +{ + return section->load(opt, val); +}; + +bool Configfile::deserialize(std::ifstream& fd) +{ + Section * section = NULL; + + /* default selection! */ + if (!select(§ion)) + { + _errors.push_back("default selection has failed!"); + return false; + } + + size_t count = 0; + + while (fd.good()) + { + std::string str; + + /* read one line! */ + std::getline(fd, str); + + size_t lst = str.size() - 1; + + if (str.size() >= 1 && str[lst] == '\r') //cuida das quebras de linha do tipo \r\n + { + str.erase(lst,1); + --lst; + } + + /* empty line! */ + if (str.size() == 0) + continue; + + /* comment! */ + if (str[0] == '#') + continue; + + ++count; + + if (str[0] == '[' && str[lst] == ']') + { + str.erase(0,1); --lst; + str.erase(lst,1); --lst; + + if (!select(§ion, str)) + { + _errors.push_back(STG(FMT("erroneous section '%s'") % str)); + + /* ignore this section */ + section = NULL; + continue; + } + } + else + { + std::string::size_type pos = str.find('='); + + if (pos == std::string::npos) + { + _errors.push_back(STG(FMT("erroneous separator '%s'") % str)); + continue; + }; + + if (section == NULL) + { + _errors.push_back(STG(FMT("no section for option '%s'") % str)); + continue; + } + + std::string opt(str.substr(0,pos)); + std::string val(str.substr(pos+1)); + + if (_ignores.find(opt) != _ignores.end()) + continue; + + if (val == "@") val = ""; + + if (adjust(section, opt, val)) + continue; + + _errors.push_back(STG(FMT("option '%s' does " + "not exist or '%s' is not a valid value (at section '%s')") + % opt % val % section->name())); + } + } + + // retorna 'true' se arquivo tinha alguma coisa valida. + return (count != 0); +} + +bool Configfile::obtain() +{ + std::ifstream fd(_filename.c_str()); + + if (!fd.is_open()) + { + _errors.push_back(STG(FMT("unable to open file '%s': %s") + % _filename % strerror(errno))); + return false; + }; + + if (!deserialize(fd)) + { + fd.close(); + return false; + } + + fd.close(); + return true; +}; + +void Configfile::recurse(std::ofstream& fd, Section * section) +{ + typedef Section::SectionMap::iterator section_iter; + typedef Section::OptionMap::iterator option_iter; + + for (option_iter i = section->option_begin(); i != section->option_end(); i++) + { + std::string res; + + if ((*i).second.store(res)) + { + if (res == "") res = "@"; + fd << (*i).first << "=" << res << std::endl; + } + } + + if (!section->recursive()) + return; + + for (section_iter j = section->section_begin(); j != section->section_end(); j++) + recurse(fd, (*j).second); +} + +bool Configfile::serialize(std::ofstream& fd) +{ + recurse(fd, this); + return true; +} + +bool Configfile::provide() +{ + std::string tmp(_filename); + tmp += ".new"; + + std::ofstream fd(tmp.c_str()); + + if (!fd.good()) + { + _errors.push_back(STG(FMT("unable to open file '%s': %s") + % tmp % strerror(errno))); + return false; + } + + if (!serialize(fd)) + { + fd.close(); + return false; + } + + fd.close(); + + if (rename(tmp.c_str(), _filename.c_str()) != 0) + { + _errors.push_back(STG(FMT("unable to replace config file '%s': %s") + % _filename % strerror(errno))); + return false; + } + + return true; +} + +#if _MSC_VER >= 1400 +#define close _close +#endif \ No newline at end of file diff --git a/src/mod/endpoints/mod_khomp/commons/configurator/configfile.hpp b/src/mod/endpoints/mod_khomp/commons/configurator/configfile.hpp new file mode 100644 index 0000000000..61f42469af --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/configurator/configfile.hpp @@ -0,0 +1,90 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include +#include +#include +#include + +#include + +#include + +#ifndef _CONFIG_CONFIGFILE_HPP_ +#define _CONFIG_CONFIGFILE_HPP_ + +struct Configfile: public Section +{ + typedef std::list < std::string > ErrorVector; + typedef std::set < std::string > NameSet; + + Configfile(std::string name, std::string desc) + : Section(name, desc), _good(false) {}; + + virtual ~Configfile() {}; + + bool good() { return _good; }; + std::string & filename() { return _filename; }; + + ErrorVector & errors() { return _errors; }; + + void ignore(std::string); + + virtual bool obtain(); + virtual bool provide(); + + protected: + virtual bool select(Section **, std::string str = ""); + virtual bool adjust(Section *, std::string & opt, std::string & val); + + virtual bool deserialize(std::ifstream &); + virtual bool serialize(std::ofstream &); + + void recurse(std::ofstream &, Section *); + + protected: + bool _good; + ErrorVector _errors; + NameSet _ignores; + std::string _filename; +}; + +#endif /* _CONFIG_CONFIGFILE_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/configurator/option.cpp b/src/mod/endpoints/mod_khomp/commons/configurator/option.cpp new file mode 100644 index 0000000000..083883e63f --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/configurator/option.cpp @@ -0,0 +1,185 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +bool Option::equals(std::string & value) +{ + switch (_restriction.numeral()) + { + case Restriction::N_UNIQUE: + { + Restriction::Value my_value; + + if (!_restriction.get(Restriction::F_USER, my_value)) + return false; + + return (my_value == value); + } + case Restriction::N_MULTIPLE: + { + Restriction::Vector my_values; + + if (!_restriction.get(Restriction::F_USER, my_values)) + return false; + + for (Restriction::Vector::iterator i = my_values.begin(); i != my_values.end(); i++) + { + if ((*i) == value) + return true; + } + + return false; + } + } + + return false; +} + +bool Option::load(std::string & value) +{ + bool ret = _restriction.set(Restriction::F_FILE, value); + + if (ret) _modified = false; + + return ret; +} + +bool Option::change(std::string & value) +{ + bool ret = _restriction.set(Restriction::F_FILE, value); + + if (ret) _modified = true; + + return ret; +} + +bool Option::store(std::string & value) +{ + switch (_restriction.numeral()) + { + case Restriction::N_UNIQUE: + return _restriction.get(Restriction::F_FILE, value); + + case Restriction::N_MULTIPLE: + { + Restriction::Vector values; + + if (!_restriction.get(Restriction::F_FILE, values)) + return false; + + Strings::Merger strs; + + for (Restriction::Vector::iterator i = values.begin(); i != values.end(); i++) + strs.add(*i); + + value = strs.merge(","); + + return true; + } + + default: + return false; + } +} + +Option::Flags Option::set(const char * value) +{ + std::string str_value(value); + return set(str_value); +} + + +Option::Flags Option::set(Restriction::Value & value) +{ + Restriction::Value last_value, curr_value; + Flags flags; + + bool ret1 = _restriction.get(Restriction::F_USER, last_value); + + if (!_restriction.set(Restriction::F_USER, value)) + return flags; + + flags[F_ADJUSTED] = true; + + bool ret2 = _restriction.get(Restriction::F_USER, curr_value); + + if (!ret1 || (ret2 && (last_value != curr_value))) + { + flags[F_MODIFIED] = true; + _modified = true; + } + + return flags; +} + +Option::Flags Option::set(Restriction::Vector & values) +{ + Restriction::Vector last_values, curr_values; + Flags flags; + + bool ret1 = _restriction.get(Restriction::F_USER, last_values); + + if (!_restriction.set(Restriction::F_USER, values)) + return flags; + + flags[F_ADJUSTED] = true; + + bool ret2 = _restriction.get(Restriction::F_USER, curr_values); + + if (!ret1 || (ret2 && (last_values != curr_values))) + { + flags[F_MODIFIED] = true; + _modified = true; + } + + return flags; +} + +bool Option::get(Restriction::Value & value) +{ + return _restriction.get(Restriction::F_USER, value); +} + +bool Option::get(Restriction::Vector & values) +{ + return _restriction.get(Restriction::F_USER, values); +} diff --git a/src/mod/endpoints/mod_khomp/commons/configurator/option.hpp b/src/mod/endpoints/mod_khomp/commons/configurator/option.hpp new file mode 100644 index 0000000000..8aa103a0cc --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/configurator/option.hpp @@ -0,0 +1,122 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +#include +#include +#include + +#include + +#include + +#ifndef _CONFIG_OPTION_HPP_ +#define _CONFIG_OPTION_HPP_ + +struct Option +{ + enum FlagTypes + { + F_MODIFIED = 0x0, /* if option was modified */ + F_ADJUSTED = 0x1, /* if option was correctly formated */ + }; + + struct Flags: public std::vector + { + Flags(): std::vector(2) {}; + }; + + typedef Restriction::Value Value; + typedef Restriction::Vector Vector; + + /* exception */ + struct InvalidDefaultValue + { + InvalidDefaultValue(std::string name, std::string value) + : _name(name), _value(value) {}; + + std::string & name() { return _name; }; + std::string & value() { return _value; }; + + protected: + std::string _name; + std::string _value; + }; + + Option(std::string name, std::string desc, std::string defvalue, Restriction restriction) + : _name(name), _desc(desc), _restriction(restriction), _modified(true) + { + std::string value(defvalue); + + if (!(set(value)[F_ADJUSTED])) + throw InvalidDefaultValue(name, defvalue); + } + + const std::string & name() { return _name; }; + const std::string & description() { return _desc; }; + + Restriction & restriction() { return _restriction; }; + bool modified() { return _modified; }; + + public: + bool load(std::string &); + bool change(std::string &); + bool store(std::string &); + + Flags set(const char *); + Flags set(Value &); + Flags set(Vector &); + + bool get(Value &); + bool get(Vector &); + + bool equals(std::string &); + + protected: + std::string _name; + std::string _desc; + + Restriction _restriction; + bool _modified; +}; + +#endif /* _CONFIG_OPTION_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/configurator/restriction.cpp b/src/mod/endpoints/mod_khomp/commons/configurator/restriction.cpp new file mode 100644 index 0000000000..9653a7c608 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/configurator/restriction.cpp @@ -0,0 +1,353 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include +#include + +#include +#include + +#include + +/* internal helper! */ +bool Restriction::equalNumber(const double a, const double b) +{ + char tmp1[64]; + char tmp2[64]; + + snprintf(tmp1, sizeof(tmp1), "%.3f", a); + snprintf(tmp2, sizeof(tmp2), "%.3f", b); + + if (strncmp(tmp1, tmp2, sizeof(tmp1))) + return false; + + return true; +} + +/* process value to our internal representation */ + +bool Restriction::process(Restriction::Format fmt, + const Restriction::Value & value, Restriction::Value & final) +{ + switch (_bounds) + { + case B_RANGE: + { + if (_kind != K_NUMBER) + return false; + + std::string tmpvalue; + + Restriction::Value::const_iterator itr = value.begin(); + Restriction::Value::const_iterator end = value.end(); + + tmpvalue.reserve(value.size()); + + // f*cking dot/comma notation! + for (; itr != end; ++itr) + tmpvalue += ((*itr) != ',' ? (*itr) : '.'); + + try + { + double newvalue = Strings::todouble(tmpvalue); + + if (newvalue < _init && newvalue > _fini) + return false; + + double res = (newvalue - _init) / _step; + + if (!equalNumber(res, rint(res))) + return false; + + final = value; + return true; + } + catch (...) + { + return false; + } + } + + case B_LIST: + for (List::iterator i = _list.begin(); i != _list.end(); i++) + { + Value & tmp = (*i); + + if (tmp == value) + { + final = value; + return true; + } + } + return false; + + case B_MAPS: + switch (fmt) + { + case F_USER: + { + Map::iterator i = _map_from_usr.find(std::string(value)); + + if (i == _map_from_usr.end()) + return false; + + Value & tmp = (*i).second; + + final = tmp; + return true; + } + + case F_FILE: + { + Map::iterator i = _map_from_cfg.find(std::string(value)); + + if (i == _map_from_cfg.end()) + return false; + + final = value; + return true; + } + + default: + break; + } + return false; + + case B_FREE: + final = value; + return true; + + default: + break; + } + + return false; +} + +/* unprocess the value (outputs the external representation) */ + +bool Restriction::unprocess(Restriction::Format fmt, + const Restriction::Value & value, Restriction::Value & final) +{ + switch (_bounds) + { + case B_MAPS: + + switch (fmt) + { + case F_USER: + { + Map::iterator i = _map_from_cfg.find(std::string(value)); + + if (i == _map_from_cfg.end()) + return false; + + final = (*i).second; + return true; + } + default: + break; + } + + default: + final = value; + return true; + } +} + +/***************************** *****************************/ + +bool Restriction::get(Restriction::Format fmt, Restriction::Value & value) +{ + if (_numeral != N_UNIQUE) + return false; + + if (!unprocess(fmt, _value._unique, value)) + return false; + + return true; +} + +bool Restriction::get(Restriction::Format fmt, Restriction::Vector & values) +{ + if (_numeral != N_MULTIPLE) + return false; + + List & my_values = _value._multiple; + + for (List::iterator i = my_values.begin(); i != my_values.end(); i++) + { + Value & value = (*i); + Value final; + + if (!unprocess(fmt, value, final)) + return false; + + values.push_back(final); + }; + + return true; +} + +/***************************** *****************************/ + +bool Restriction::set(Restriction::Format fmt, Restriction::Value &value) +{ + switch (_numeral) + { + case N_UNIQUE: + { + Value final; + + if (!process(fmt, value, final)) + return false; + + _value._unique = final; + return true; + } + + case N_MULTIPLE: + { + if (value == "@" || value == "#" || value == "") + { + _value._multiple.clear(); + return true; + } + + Strings::vector_type values; + Strings::tokenize(value, values, ","); + + return set(fmt, values); + } + + default: + return false; + } +} + +bool Restriction::set(Restriction::Format fmt, Restriction::Vector & values) +{ + if (_numeral != N_MULTIPLE) + return false; + + if (values.empty()) + { + _value._multiple.clear(); + } + else + { + /* list needed to store temporary values */ + List finals; + + for (Vector::iterator i = values.begin(); i != values.end(); i++) + { + Value & value = (*i); + Value final; + + if (!process(fmt, value, final)) + return false; + + finals.push_back(final); + } + + List & lst = _value._multiple; + + /* need to clear values set before */ + lst.clear(); + + for (List::iterator i = finals.begin(); i != finals.end(); i++) + { + Value value = (*i); + lst.push_back(value); + } + }; + + return true; +} + +/***************************** *****************************/ + +void Restriction::allowed(Restriction::Vector &vals) +{ + switch (_bounds) + { + case B_FREE: + return; + + case B_LIST: + for (List::iterator i = _list.begin(); i != _list.end(); i++) + vals.push_back((*i)); + break; + + case B_MAPS: + for (Map::iterator i = _map_from_usr.begin(); i != _map_from_usr.end(); i++) + vals.push_back((*i).first); + break; + + case B_RANGE: + { + if (_kind != K_NUMBER) + return; + + // is there any fraction? + bool has_fraction = (!equalNumber(_init, rint(_init))) || (!equalNumber(_fini, rint(_fini))) || (!equalNumber(_step, rint(_step))); + + const char * format = (has_fraction ? "%.2f" : "%02.0f"); + + for (double i = _init; i <= _fini; i += _step) + { + char tmp[32]; + snprintf(tmp, sizeof(tmp), format, i); + vals.push_back(std::string(tmp)); + } + break; + } + + default: + break; + } +} + +void Restriction::init_class() +{ + _value._unique.clear(); + _value._multiple.clear(); +} diff --git a/src/mod/endpoints/mod_khomp/commons/configurator/restriction.hpp b/src/mod/endpoints/mod_khomp/commons/configurator/restriction.hpp new file mode 100644 index 0000000000..0815ede3db --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/configurator/restriction.hpp @@ -0,0 +1,321 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +#include +#include +#include +#include + +#ifndef _CONFIG_RESTRICTION_HPP_ +#define _CONFIG_RESTRICTION_HPP_ + +struct Restriction +{ + /* generic types */ + enum Format + { + F_USER, + F_FILE + }; + + enum Kind + { +// K_INTEGER, +// K_FLOAT, + K_STRING, + K_NUMBER // = K_INTEGER // compatibility + }; + + enum Bounds + { + B_FREE, + B_RANGE, + B_LIST, + B_MAPS + }; + + enum Numeral + { + N_UNIQUE, + N_MULTIPLE + }; + + typedef std::string Value; + + /* types used for data input */ + struct Pair + { + const char *pretty; + const char *value; + }; + + typedef std::pair < Value, Value > PairMap; + typedef std::list < PairMap > ListMap; + + /* types used internally */ + typedef std::map < Value, Value > Map; + typedef std::vector < Value > Vector; + + typedef std::list < Value > List; + typedef std::pair < Value, Value > MapPair; + + struct Generic + { + Value _unique; + List _multiple; + }; + + Restriction(Kind kind, Numeral num) + : _kind(kind), _bounds(B_FREE), _numeral(num), _unit(""), + _init(-1), _fini(-1), _step(-1) + { + init_class(); + } + +/* + Restriction(Kind kind, Numeral num, + int init, int fini, int step = 1) + : _kind(kind), _bounds(B_RANGE), _numeral(num), _unit(unit), + _iinit(init), _ifini(fini), _istep(step), + _finit(-1), _ffini(-1), _fstep(-1) + { + init_class(); + } + + Restriction(Kind kind, Numeral num, + const char *unit, int init, int fini, int step = 1) + : _kind(kind), _bounds(B_RANGE), _numeral(num), _unit(unit), + _iinit(init), _ifini(fini), _istep(step), + _finit(-1), _ffini(-1), _fstep(-1) + { + init_class(); + } + + Restriction(Kind kind, Numeral num, + std::string unit, int init, int fini, int step = 1) + : _kind(kind), _bounds(B_RANGE), _numeral(num), _unit(unit), + _iinit(init), _ifini(fini), _istep(step), + _finit(-1), _ffini(-1), _fstep(-1) + { + init_class(); + } + + Restriction(Kind kind, Numeral num, + float init, float fini, float step = 1) + : _kind(kind), _bounds(B_RANGE), _numeral(num), _unit(unit), + _iinit(-1), _ifini(-1), _istep(-1) + _finit(init), _ffini(fini), _fstep(step), + { + init_class(); + } + + Restriction(Kind kind, Numeral num, + const char *unit, float init, float fini, float step = 1.0) + : _kind(kind), _bounds(B_RANGE), _numeral(num), _unit(unit), + _iinit(-1), _ifini(-1), _istep(-1) + _finit(init), _ffini(fini), _fstep(step), + { + init_class(); + } + + Restriction(Kind kind, Numeral num, + std::string unit, float init, float fini, float step = 1.0) + : _kind(kind), _bounds(B_RANGE), _numeral(num), _unit(unit), + _iinit(-1), _ifini(-1), _istep(-1) + _finit(init), _ffini(fini), _fstep(step), + { + init_class(); + } +*/ + + Restriction(Kind kind, Numeral num, + double init, double fini, double step = 1) + : _kind(kind), _bounds(B_RANGE), _numeral(num), _unit(""), + _init(init), _fini(fini), _step(step) + { + init_class(); + } + + Restriction(Kind kind, Numeral num, + const char *unit, double init, double fini, double step = 1.0) + : _kind(kind), _bounds(B_RANGE), _numeral(num), _unit(unit), + _init(init), _fini(fini), _step(step) + { + init_class(); + } + + Restriction(Kind kind, Numeral num, + std::string unit, double init, double fini, double step = 1.0) + : _kind(kind), _bounds(B_RANGE), _numeral(num), _unit(unit), + _init(init), _fini(fini), _step(step) + { + init_class(); + } + + Restriction(Kind kind, Numeral num, + const char *first, ...) + : _kind(kind), _bounds(B_LIST), _numeral(num), _unit(""), + _init(-1), _fini(-1), _step(-1) + { + _list.push_back(std::string(first)); + + va_list ap; + va_start(ap, first); + + while (true) + { + const char *arg = va_arg(ap, const char *); + + if (arg == NULL) break; + + _list.push_back(std::string(arg)); + } + + init_class(); + } + + Restriction(Kind kind, const char *unit, Numeral num, + const char *first, ...) + : _kind(kind), _bounds(B_LIST), _numeral(num), _unit(unit), + _init(-1), _fini(-1), _step(-1) + { + _list.push_back(std::string(first)); + + va_list ap; + va_start(ap, first); + + while (true) + { + const char *arg = va_arg(ap, const char *); + + if (arg == NULL) break; + + _list.push_back(std::string(arg)); + } + + init_class(); + } + + Restriction(Kind kind, Numeral num, + const struct Pair first, ...) + : _kind(kind), _bounds(B_MAPS), _numeral(num), _unit(""), + _init(-1), _fini(-1), _step(-1) + { + _map_from_usr.insert(MapPair(Value(first.pretty), Value(first.value))); + _map_from_cfg.insert(MapPair(Value(first.value), Value(first.pretty))); + + va_list ap; + va_start(ap, first); + + while (true) + { + Pair arg = va_arg(ap, Pair); + + if (arg.pretty == NULL) break; + + _map_from_usr.insert(MapPair(Value(arg.pretty), Value(arg.value))); + _map_from_cfg.insert(MapPair(Value(arg.value), Value(arg.pretty))); + } + + init_class(); + } + + Restriction(Kind kind, Numeral num, List list) + : _kind(kind), _bounds(B_LIST), _numeral(num), _unit(""), + _init(-1), _fini(-1), _step(-1), _list(list) + { + init_class(); + } + + Restriction(Kind kind, Numeral num, ListMap map) + : _kind(kind), _bounds(B_MAPS), _numeral(num), _unit(""), + _init(-1), _fini(-1), _step(-1) + { + for (ListMap::iterator i = map.begin(); i != map.end(); i++) + { + _map_from_usr.insert(MapPair(Value((*i).first), Value((*i).second))); + _map_from_cfg.insert(MapPair(Value((*i).second), Value((*i).first))); + } + + init_class(); + } + + Kind kind() { return _kind; }; + Bounds bounds() { return _bounds; }; + Numeral numeral() { return _numeral; }; + + Value unit() { return _unit; }; + + bool set(Format, Vector &); + bool set(Format, Value &); + + bool get(Format, Vector &); + bool get(Format, Value &); + + void allowed(Vector &); + + private: + bool process(Format, const Value &, Value &); + bool unprocess(Format, const Value &, Value &); + void init_class(); + + bool equalNumber(const double, const double); + + protected: + Kind _kind; + Bounds _bounds; + Numeral _numeral; + + Value _unit; + + double _init, _fini, _step; + + Map _map_from_usr, + _map_from_cfg; + + List _list; + + Generic _value; +}; + +#endif /* _CONFIG_RESTRICTION_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/configurator/section.cpp b/src/mod/endpoints/mod_khomp/commons/configurator/section.cpp new file mode 100644 index 0000000000..5d26858054 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/configurator/section.cpp @@ -0,0 +1,130 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +void Section::options(Section::OptionVector & vec) +{ + for (OptionMap::iterator it = _options.begin(); it != _options.end();) + { + vec.push_back(&((*it).second)); + ++it; + } +} + +void Section::sections(Section::SectionVector & vec) +{ + for (SectionMap::iterator it = _sections.begin(); it != _sections.end();) + { + vec.push_back((*it).second); + ++it; + } +} + +/*********/ + +Option * Section::option_find(std::string & str, bool recurse) +{ + OptionMap::iterator i = _options.find(str); + + if (i == _options.end()) + { + if (!recurse) + throw not_found(); + + for (SectionMap::iterator i = _sections.begin(); i != _sections.end(); i++) + { + try + { + return i->second->option_find(str, recurse); + } + catch (not_found & e) + { + /* keep looping! */ + }; + } + + throw not_found(); + } + + return &((*i).second); +} + +Option * Section::option_find(const char * str, bool recurse) +{ + std::string sstr(str); + return option_find(sstr, recurse); +} + +/*********/ + +Section * Section::section_find(std::string & str, bool recurse) +{ + SectionMap::iterator i = _sections.find(str); + + if (i == _sections.end()) + { + if (!recurse) + throw not_found(); + + for (SectionMap::iterator i = _sections.begin(); i != _sections.end(); i++) + { + try + { + return i->second->section_find(str, recurse); + } + catch (not_found & e) + { + /* keep looping! */ + }; + } + + throw not_found(); + } + + return ((*i).second); +} + +Section * Section::section_find(const char * str, bool recurse) +{ + std::string sstr(str); + return section_find(sstr, recurse); +} diff --git a/src/mod/endpoints/mod_khomp/commons/configurator/section.hpp b/src/mod/endpoints/mod_khomp/commons/configurator/section.hpp new file mode 100644 index 0000000000..fdb782308a --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/configurator/section.hpp @@ -0,0 +1,226 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include +#include +#include +#include +#include + +#include + +#ifndef _CONFIG_SECTION_HPP_ +#define _CONFIG_SECTION_HPP_ + +struct Section +{ + typedef std::map < std::string, Option > OptionMap; + typedef std::vector< Option * > OptionVector; + + typedef std::map < std::string, Section * > SectionMap; + typedef std::vector < Section * > SectionVector; + + struct not_found {}; /* exception */ + +// protected: + Section(std::string name, std::string desc, bool recursive = true) + : _name(name), _description(desc), _recursive(recursive) {}; + + void add(Option o) + { + _options.insert(std::pair(o.name(), o)); + }; + + void del(std::string name) + { + _options.erase(name); + }; + + void add(Section *s) + { + _sections.insert(std::pair(s->name(), s)); + }; + + public: + const std::string & name() { return _name; }; + const std::string & description() { return _description; }; + const bool & recursive() { return _recursive; }; + + OptionMap::iterator option_begin() { return _options.begin(); }; + OptionMap::iterator option_end() { return _options.end(); }; + + SectionMap::iterator section_begin() { return _sections.begin(); }; + SectionMap::iterator section_end() { return _sections.end(); }; + + /**/ + + Option * option_find(const char *, bool recurse = false); + Section * section_find(const char *, bool recurse = false); + + Option * option_find(std::string &, bool recurse = false); + Section * section_find(std::string &, bool recurse = false); + + /**/ + + void options(OptionVector &); + void sections(SectionVector &); + + /**/ + + template + bool search_and_apply(std::string &key, std::string &value, F f) + { + OptionMap::iterator i = _options.find(key); + + if (i != _options.end()) + return f((*i).second); + + if (!_recursive) + return false; + + return (find_if(_sections.begin(), _sections.end(), f) != _sections.end()); + } + + private: + struct key_value + { + key_value(std::string &k, std::string &v): _k(k), _v(v) {}; + std::string & _k, & _v; + }; + + struct load_section: protected key_value + { + load_section(std::string &k, std::string &v): key_value(k,v) {}; + + bool operator()(Option &o) { return o.load(_v); }; + bool operator()(SectionMap::value_type &v) { return v.second->load(_k,_v); }; + }; + + struct change_section: protected key_value + { + change_section(std::string &k, std::string &v): key_value(k,v) {}; + + bool operator()(Option &o) { return o.change(_v); }; + bool operator()(SectionMap::value_type &v) { return v.second->change(_k,_v); }; + }; + + struct store_section: protected key_value + { + store_section(std::string &k, std::string &v): key_value(k,v) {}; + + bool operator()(Option &o) { return o.store(_v); }; + bool operator()(SectionMap::value_type &v) { return v.second->store(_k,_v); }; + }; + + struct set_section: protected key_value + { + set_section(std::string &k, std::string &v): key_value(k,v) {}; + + bool operator()(Option &o) { return (o.set(_v))[Option::F_ADJUSTED]; }; + bool operator()(SectionMap::value_type &v) { return v.second->set(_k,_v); }; + }; + + struct get_section: protected key_value + { + get_section(std::string &k, std::string &v): key_value(k,v) {}; + + bool operator()(Option &o) { return o.get(_v); }; + bool operator()(SectionMap::value_type &v) { return v.second->get(_k,_v); }; + }; + + struct modified_section + { + bool operator()(OptionMap::value_type &v) { return v.second.modified(); }; + bool operator()(SectionMap::value_type &v) { return v.second->modified(); }; + }; + + public: + bool load(const char * key, std::string value) + { + std::string skey(key); + return search_and_apply(skey, value, load_section(skey, value)); + } + + bool load(std::string &key, std::string &value) + { + return search_and_apply(key, value, load_section(key, value)); + } + + bool change(std::string &key, std::string &value) + { + return search_and_apply(key, value, change_section(key, value)); + } + + bool store(std::string &key, std::string &value) + { + return search_and_apply(key, value, store_section(key, value)); + } + + bool set(std::string &key, std::string &value) + { + return search_and_apply(key, value, set_section(key, value)); + } + + bool get(std::string &key, std::string &value) + { + return search_and_apply(key, value, get_section(key, value)); + } + + bool modified() + { + return ((find_if(_options.begin(), _options.end(), modified_section()) != _options.end()) || + (find_if(_sections.begin(), _sections.end(), modified_section()) != _sections.end())); + } + + private: + Section() {}; + + protected: + std::string _name; + std::string _description; + + OptionMap _options; + SectionMap _sections; + + bool _recursive; +}; + +#endif /* _CONFIG_SECTION_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/flagger.hpp b/src/mod/endpoints/mod_khomp/commons/flagger.hpp new file mode 100644 index 0000000000..49a4adda0f --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/flagger.hpp @@ -0,0 +1,102 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +#include + +#ifndef _FLAGGER_HPP_ +#define _FLAGGER_HPP_ + +template < typename Flag > +struct Flagger +{ + protected: + struct Bool + { + Bool(): value(false) {}; + Bool(bool &v): value(v) {}; + + bool value; + }; + + typedef std::map< Flag, Bool > Map; + + public: + typedef Initializer< Flag > InitFlags; + + Flagger() {}; + + Flagger(InitFlags flags) + { + for (typename InitFlags::iterator i = flags.begin(); i != flags.end(); i++) + { + Flag & flag = (*i); + _map[flag].value = true; + }; + }; + + void set(Flag elt, bool value = true) + { + _map[elt].value = value; + } + + bool is_set(Flag elt) + { + return _map[elt].value; + } + + Flagger & operator&(Flag elt) + { + set(elt); + return *this; + }; + + bool operator[](Flag elt) + { + return is_set(elt); + }; + + protected: + Map _map; +}; + +#endif /* _FLAGGER_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/format.cpp b/src/mod/endpoints/mod_khomp/commons/format.cpp new file mode 100644 index 0000000000..20f79204ec --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/format.cpp @@ -0,0 +1,331 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include "format.hpp" +//#include + +Format::Format(const char * format_string, bool raise_exception) +: _format(format_string), _valid(true), _raise(raise_exception) +{ + initialize(format_string); +} + +/* +Format::Format(std::string & format_string, bool raise_exception) +: _format(NULL), _valid(true), _raise(raise_exception) +{ + initialize(format_string.c_str()); +} +*/ + +Format::Format(std::string format_string, bool raise_exception) +: _format(format_string), _valid(true), _raise(raise_exception) +{ + initialize(format_string.c_str()); +} + +void Format::initialize(const char * format_string) +{ + std::string txt; + + const char * ptr = format_string; + + while (*ptr != '\0') + { + if (*ptr != '%') + { + txt += *ptr; + ++ptr; + continue; + } + + const char * ptr2 = ptr+1; + + if (*ptr2 == '%') + { + txt += *ptr; + + ptr += 2; + continue; + } + + if (!txt.empty()) + push_argument(txt, T_LITERAL); + + std::string arg(1, *ptr); + + ++ptr; + + bool finished = false; + + short long_count = 0; + short short_count = 0; + + while(*ptr != '\0' && !finished) + { + switch (*ptr) + { + case ' ': + // uncomplete format with ' ', make it a literal. + arg += *ptr; + push_argument(arg, T_LITERAL); + finished = true; + break; + + case '%': + // uncomplete format with '%', make it a literal and start a new format. + push_argument(arg, T_LITERAL); + arg += *ptr; + break; + + case 'h': + short_count = std::min(short_count+1, 2); + long_count = 0; + arg += *ptr; + break; + + case 'l': + long_count = std::min(long_count+1, 2); + short_count = 0; + arg += *ptr; + break; + + case 'd': + case 'i': + arg += *ptr; + switch (long_count - short_count) + { + case 2: + push_argument(arg, T_SIGNED_LONG_LONG); + break; + case 1: + push_argument(arg, T_SIGNED_LONG); + break; + case 0: + push_argument(arg, T_SIGNED_INT); + break; + case -1: + push_argument(arg, T_SIGNED_SHORT); + break; + case -2: + push_argument(arg, T_SIGNED_SHORT_SHORT); + break; + default: + break; + } + finished = true; + break; + + case 'o': + case 'u': + case 'x': + case 'X': + arg += *ptr; + switch (long_count - short_count) + { + case 2: + push_argument(arg, T_UNSIGNED_LONG_LONG); + break; + case 1: + push_argument(arg, T_UNSIGNED_LONG); + break; + case 0: + push_argument(arg, T_UNSIGNED_INT); + break; + case -1: + push_argument(arg, T_UNSIGNED_SHORT); + break; + case -2: + push_argument(arg, T_UNSIGNED_SHORT_SHORT); + break; + default: + break; + } + finished = true; + break; + + case 'e': + case 'E': + case 'f': + case 'F': + case 'g': + case 'G': + case 'a': + case 'A': + arg += *ptr; + push_argument(arg, T_FLOAT); + finished = true; + break; + + case 'c': + arg += *ptr; + push_argument(arg, T_CHAR); + finished = true; + break; + + case 's': + arg += *ptr; + push_argument(arg, T_STRING); + finished = true; + break; + + case 'p': + arg += *ptr; + push_argument(arg, T_POINTER); + finished = true; + break; + + case 'C': + case 'S': + case 'm': + case 'n': // unsupported for now. + arg += *ptr; + push_argument(arg, T_ANYTHING); + finished = true; + break; + + default: + arg += *ptr; + break; + } + + ++ptr; + } + + if (!arg.empty()) + push_argument(arg, T_LITERAL); + } + + if (!txt.empty()) + push_argument(txt, T_LITERAL); +} + +void Format::mark_invalid(std::string & msg) +{ + if (_valid) + { + _valid = false; + + std::string finalmsg; + + finalmsg += "** INVALID FORMAT: "; + finalmsg += msg; + finalmsg += " **"; + + _result = finalmsg; + } +} + +void Format::raise_check(void) +{ + if (!_valid && _raise) + throw InvalidFormat(_result); +} + +bool Format::validity_check(void) +{ + raise_check(); + + return _valid; +} + +const Format::Argument * Format::next_argument(void) +{ +// std::cerr << "size: " << _args.size() << std::endl; + + while (true) + { +// std::cerr << "loop size: " << _args.size() << std::endl; + + if (_args.empty()) + return NULL; // throw NoArgumentLeft(); + + const Argument & top = _args.front(); + + if (top.type() == T_LITERAL) + { +// std::cerr << "top type == LITERAL, looping..." << std::endl; + _result += top.fmts(); + pop_argument(); + } + else + { +// std::cerr << "top type: " << top.type() << std::endl; + return ⊤ + } + } +} + +void Format::pop_argument(void) +{ + _args.pop(); +} + +void Format::push_argument(std::string & data, Format::Type type) +{ +// std::cerr << "pushing type (" << type << ") with format (" << data << ")" << std::endl; + + _args.push(Argument(data, type)); + data.clear(); +} + +std::string Format::str() +{ + if (!validity_check()) + return _result; + + if (next_argument() == NULL) + return _result; + + std::string msg; + + msg += "too few arguments passed for format '"; + msg += _format; + msg += "' ("; + msg += _format; + msg += ")"; + + mark_invalid(msg); + + return _result; +} + + diff --git a/src/mod/endpoints/mod_khomp/commons/format.hpp b/src/mod/endpoints/mod_khomp/commons/format.hpp new file mode 100644 index 0000000000..b1ebe74396 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/format.hpp @@ -0,0 +1,512 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#ifndef _FORMAT_H_ +#define _FORMAT_H_ + +#include +#include +#include +#include +#include +#include +#include +#include + +#ifdef WIN32 // WINDOWS +#include +#endif + + +/* macros used for shortening lines and making the code clearer */ +#define STG(x) (x).str() +#define FMT(x) Format(x) + +struct Format +{ + static const unsigned int strings_base_length = 64; + static const unsigned int generic_base_length = 64; + + struct InvalidFormat + { + InvalidFormat(std::string msg) : _msg(msg) {} + + std::string _msg; + }; + + explicit Format(const char * format_string, bool raise_exception = false); + explicit Format(std::string format_string, bool raise_exception = false); + + void initialize(const char *); + + std::string str(void); + + //////////////////////////////////////////////////////////// + + protected: + + enum Type + { + T_ANYTHING = 1, + + T_SIGNED_SHORT, + T_SIGNED_SHORT_SHORT, + T_SIGNED_INT, + T_SIGNED_LONG, + T_SIGNED_LONG_LONG, + + T_UNSIGNED_SHORT, + T_UNSIGNED_SHORT_SHORT, + T_UNSIGNED_INT, + T_UNSIGNED_LONG, + T_UNSIGNED_LONG_LONG, + + T_FLOAT, + T_CHAR, + + T_POINTER, + T_STRING, + + T_LITERAL + }; + + struct Argument + { + Argument(std::string fmts, Type type) + : _fmts(fmts), _type(type) {}; + + Type type(void) const { return _type; } + const std::string & fmts(void) const { return _fmts; } + + protected: + std::string _fmts; + Type _type; + }; + + typedef std::queue < Argument > ArgumentQueue; + + //////////////////////////////////////////////////////////// + + public: + + template < typename V > + Format & operator%( V value ) + { + if (!validity_check()) + return *this; + + const Argument * top = next_argument(); + + if (top == NULL) + { + std::string msg; + + msg += "too many arguments passed for format '"; + msg += _format; + msg += "'"; + + mark_invalid(msg); + } + else + { + char temp[generic_base_length]; + + if (!generic_verify(value, top->type())) + { + std::string msg; + + msg += "type mismatch: got type '"; + msg += typeid(value).name(); + msg += "' in format '"; + msg += top->fmts(); + msg += "' ("; + msg += _format; + msg += ")"; + + mark_invalid(msg); + return *this; + } + + snprintf(temp, sizeof(temp), top->fmts().c_str(), value); + _result += temp; + + pop_argument(); + } + + raise_check(); + return *this; + } + + template < typename V > + Format & operator%( V * value ) + { + if (!validity_check()) + return *this; + + const Argument * top = next_argument(); + + if (top == NULL) + { + std::string msg; + + msg += "too many arguments passed for format '"; + msg += _format; + msg += "'"; + + mark_invalid(msg); + } + else + { + switch (top->type()) + { + case T_POINTER: + { + char temp[generic_base_length]; + snprintf(temp, sizeof(temp), top->fmts().c_str(), value); + _result += temp; + break; + } + + case T_STRING: + { + if ((typeid(const char) == typeid(V)) || + (typeid(char) == typeid(V)) || + (typeid(const unsigned char) == typeid(V)) || + (typeid(unsigned char) == typeid(V)) || + (typeid(const void) == typeid(V)) || + (typeid(void) == typeid(V))) + { + int len = strlen((const char*)value)+strings_base_length+1; + + char * temp = new char[len]; + + snprintf(temp, len, top->fmts().c_str(), value); + _result += temp; + + delete[] temp; + } + else + { + std::string msg; + + msg += "type mismatch: got type '"; + msg += typeid(value).name(); + msg += "' in string format ("; + msg += _format; + msg += ")"; + + mark_invalid(msg); + } + break; + } + + default: + { + std::string msg; + + msg += "type mismatch: got pointer/string type in format '"; + msg += top->fmts(); + msg += "' ("; + msg += _format; + msg += ")"; + + mark_invalid(msg); + break; + } + } + + pop_argument(); + } + + raise_check(); + return *this; + } + +/* + Format & operator%( std::string value ) + { + return operator%(value); + } +*/ + + Format & operator%( const std::string value ) + { + if (!validity_check()) + return *this; + + const Argument * top = next_argument(); + + if (top == NULL) + { + std::string msg; + + msg += "too many arguments passed for format '"; + msg += _format; + msg += "'"; + + mark_invalid(msg); + } + else + { + if (top->type() == T_STRING) + { + int len = value.length()+strings_base_length+1; + + char * temp = new char[len]; + + snprintf(temp, len, top->fmts().c_str(), value.c_str()); + _result += temp; + + delete[] temp; + } + else + { + std::string msg; + + msg += "type mismatch: got string type in format '"; + msg += top->fmts(); + msg += "' ("; + msg += _format; + msg += ")"; + + mark_invalid(msg); + } + + pop_argument(); + } + + raise_check(); + return *this; + } + + protected: + + template < typename V > + bool number_verify_signed_short( V value ) + { + return + ((typeid(V) == typeid(short int) || + typeid(V) == typeid(short) || + typeid(V) == typeid(const short int) || + typeid(V) == typeid(const short) || + typeid(V) == typeid(volatile short int) || + typeid(V) == typeid(volatile short)) && + sizeof(V) == sizeof(short)); + } + + template < typename V > + bool number_verify_unsigned_short( V value ) + { + return + ((typeid(V) == typeid(unsigned short int) || + typeid(V) == typeid(unsigned short) || + typeid(V) == typeid(const unsigned short int) || + typeid(V) == typeid(const unsigned short) || + typeid(V) == typeid(volatile unsigned short int) || + typeid(V) == typeid(volatile unsigned short)) && + sizeof(V) == sizeof(unsigned short)); + } + + template < typename V > + bool number_verify_signed_long( V value ) + { + return + ((typeid(V) == typeid(long int) || + typeid(V) == typeid(long) || + typeid(V) == typeid(const long int) || + typeid(V) == typeid(const long) || + typeid(V) == typeid(volatile long int) || + typeid(V) == typeid(volatile long)) && + sizeof(V) == sizeof(long)); + } + + template < typename V > + bool number_verify_unsigned_long( V value ) + { + return + ((typeid(V) == typeid(unsigned long int) || + typeid(V) == typeid(unsigned long) || + typeid(V) == typeid(const unsigned long int) || + typeid(V) == typeid(const unsigned long) || + typeid(V) == typeid(volatile unsigned long int) || + typeid(V) == typeid(volatile unsigned long)) && + sizeof(V) == sizeof(long long)); + } + + template < typename V > + bool number_verify_signed_long_long( V value ) + { + return + ((typeid(V) == typeid(long long int) || + typeid(V) == typeid(long long) || + typeid(V) == typeid(const long long int) || + typeid(V) == typeid(const long long) || + typeid(V) == typeid(volatile long long) || + typeid(V) == typeid(volatile long long int)) && + sizeof(V) == sizeof(long long)); + } + + template < typename V > + bool number_verify_unsigned_long_long( V value ) + { + return + ((typeid(V) == typeid(unsigned long long int) || + typeid(V) == typeid(unsigned long long) || + typeid(V) == typeid(const unsigned long long int) || + typeid(V) == typeid(const unsigned long long) || + typeid(V) == typeid(volatile unsigned long long) || + typeid(V) == typeid(volatile unsigned long long int)) && + sizeof(V) == sizeof(unsigned long long)); + } + + template < typename V > + bool number_verify_signed_int( V value ) + { + return + (sizeof(V) <= sizeof(int) || + typeid(V) == typeid(int) || + typeid(V) == typeid(const int) || + typeid(V) == typeid(volatile int)); + } + + template < typename V > + bool number_verify_unsigned_int( V value ) + { + return + (sizeof(V) <= sizeof(unsigned int) || + typeid(V) == typeid(unsigned int) || + typeid(V) == typeid(const unsigned int) || + typeid(V) == typeid(volatile unsigned int)); + } + + template < typename V > + bool generic_verify( V value, Type type ) + { + switch (type) + { + /* EXCEPTION: consider any number an valid input. */ + case T_SIGNED_INT: + case T_UNSIGNED_INT: + return + (number_verify_signed_int(value) || + number_verify_unsigned_int(value) || + number_verify_signed_long(value) || + number_verify_unsigned_long(value) || + number_verify_signed_short(value) || + number_verify_unsigned_short(value)); + + case T_SIGNED_SHORT_SHORT: + return (typeid(V) == typeid(char) || typeid(V) == typeid(const char)); + + case T_SIGNED_SHORT: + return number_verify_signed_short(value); + + case T_SIGNED_LONG: + return number_verify_signed_long(value); + + case T_SIGNED_LONG_LONG: + return number_verify_signed_long_long(value); + + case T_UNSIGNED_SHORT_SHORT: + return (typeid(V) == typeid(unsigned char) || typeid(V) == typeid(unsigned char)); + + case T_UNSIGNED_SHORT: + return number_verify_unsigned_short(value); + + case T_UNSIGNED_LONG: + return number_verify_unsigned_long(value); + + case T_UNSIGNED_LONG_LONG: + return number_verify_unsigned_long_long(value); + + case T_FLOAT: + return (typeid(V) == typeid(float)) || (typeid(V) == typeid(double) || + typeid(V) == typeid(const float)) || (typeid(V) == typeid(const double)); + + case T_CHAR: + return (typeid(V) == typeid(char)) || (typeid(V) == typeid(unsigned char) || + typeid(V) == typeid(const char)) || (typeid(V) == typeid(const unsigned char)); + + case T_POINTER: + case T_STRING: + return false; + + case T_ANYTHING: + return true; + + case T_LITERAL: + return false; + } + + return false; + }; + + void mark_invalid(std::string &); + + bool validity_check(void); + void raise_check(void); + +/* + struct NoArgumentLeft + { + NoArgumentLeft(): empty(0) {}; + + unsigned int empty; + }; +*/ + + const Argument * next_argument(void); + + void pop_argument(void); + void push_argument(std::string & data, Type type); + + private: + std::string _format; + + bool _valid; + bool _raise; + + std::string _result; + ArgumentQueue _args; +}; + +#endif /* _FORMAT_H_ */ + diff --git a/src/mod/endpoints/mod_khomp/commons/freeswitch/saved_condition.cpp b/src/mod/endpoints/mod_khomp/commons/freeswitch/saved_condition.cpp new file mode 100644 index 0000000000..29169f3d54 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/freeswitch/saved_condition.cpp @@ -0,0 +1,62 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include "saved_condition.hpp" + +bool SavedCondition::wait(unsigned int msec) +{ + bool ret = true; + + switch_mutex_lock(_mutex); + + if (!_signaled) + { + /* msec * 1000 = The amount of time in microseconds to wait. */ + if (switch_thread_cond_timedwait(_condition, _mutex, (switch_interval_time_t)msec * 1000) != 0) + ret = false; + } + + _signaled = false; + + switch_mutex_unlock(_mutex); + + return ret; +} diff --git a/src/mod/endpoints/mod_khomp/commons/freeswitch/saved_condition.hpp b/src/mod/endpoints/mod_khomp/commons/freeswitch/saved_condition.hpp new file mode 100644 index 0000000000..8acf0f3e0b --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/freeswitch/saved_condition.hpp @@ -0,0 +1,136 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#ifndef _SAVED_CONDITION_ +#define _SAVED_CONDITION_ + +#include + +extern "C" +{ + #include +} + +struct SavedCondition : public SavedConditionCommon// : public RefCounter < SavedCondition > +{ + typedef switch_thread_cond_t BaseConditionType; + typedef switch_mutex_t BaseMutexType; + + SavedCondition(switch_memory_pool_t *pool=NULL): + _pool(pool), + _can_delete_pool(false) + { + if(!_pool) + { + switch_core_new_memory_pool(&_pool); + _can_delete_pool = true; + } + + switch_thread_cond_create(&_condition, _pool); + switch_mutex_init(&_mutex, SWITCH_MUTEX_DEFAULT, _pool); + } + + //SavedCondition(const SavedCondition &); + ~SavedCondition() + { + switch_thread_cond_destroy(_condition); + switch_mutex_destroy(_mutex); + + if(_can_delete_pool) + switch_core_destroy_memory_pool(&_pool); + } + + void signal(void) + { + switch_mutex_lock(_mutex); + + _signaled = true; + switch_thread_cond_signal(_condition); + + switch_mutex_unlock(_mutex); + } + + void broadcast(void) + { + switch_mutex_lock(_mutex); + + _signaled = true; + switch_thread_cond_broadcast(_condition); + + switch_mutex_unlock(_mutex); + } + + void wait(void) + { + switch_mutex_lock(_mutex); + + if (!_signaled) + switch_thread_cond_wait(_condition, _mutex); + + _signaled = false; + + switch_mutex_unlock(_mutex); + } + + bool wait(unsigned int); + + void reset(void) + { + switch_mutex_lock(_mutex); + + _signaled = false; + + switch_mutex_unlock(_mutex); + } + + BaseMutexType * mutex() { return _mutex; }; + BaseConditionType * condition() { return _condition; }; + + protected: + + BaseConditionType *_condition; + BaseMutexType *_mutex; + switch_memory_pool_t *_pool; + bool _can_delete_pool; +}; + +#endif /* _SAVED_CONDITION_ */ + diff --git a/src/mod/endpoints/mod_khomp/commons/freeswitch/simple_lock.hpp b/src/mod/endpoints/mod_khomp/commons/freeswitch/simple_lock.hpp new file mode 100644 index 0000000000..530d912ee1 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/freeswitch/simple_lock.hpp @@ -0,0 +1,177 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#ifndef _SIMPLE_LOCK_HPP_ +#define _SIMPLE_LOCK_HPP_ + +#include + +extern "C" +{ + #include +} + +template < typename Implementor > +struct SimpleLockBasic: public SimpleLockCommon < Implementor > +{ + typedef SimpleLockCommon < Implementor > Super; + typedef typename Super::Result Result; + + typedef switch_mutex_t BaseMutexType; + + SimpleLockBasic(switch_memory_pool_t *pool = NULL) + : _pool(pool), _can_delete_pool( (_pool == NULL) ) + + { + if(!_pool) + switch_core_new_memory_pool(&_pool); + + //switch_mutex_init(&_mutex, SWITCH_MUTEX_DEFAULT, _pool); + switch_mutex_init(&_mutex, SWITCH_MUTEX_NESTED, _pool); + } + + virtual ~SimpleLockBasic() + { + /* do nothing */ + }; + + void unreference() + { + switch_mutex_destroy(_mutex); + + if (_can_delete_pool) + switch_core_destroy_memory_pool(&_pool); + } + + Result trylock() + { + switch (switch_mutex_trylock(_mutex)) + { + case SWITCH_STATUS_SUCCESS: + return Super::SUCCESS; + case SWITCH_STATUS_FALSE: + case SWITCH_STATUS_TERM: + case SWITCH_STATUS_NOTIMPL: + case SWITCH_STATUS_MEMERR: + case SWITCH_STATUS_GENERR: + case SWITCH_STATUS_SOCKERR: + case SWITCH_STATUS_NOTFOUND: + case SWITCH_STATUS_UNLOAD: + case SWITCH_STATUS_NOUNLOAD: + case SWITCH_STATUS_NOT_INITALIZED: + return Super::FAILURE; + //case SWITCH_STATUS_INUSE: + default: + return Super::ISINUSE; + } + } + + void unlock() + { + switch_mutex_unlock(_mutex); + } + + BaseMutexType * mutex() { return _mutex; }; + + protected: + BaseMutexType *_mutex; + switch_memory_pool_t *_pool; + bool _can_delete_pool; +}; + +struct SimpleLock: public SimpleLockBasic < SimpleLock > +{ + typedef SimpleLockBasic < SimpleLock > Super; + typedef Super::Result Result; + + SimpleLock(switch_memory_pool_t *pool = NULL) + : Super(pool) {}; + + Result lock() + { + switch (switch_mutex_lock(_mutex)) + { + case SWITCH_STATUS_SUCCESS: + return Super::SUCCESS; + case SWITCH_STATUS_FALSE: + case SWITCH_STATUS_TERM: + case SWITCH_STATUS_NOTIMPL: + case SWITCH_STATUS_MEMERR: + case SWITCH_STATUS_GENERR: + case SWITCH_STATUS_SOCKERR: + case SWITCH_STATUS_NOTFOUND: + case SWITCH_STATUS_UNLOAD: + case SWITCH_STATUS_NOUNLOAD: + case SWITCH_STATUS_NOT_INITALIZED: + return Super::FAILURE; + //case SWITCH_STATUS_INUSE: + default: + return Super::ISINUSE; + } + } +}; + +template < unsigned int Retries = 10, unsigned int Interval = 50 > +struct SimpleNonBlockLock: public SimpleLockBasic < SimpleNonBlockLock < Retries, Interval > > +{ + typedef SimpleLockBasic < SimpleNonBlockLock < Retries, Interval > > Super; + typedef typename Super::Result Result; + + SimpleNonBlockLock(switch_memory_pool_t *pool = NULL) + : Super(pool) {}; + + inline Result lock() + { + for (unsigned int i = 0; i < Retries; i++) + { + Result ret = Super::trylock(); + + if (ret != Super::ISINUSE) + return ret; + + usleep(Interval * 1000); + } + + return Super::ISINUSE; + } +}; + +#endif /* _SIMPLE_LOCK_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/freeswitch/thread.hpp b/src/mod/endpoints/mod_khomp/commons/freeswitch/thread.hpp new file mode 100644 index 0000000000..af50240307 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/freeswitch/thread.hpp @@ -0,0 +1,327 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#ifndef _THREAD_HPP_ +#define _THREAD_HPP_ + +#include + +extern "C" +{ + #include +} + +struct Thread : ThreadCommon +{ + typedef switch_thread_t BaseThreadType; + + template + struct ThreadData : ThreadDataCommon + { + ThreadData(T data, A arg) : _data(data), _arg(arg) {} + + int run() + { + return _data(_arg); + } + + T _data; + A _arg; + }; + + template + struct ThreadData < T, R, void > : ThreadDataCommon + { + ThreadData(T data) : _data(data) {} + + int run() + { + return _data(); + } + + T _data; + }; + + template + struct ThreadData < T, void, A > : ThreadDataCommon + { + ThreadData(T data, A arg) : _data(data), _arg(arg) {} + + int run() + { + _data(_arg); + return 0; + } + + T _data; + A _arg; + }; + + + template + struct ThreadData < T, void, void > : ThreadDataCommon + { + ThreadData(T data) : _data(data) {} + + int run() + { + _data(); + return 0; + } + + T _data; + }; + + template + Thread(T obj, switch_memory_pool_t *pool=NULL) : + _thread_info(new ThreadData::Return, void>(obj)), + _pool(pool), + _can_delete_pool(false) + { + if(!_pool) + { + switch_core_new_memory_pool(&_pool); + _can_delete_pool = true; + } + + _thread_info->_thread = this; + _thread_info->_self = NULL; + _thread_info->_attribute = NULL; + + if(switch_threadattr_create( + (switch_threadattr_t **)&_thread_info->_attribute, _pool) != 0) + { + _thread_info->_attribute = NULL; + return; + } + + switch_threadattr_stacksize_set( + (switch_threadattr_t *)_thread_info->_attribute, + SWITCH_THREAD_STACKSIZE); + + if(!priority()) + { + _thread_info->_attribute = NULL; + } + + } + + template + Thread(T obj, A arg, switch_memory_pool_t *pool=NULL) : + _thread_info(new ThreadData::Return, A>(obj, arg)), + _pool(pool), + _can_delete_pool(false) + { + if(!_pool) + { + switch_core_new_memory_pool(&_pool); + _can_delete_pool = true; + } + + _thread_info->_thread = this; + _thread_info->_self = NULL; + _thread_info->_attribute = NULL; + + if(switch_threadattr_create( + (switch_threadattr_t **)&_thread_info->_attribute, _pool) != 0) + { + _thread_info->_attribute = NULL; + return; + } + + switch_threadattr_stacksize_set( + (switch_threadattr_t *)_thread_info->_attribute, + SWITCH_THREAD_STACKSIZE); + + if(!priority()) + { + _thread_info->_attribute = NULL; + } + + } + + ~Thread() + { + if(_thread_info) + delete _thread_info; + + if (_can_delete_pool) + switch_core_destroy_memory_pool(&_pool); + } + + void detach(bool d = true) + { + if(!_thread_info->_attribute) + return; + + /* Non-zero if detached threads should be created. */ + switch_threadattr_detach_set( + (switch_threadattr_t *)_thread_info->_attribute, d ? 1 : 0); + } + + bool start() + { + if(!_pool || !_thread_info->_attribute) + return false; + + switch_thread_create((switch_thread_t**)&_thread_info->_self, + (switch_threadattr_t *)_thread_info->_attribute, + run, + _thread_info, + _pool); + + if(!_thread_info->_self) + return false; + + return true; + } + + int join() + { + /* + * block until the desired thread stops executing. + * @param retval The return value from the dead thread. + * @param thd The thread to join + * + * SWITCH_DECLARE(switch_status_t) switch_thread_join(switch_status_t *retval, switch_thread_t *thd); + */ + + if(!_thread_info->_self) + return -2; + + int retval = 0; + + if(switch_thread_join((switch_status_t*)&retval, + (switch_thread_t *)_thread_info->_self) != 0) + return -1; + + return retval; + } + + BaseThreadType * self() + { + //switch_thread_self(); + //apr_os_thread_current(); + return (BaseThreadType *)_thread_info->_self; + } + +private: + void exit(int status) + { + /** + * stop the current thread + * @param thd The thread to stop + * @param retval The return value to pass back to any thread that cares + */ + //SWITCH_DECLARE(switch_status_t) switch_thread_exit(switch_thread_t *thd, switch_status_t retval); + switch_thread_exit((switch_thread_t *)_thread_info->_self, (switch_status_t)status); + + } + +#ifndef WIN32 + struct apr_threadattr_t { + apr_pool_t *pool; + pthread_attr_t attr; + }; +#endif + + bool priority() + { +#ifndef WIN32 + struct sched_param param; + + struct apr_threadattr_t *myattr = (struct apr_threadattr_t *)_thread_info->_attribute; + + if (pthread_attr_setschedpolicy( + (pthread_attr_t *)&myattr->attr, SCHED_RR) < 0) + return false; + + if (pthread_attr_getschedparam( + (pthread_attr_t *)&myattr->attr, ¶m) < 0) + return false; + + param.sched_priority = sched_get_priority_max(SCHED_RR); + + if (pthread_attr_setschedparam( + (pthread_attr_t *)&myattr->attr, ¶m) < 0) + return false; + +#endif + return true; + +/* + //BUG in Freeswitch + if(switch_threadattr_priority_increase( + (switch_threadattr_t *)_thread_info->_attribute) != 0) + return false; + + return true; +*/ + } + + +protected: + ThreadDataCommon * _thread_info; + switch_memory_pool_t *_pool; + bool _can_delete_pool; + +protected: + + static void *SWITCH_THREAD_FUNC run(BaseThreadType *thread, void * obj) + { + //switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_DEBUG, + // "Starting new Thread\n"); + + ThreadDataCommon * data = (ThreadDataCommon *)obj; + int retval = data->run(); + + //switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_DEBUG, + // "Stopping new Thread = %d\n", retval); + + ((Thread *)(data->_thread))->exit(retval); + + return NULL; + } + +}; + + +#endif /* _THREAD_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/function.hpp b/src/mod/endpoints/mod_khomp/commons/function.hpp new file mode 100644 index 0000000000..c448299acd --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/function.hpp @@ -0,0 +1,337 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the "LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +#ifndef _FUNCTION_HPP_ +#define _FUNCTION_HPP_ + +namespace Function +{ + struct EmptyFunction {}; + + /**/ + + template < typename FunctionTraits > + struct StorageBase: NEW_REFCOUNTER(StorageBase < FunctionTraits >) + { + typedef typename FunctionTraits::BaseType BaseType; + + typedef typename FunctionTraits::FunType FunType; + typedef typename FunctionTraits::ObjType ObjType; + + template < typename Functor > + StorageBase(Functor f) + : _object(reinterpret_cast(new Functor(f))), + _function(reinterpret_cast(&(Functor::operator()))), + _malloced(true) + {}; + + template < typename Functor > + StorageBase(Functor & f, bool malloced) + : _object(reinterpret_cast((malloced ? new Functor(f) : &f))), + _function(reinterpret_cast(&(Functor::operator()))), + _malloced(malloced) + {}; + + StorageBase() + : _object(reinterpret_cast(0)), + _function(reinterpret_cast(0)), + _malloced(false) + {}; + + StorageBase(const StorageBase & o) + : INC_REFCOUNTER(o, StorageBase < FunctionTraits >), + _object(o._object), _function(o._function), _malloced(o._malloced) + {}; + + virtual ~StorageBase() {}; + + void unreference() + { + // TODO: will this work if we delete a different type? // + if (_malloced) + delete _object; + }; + + template < typename Functor > + void operator=(Functor f) + { + _object = reinterpret_cast(new Functor(f)), + _function = reinterpret_cast(&(Functor::operator())); + _malloced = false; + } + + protected: + ObjType _object; + FunType _function; + bool _malloced; + }; + + /**/ + + template < typename R > + struct VTable0 + { + R operator()(void) { return R(); }; + }; + + template < > + struct VTable0< void > + { + void operator()(void) { return; }; + }; + + template < typename R > + struct Function0Traits + { + typedef VTable0 BaseType; + + typedef R (BaseType::* FunType)(void); + typedef BaseType * ObjType; + }; + + /**/ + + template < typename R, typename A0 > + struct VTable1 + { + R operator()(A0 a0) { return R(); }; + }; + + template < typename A0 > + struct VTable1< void, A0 > + { + void operator()(A0 a0) { return; }; + }; + + template < typename R, typename A0 > + struct Function1Traits + { + typedef VTable1 BaseType; + + typedef R (BaseType::* FunType)(A0); + typedef BaseType * ObjType; + }; + + /**/ + + template < typename R, typename A0, typename A1 > + struct VTable2 + { + R operator()(A0 a0, A1) { return R(); }; + }; + + template < typename A0, typename A1 > + struct VTable2< void, A0, A1 > + { + void operator()(A0 a0, A1 a1) { return; }; + }; + + template < typename R, typename A0, typename A1 > + struct Function2Traits + { + typedef VTable2 BaseType; + + typedef R (BaseType::* FunType)(A0, A1); + typedef BaseType * ObjType; + }; + + /**/ + + template < typename R, typename A0, typename A1, typename A2 > + struct VTable3 + { + R operator()(A0 a0, A1 a1, A2 a2) { return R(); }; + }; + + template < typename A0, typename A1, typename A2 > + struct VTable3< void, A0, A1, A2 > + { + void operator()(A0 a0, A1 a1, A2 a2) { return; }; + }; + + template < typename R, typename A0, typename A1, typename A2 > + struct Function3Traits + { + typedef VTable3 BaseType; + + typedef R (BaseType::* FunType)(A0, A1, A2); + typedef BaseType * ObjType; + }; + + /**/ + + template < typename R, typename A0, typename A1, typename A2, typename A3 > + struct VTable4 + { + R operator()(A0 a0, A1 a1, A2 a2, A3 a3) { return R(); }; + }; + + template < typename A0, typename A1, typename A2, typename A3 > + struct VTable4< void, A0, A1, A2, A3 > + { + void operator()(A0 a0, A1 a1, A2 a2, A3 a3) { return; }; + }; + + template < typename R, typename A0, typename A1, typename A2, typename A3 > + struct Function4Traits + { + typedef VTable4 BaseType; + + typedef R (BaseType::* FunType)(A0, A1, A2, A3); + typedef BaseType * ObjType; + }; + + /**/ + + template < typename R, typename A0 > + struct Function0 : public StorageBase < Function0Traits < R > > + { + typedef StorageBase < Function0Traits < R > > Storage; + + template < typename Functor > + Function0(Functor f): Storage(f) {}; + + template < typename Functor > + Function0(Functor & f, bool m): Storage(f, m) {}; + + Function0() {}; + + R operator()(void) + { + if (reinterpret_cast(Storage::_object) == 0) + throw EmptyFunction(); + + return ((Storage::_object)->*(Storage::_function))(); + } + }; + + template < typename R, typename A0 > + struct Function1 : public StorageBase < Function1Traits < R, A0 > > + { + typedef StorageBase < Function1Traits < R, A0 > > Storage; + + template < typename Functor > + Function1(Functor f): Storage(f) {}; + + template < typename Functor > + Function1(Functor & f, bool m): Storage(f, m) {}; + + Function1() {}; + + R operator()(A0 a0) + { + if (reinterpret_cast(Storage::_object) == 0) + throw EmptyFunction(); + + return ((Storage::_object)->*(Storage::_function))(a0); + } + }; + + template < typename R, typename A0, typename A1 > + struct Function2 : public StorageBase < Function2Traits < R, A0, A1 > > + { + typedef StorageBase < Function2Traits < R, A0, A1 > > Storage; + + template < typename Functor > + Function2(Functor f): Storage(f) {}; + + template < typename Functor > + Function2(Functor & f, bool m): Storage(f, m) {}; + + Function2() {}; + + R operator()(A0 a0, A1 a1) + { + if (reinterpret_cast(Storage::_object) == 0) + throw EmptyFunction(); + + return ((Storage::_object)->*(Storage::_function))(a0, a1); + } + }; + + template < typename R, typename A0, typename A1, typename A2 > + struct Function3 : public StorageBase < Function3Traits < R, A0, A1, A2 > > + { + typedef StorageBase < Function3Traits < R, A0, A1, A2 > > Storage; + + template < typename Functor > + Function3(Functor f): Storage(f) {}; + + template < typename Functor > + Function3(Functor & f, bool m): Storage(f, m) {}; + + Function3() {}; + + R operator()(A0 a0, A1 a1, A2 a2) + { + if (reinterpret_cast(Storage::_object) == 0) + throw EmptyFunction(); + + return ((Storage::_object)->*(Storage::_function))(a0, a1, a2); + } + }; + + template < typename R, typename A0, typename A1, typename A2, typename A3 > + struct Function4 : public StorageBase < Function4Traits < R, A0, A1, A2, A3 > > + { + typedef StorageBase < Function4Traits < R, A0, A1, A2, A3 > > Storage; + + template < typename Functor > + Function4(Functor f): Storage(f) {}; + + template < typename Functor > + Function4(Functor & f, bool m): Storage(f, m) {}; + + Function4() {}; + + R operator()(A0 a0, A1 a1, A2 a2, A3 a3) + { + if (reinterpret_cast(Storage::_object) == 0) + throw EmptyFunction(); + + return ((Storage::_object)->*(Storage::_function))(a0, a1, a2, a3); + } + }; +}; + +#endif /* _FUNCTION_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/initializer.hpp b/src/mod/endpoints/mod_khomp/commons/initializer.hpp new file mode 100644 index 0000000000..e0e110d49c --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/initializer.hpp @@ -0,0 +1,80 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +#ifndef _INITIALIZER_HPP_ +#define _INITIALIZER_HPP_ + +template < typename Type > +struct Initializer: public std::vector< Type > +{ + typedef std::vector< Type > super; + + Initializer(Type e) { push_back(e); }; + Initializer(Type & e) { push_back(e); }; + + Initializer & operator&(Initializer v) + { + insert(super::end(), v.begin(), v.end()); + return *this; + }; + + Initializer & operator&(Initializer & v) + { + insert(super::end(), v.begin(), v.end()); + return *this; + }; + + Initializer & operator&(Type v) + { + insert(super::end(), v); + return *this; + }; + + Initializer & operator&(Type & v) + { + insert(super::end(), v); + return *this; + }; +}; + +#endif /* _INITIALIZER_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/k3lapi.cpp b/src/mod/endpoints/mod_khomp/commons/k3lapi.cpp new file mode 100644 index 0000000000..f5afa1348f --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/k3lapi.cpp @@ -0,0 +1,313 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +#include +#include + +K3LAPI::K3LAPI(bool has_exceptions) +: _has_exceptions(has_exceptions), + _device_count(0), _channel_count(0), _link_count(0), + _device_config(0), _channel_config(0), _link_config(0) +{}; + +/* initialize the whole thing! */ + +void K3LAPI::start(void) +{ + /* tie the used k3l to the compiled k3l version */ + char *ret = k3lStart(k3lApiMajorVersion, k3lApiMinorVersion, 0); //k3lApiBuildVersion); + + if (ret && *ret) + throw start_failed(ret); + + /* call init automagically */ + init(); +} + +void K3LAPI::stop(void) +{ + k3lStop(); + fini(); +} + +/* envio de comandos para placa */ + +void K3LAPI::mixer(int32 dev, int32 obj, byte track, KMixerSource src, int32 index) +{ + KMixerCommand mix; + + mix.Track = track; + mix.Source = src; + mix.SourceIndex = index; + + command(dev, obj, CM_MIXER, (const char *) &mix); +} + +void K3LAPI::mixerRecord(int32 dev, int32 obj, byte track, KMixerSource src, int32 index) +{ + /* estes buffers *NAO PODEM SER ESTATICOS*! */ + char cmd[] = { 0x3f, 0x03, (char)obj, (char)track, 0xff, 0xff }; + + switch (src) + { + case kmsChannel: + cmd[4] = 0x05; + cmd[5] = (char)index; + break; + + case kmsNoDelayChannel: + cmd[4] = 0x0a; + cmd[5] = (char)index; + break; + + case kmsGenerator: + cmd[4] = 0x09; + + switch ((KMixerTone)index) + { + case kmtSilence: + cmd[5] = 0x0F; + break; + case kmtDial: + cmd[5] = 0x08; + break; + case kmtBusy: + cmd[5] = 0x0D; + break; + + case kmtFax: + case kmtVoice: + case kmtEndOf425: + case kmtCollect: + case kmtEndOfDtmf: + /* TODO: exception, unable to generate */ + break; + } + break; + + case kmsCTbus: + case kmsPlay: + /* TODO: exception, not implemented! */ + break; + } + + int32 dsp = get_dsp(dev, DSP_AUDIO); + + raw_command(dev, dsp, cmd, sizeof(cmd)); +} + +void K3LAPI::mixerCTbus(int32 dev, int32 obj, byte track, KMixerSource src, int32 index) +{ + KMixerCommand mix; + + mix.Track = track; + mix.Source = src; + mix.SourceIndex = index; + + command(dev, obj, CM_MIXER_CTBUS, (const char *) &mix); +} + +void K3LAPI::command(int32 dev, int32 obj, int32 code, std::string & str) +{ + command(dev, obj, code, str.c_str()); +} + +void K3LAPI::command (int32 dev, int32 obj, int32 code, const char * parms) +{ + K3L_COMMAND cmd; + + cmd.Cmd = code; + cmd.Object = obj; + cmd.Params = (byte *)parms; + + int32 rc = k3lSendCommand(dev, &cmd); + + if (rc != ksSuccess) + throw failed_command(code, dev, obj, rc); +} + +void K3LAPI::raw_command(int32 dev, int32 dsp, std::string & str) +{ + raw_command(dev, dsp, str.data(), str.size()); +} + +void K3LAPI::raw_command(int32 dev, int32 dsp, const char * cmds, int32 size) +{ + std::string str(cmds, size); + + int32 rc = k3lSendRawCommand(dev, dsp, (void *)cmds, size); + + if (rc != ksSuccess) + throw failed_raw_command(dev, dsp, rc); +} + +KLibraryStatus K3LAPI::get_param(K3L_EVENT *ev, const char *name, std::string &res) +{ + char tmp_param[256]; + memset((void*)tmp_param, 0, sizeof(tmp_param)); + + int32 rc = k3lGetEventParam (ev, (sbyte *)name, (sbyte *)tmp_param, sizeof(tmp_param)-1); + + if (rc != ksSuccess) + return (KLibraryStatus)rc; + + res.append(tmp_param, strlen(tmp_param)); + return ksSuccess; +} + +std::string K3LAPI::get_param(K3L_EVENT *ev, const char *name) +{ + std::string res; + + KLibraryStatus rc = get_param(ev, name, res); + + if (rc != ksSuccess) + throw get_param_failed(name, rc); + + return res; +} + +void K3LAPI::init(void) +{ + if (_device_count != 0) return; + + _device_count = k3lGetDeviceCount(); + + _device_type = new KDeviceType[_device_count]; + _device_config = new device_conf_type[_device_count]; + _channel_config = new channel_ptr_conf_type[_device_count]; + _link_config = new link_ptr_conf_type[_device_count]; + _channel_count = new unsigned int[_device_count]; + _link_count = new unsigned int[_device_count]; + + for (unsigned int dev = 0; dev < _device_count; dev++) + { + KLibraryStatus ret = ksSuccess; + + _device_type[dev] = (KDeviceType) k3lGetDeviceType(dev); + + /* caches each device config */ + ret = (KLibraryStatus)k3lGetDeviceConfig(dev, ksoDevice + dev, &(_device_config[dev]), sizeof(_device_config[dev])); + + if (ret != ksSuccess) + throw start_failed(STG(FMT("k3lGetDeviceConfig(dev=%d): %s") % dev % Verbose::status(ret))); + + /* adjust channel/link count for device */ + _channel_count[dev] = _device_config[dev].ChannelCount; + _link_count[dev] = _device_config[dev].LinkCount; + + /* caches each channel config */ + _channel_config[dev] = new channel_conf_type[_channel_count[dev]]; + + for (unsigned int obj = 0; obj < _channel_count[dev]; obj++) + { + ret = (KLibraryStatus)k3lGetDeviceConfig(dev, ksoChannel + obj, &(_channel_config[dev][obj]), sizeof(_channel_config[dev][obj])); + + if (ret != ksSuccess) + throw start_failed(STG(FMT("k3lGetDeviceConfig(dev=%d,chan=%d): %s") % dev % obj % Verbose::status(ret))); + } + + /* adjust link count for device */ + _link_count[dev] = _device_config[dev].LinkCount; + + /* caches each link config */ + _link_config[dev] = new link_conf_type[_link_count[dev]]; + + for (unsigned int obj = 0; obj < _link_count[dev]; obj++) + { + ret = (KLibraryStatus)k3lGetDeviceConfig(dev, ksoLink + obj, &(_link_config[dev][obj]), sizeof(_link_config[dev][obj])); + + if (ret != ksSuccess) + throw start_failed(STG(FMT("k3lGetDeviceConfig(dev=%d,link=%d): %s") % dev % obj % Verbose::status(ret))); + } + } +} + +void K3LAPI::fini(void) +{ + for (unsigned int dev = 0; dev < _device_count; dev++) + { + if (_channel_config[dev]) + { + delete[] _channel_config[dev]; + _channel_config[dev] = NULL; + } + + if (_link_config[dev]) + { + delete[] _link_config[dev]; + _link_config[dev] = NULL; + } + } + + _device_count = 0; + + if (_device_type) { delete[] _device_type; _device_type = NULL; } + if (_device_config) { delete[] _device_config; _device_config = NULL; } + if (_channel_config) { delete[] _channel_config; _channel_config = NULL; } + if (_link_config) { delete[] _link_config; _link_config = NULL; } + if (_channel_count) { delete[] _channel_count; _channel_count = NULL; } + if (_link_count) { delete[] _link_count; _link_count = NULL; } +} + +int32 K3LAPI::get_dsp(int32 dev, K3LAPI::DspType type) +{ + switch (device_type(dev)) + { + case kdtFXO: + case kdtFXOVoIP: +#if K3L_AT_LEAST(1,6,0) + case kdtGSM: + case kdtGSMSpx: +#endif +#if K3L_AT_LEAST(2,1,0) + case kdtGSMUSB: + case kdtGSMUSBSpx: +#endif + return 0; + + default: + return (type == DSP_AUDIO ? 1 : 0); + } +} + diff --git a/src/mod/endpoints/mod_khomp/commons/k3lapi.hpp b/src/mod/endpoints/mod_khomp/commons/k3lapi.hpp new file mode 100644 index 0000000000..596548405b --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/k3lapi.hpp @@ -0,0 +1,408 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +#include + +/* if using full k3l.h (for softpbx), version already defined. */ +#ifndef k3lApiMajorVersion +# include +#endif + +#ifdef __GNUC_PREREQ +#if __GNUC_PREREQ(4,3) +#include +#endif +#endif + +#include + +#ifndef _K3LAPI_HPP_ +#define _K3LAPI_HPP_ + +struct K3LAPI +{ + /* exceptions */ + + struct start_failed + { + start_failed(const char * _msg) : msg(_msg) {}; + start_failed(std::string _msg) : msg(_msg) {}; + std::string msg; + }; + + struct failed_command + { + failed_command(int32 _code, unsigned short _dev, unsigned short _obj, int32 _rc) + : code(_code), dev(_dev), obj(_obj), rc(_rc) {}; + + int32 code; + unsigned short dev; + unsigned short obj; + int32 rc; + }; + + struct failed_raw_command + { + failed_raw_command(unsigned short _dev, unsigned short _dsp, int32 _rc) + : dev(_dev), dsp(_dsp), rc(_rc) {}; + + unsigned short dev; + unsigned short dsp; + int32 rc; + }; + + struct invalid_device + { + invalid_device(int32 _device) + : device(_device) {}; + + int32 device; + }; + + struct invalid_channel + { + invalid_channel(int32 _device, int32 _channel) + : device(_device), channel(_channel) {}; + + int32 device, channel; + }; + + struct invalid_link + { + invalid_link(unsigned int _device, unsigned int _link) + : device(_device), link(_link) {}; + + int32 device, link; + }; + + struct get_param_failed + { + get_param_failed(std::string _name, int32 _rc) + : name(_name), rc((KLibraryStatus)_rc) {}; + + std::string name; + KLibraryStatus rc; + }; + + typedef K3L_DEVICE_CONFIG device_conf_type; + typedef K3L_CHANNEL_CONFIG channel_conf_type; + typedef K3L_CHANNEL_CONFIG * channel_ptr_conf_type; + typedef K3L_LINK_CONFIG link_conf_type; + typedef K3L_LINK_CONFIG * link_ptr_conf_type; + + /* constructors/destructors */ + + K3LAPI(bool has_exceptions = false); + virtual ~K3LAPI() {}; + + /* (init|final)ialize the whole thing! */ + + void start(void); + void stop(void); + + /* verificacao de intervalos */ + + inline bool valid_device(int32 dev) + { + return (dev >= 0 && dev < ((int32)_device_count)); + } + + inline bool valid_channel(int32 dev, int32 obj) + { + return (valid_device(dev) && obj >= 0 && obj < ((int32)_channel_count[dev])); + } + + inline bool valid_link(int32 dev, int32 obj) + { + return (valid_device(dev) && obj >= 0 && obj < ((int32)_link_count[dev])); + } + + /*! + \brief High level object identifier + Since Khomp works with an object concept, this is used to map the + object id with its proper type. + */ + struct target + { + /*! The types a target can have */ + typedef enum { DEVICE, CHANNEL, MIXER, LINK } target_type; + + target(K3LAPI & k3lapi, target_type type_init, int32 device_value, int32 object_value) + : type(type_init), + device((unsigned short)device_value), + object((unsigned short)object_value) + { + switch (type_init) + { + case DEVICE: + if (!k3lapi.valid_device(device_value)) + throw invalid_device(device_value); + break; + + case CHANNEL: + case MIXER: + if (!k3lapi.valid_channel(device_value, object_value)) + throw invalid_channel(device_value, object_value); + break; + + case LINK: + if (!k3lapi.valid_link(device_value, object_value)) + throw invalid_link(device_value, object_value); + break; + } + + }; + + const target_type type; + + const unsigned short device; + const unsigned short object; + }; + + /* envio de comandos para placa (geral) */ + + void raw_command(int32 dev, int32 dsp, std::string & str); + void raw_command(int32 dev, int32 dsp, const char * cmds, int32 size); + + /* obter dados 'cacheados' (geral) */ + + inline unsigned int device_count(void) + { + return _device_count; + } + + /* envio de comandos para placa (sem identificadores) */ + + void mixer(int32 dev, int32 obj, byte track, KMixerSource src, int32 index); + void mixerRecord(int32 dev, int32 obj, byte track, KMixerSource src, int32 index); + void mixerCTbus(int32 dev, int32 obj, byte track, KMixerSource src, int32 index); + + void command (int32 dev, int32 obj, int32 code, std::string & str); + void command (int32 dev, int32 obj, int32 code, const char * parms = NULL); + + /* obter dados 'cacheados' (sem identificadores) */ + + inline unsigned int channel_count(int32 dev) + { + if (!valid_device(dev)) + { + if (_has_exceptions) + throw invalid_device(dev); + else + return 0; + } + + return _channel_count[dev]; + } + + inline unsigned int link_count(int32 dev) + { + if (!valid_device(dev)) + { + if (_has_exceptions) + throw invalid_device(dev); + else + return 0; + } + + return _link_count[dev]; + } + + inline uint32 channel_stats(int32 dev, int32 obj, uint32 index) + { + if (!valid_channel(dev, obj)) + { + if (_has_exceptions) + throw invalid_channel(dev, obj); + else + return 0; + } + + uint32 res_value = (uint32)-1; + stt_code stt_res = ksFail; + +#if K3L_AT_LEAST(2,1,0) + stt_res = k3lGetChannelStats(dev, obj, index, &res_value); +#endif + + if(stt_res != ksSuccess) + { + return (uint32)-1; + } + + return res_value; + } + + KDeviceType device_type(int32 dev) + { + if (!valid_device(dev)) + { + if (_has_exceptions) + throw invalid_device(dev); + else + return kdtDevTypeCount; + } + + return _device_type[dev]; + } + + + K3L_DEVICE_CONFIG & device_config(int32 dev) + { + if (!valid_device(dev)) + throw invalid_device(dev); + + return _device_config[dev]; + } + + K3L_CHANNEL_CONFIG & channel_config(int32 dev, int32 obj) + { + if (!valid_channel(dev, obj)) + throw invalid_channel(dev, obj); + + return _channel_config[dev][obj]; + } + + K3L_LINK_CONFIG & link_config(int32 dev, int32 obj) + { + if (!valid_link(dev, obj)) + throw invalid_channel(dev, obj); + + return _link_config[dev][obj]; + } + + /* envio de comandos para placa (com identificadores) */ + + void mixer(target & tgt, byte track, KMixerSource src, int32 index) + { + mixer((int32)tgt.device, (int32)tgt.object, track, src, index); + } + + void mixerRecord(target & tgt, byte track, KMixerSource src, int32 index) + { + mixerRecord((int32)tgt.device, (int32)tgt.object, track, src, index); + } + + void mixerCTbus(target & tgt, byte track, KMixerSource src, int32 index) + { + mixerCTbus((int32)tgt.device, (int32)tgt.object, track, src, index); + } + + void command (target & tgt, int32 code, std::string & str) + { + command((int32)tgt.device, (int32)tgt.object, code, str); + }; + + void command (target & tgt, int32 code, const char * parms = NULL) + { + command((int32)tgt.device, (int32)tgt.object, code, parms); + }; + + /* obter dados 'cacheados' (com indentificadores) */ + + inline unsigned int channel_count(target & tgt) + { + return _channel_count[tgt.device]; + } + + inline unsigned int link_count(target & tgt) + { + return _link_count[tgt.device]; + } + + KDeviceType device_type(target & tgt) + { + return _device_type[tgt.device]; + } + + + K3L_DEVICE_CONFIG & device_config(target & tgt) + { + return _device_config[tgt.device]; + } + + K3L_CHANNEL_CONFIG & channel_config(target & tgt) + { + return _channel_config[tgt.device][tgt.object]; + } + + K3L_LINK_CONFIG & link_config(target & tgt) + { + return _link_config[tgt.device][tgt.object]; + } + + /* pega valores em strings de eventos */ + + KLibraryStatus get_param(K3L_EVENT *ev, const char *name, std::string &res); + std::string get_param(K3L_EVENT *ev, const char *name); + + /* inicializa valores em cache */ + + void init(void); + void fini(void); + + /* utilidades diversas e informacoes */ + + enum DspType + { + DSP_AUDIO, + DSP_SIGNALING, + }; + + int32 get_dsp(int32, DspType); + + protected: + + const bool _has_exceptions; + + unsigned int _device_count; + unsigned int * _channel_count; + unsigned int * _link_count; + + device_conf_type * _device_config; + channel_ptr_conf_type * _channel_config; + link_ptr_conf_type * _link_config; + KDeviceType * _device_type; +}; + +#endif /* _K3LAPI_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/k3lutil.cpp b/src/mod/endpoints/mod_khomp/commons/k3lutil.cpp new file mode 100644 index 0000000000..83ac82efae --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/k3lutil.cpp @@ -0,0 +1,234 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +std::string K3LUtil::channelStatus(int32 dev, int32 channel, + Verbose::Presentation fmt) +{ + try + { + K3L_CHANNEL_CONFIG & config = _k3lapi.channel_config(dev, channel); + K3L_CHANNEL_STATUS status; + + KLibraryStatus ret = (KLibraryStatus) k3lGetDeviceStatus (dev, + channel + ksoChannel, &status, sizeof(status)); + + switch (ret) + { + case ksSuccess: return Verbose::channelStatus(config.Signaling, + status.AddInfo, fmt); + default: return (fmt == Verbose::EXACT ? "" + : "Unknown (fail)"); + } + } + catch(K3LAPI::invalid_channel & e) + { + return (fmt == Verbose::EXACT ? "" : "Unknown (fail)"); + } +} + +std::string K3LUtil::callStatus(int32 dev, int32 channel, + Verbose::Presentation fmt) +{ + K3L_CHANNEL_STATUS status; + + KLibraryStatus ret = (KLibraryStatus) k3lGetDeviceStatus(dev, + channel + ksoChannel, &status, sizeof(status)); + + switch (ret) + { + case ksSuccess: return Verbose::callStatus(status.CallStatus, fmt); + default: return (fmt == Verbose::EXACT ? "" + : "Unknown (fail)"); + } +} + +std::string K3LUtil::linkStatus(int32 dev, int32 link, + Verbose::Presentation fmt, KSignaling sig) +{ + try + { + if (sig == ksigInactive) + { + K3L_LINK_CONFIG & config = _k3lapi.link_config(dev, link); + sig = config.Signaling; + } + + K3L_LINK_STATUS status; + + KLibraryStatus ret = (KLibraryStatus) k3lGetDeviceStatus (dev, + link + ksoLink, &status, sizeof(status)); + + switch (ret) + { + case ksSuccess: return Verbose::linkStatus(sig, status.E1, fmt); + default: return (fmt == Verbose::EXACT ? + "" : "Unknown (failure)"); + } + } + catch(K3LAPI::invalid_channel & e) + { + return (fmt == Verbose::EXACT ? "" + : "Unknown (failure)"); + } +} + +std::string K3LUtil::getLinkStatus(int32 dev, int32 link, + Verbose::Presentation fmt) +{ + switch (_k3lapi.device_type(dev)) + { +#if K3L_AT_LEAST(1,6,0) + case kdtFXS: + case kdtFXSSpx: + return linkStatus(dev, link, fmt, ksigAnalogTerminal); + +#if K3L_AT_LEAST(2,1,0) + case kdtE1FXSSpx: + if (link == 1) + return linkStatus(dev, link, fmt, ksigAnalogTerminal); +#endif +#endif + default: + break; + } + + K3L_LINK_CONFIG & conf = _k3lapi.link_config(dev, link); + + std::string res = linkStatus(dev, link, fmt); + + if (conf.ReceivingClock & 0x01) + res += (fmt == Verbose::EXACT ? ",sync" : " (sync)"); + + return res; +} + +unsigned int K3LUtil::physicalLinkCount(int32 dev, bool count_virtual) +{ + unsigned int number = 0; + + try + { + switch (_k3lapi.device_type(dev)) + { +#if K3L_AT_LEAST(1,6,0) + case kdtFXS: + number = (count_virtual ? (_k3lapi.channel_count(dev) < 50 ? 1 : 2) : 0); + break; + + case kdtFXSSpx: + number = (count_virtual ? (_k3lapi.channel_count(dev) < 30 ? 1 : 2) : 0); + break; +#endif + +#if K3L_AT_LEAST(2,1,0) + case kdtE1FXSSpx: + number = (count_virtual ? 2 : 1); + break; +#endif + + /* E1 boards */ + case kdtE1: + case kdtE1Spx: + case kdtE1IP: + number = _k3lapi.link_count(dev); + break; + + case kdtPR: + case kdtE1GW: + number = 1; + break; + +#if K3L_AT_LEAST(1,6,0) + case kdtFXO: + case kdtFXOVoIP: + case kdtGSM: + case kdtGSMSpx: +#else + case kdtFX: + case kdtFXVoIP: +#endif + case kdtConf: + case kdtGWIP: +#if K3L_AT_LEAST(2,1,0) + case kdtGSMUSB: + case kdtGSMUSBSpx: + case kdtReserved1: // just to avoid warnings. + case kdtDevTypeCount: // just to avoid warnings. +#endif + number = 0; + break; + } + } + catch(K3LAPI::invalid_device & e) + { + return 0; + } + + return number; +} + + +K3LUtil::ErrorCountType K3LUtil::linkErrorCount(int32 dev, int32 link, + Verbose::Presentation fmt) +{ + ErrorCountType result; + K3L_LINK_ERROR_COUNTER status; + + KLibraryStatus ret = (KLibraryStatus) k3lGetDeviceStatus (dev, + link + ksoLinkMon, &status, sizeof(status)); + + switch (ret) + { + case ksSuccess: + for (unsigned int i = klecChangesToLock; i < klecCount; i++) + { + result.push_back(ErrorCountPairType(Verbose::linkErrorCounter + ((KLinkErrorCounter)i, fmt), status.ErrorCounters[i])); + } + /* fall */ + + default: + return result; + } +} + diff --git a/src/mod/endpoints/mod_khomp/commons/k3lutil.hpp b/src/mod/endpoints/mod_khomp/commons/k3lutil.hpp new file mode 100644 index 0000000000..e547f3df6e --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/k3lutil.hpp @@ -0,0 +1,82 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include +#include +#include + +#include +#include + +#ifndef _K3LUTIL_HPP_ +#define _K3LUTIL_HPP_ + +struct K3LUtil +{ + typedef std::pair < std::string, unsigned int > ErrorCountPairType; + typedef std::list < ErrorCountPairType > ErrorCountType; + + K3LUtil(K3LAPI & k3lapi): _k3lapi(k3lapi) {}; + + std::string callStatus(int32 dev, int32 channel, + Verbose::Presentation fmt = Verbose::HUMAN); + + std::string channelStatus(int32, int32, + Verbose::Presentation fmt = Verbose::HUMAN); + + std::string linkStatus(int32, int32, + Verbose::Presentation fmt = Verbose::HUMAN, + KSignaling sig = ksigInactive); + + std::string getLinkStatus(int32, int32, + Verbose::Presentation fmt = Verbose::HUMAN); + + unsigned int physicalLinkCount(int32 dev, bool count_virtual = false); + + ErrorCountType linkErrorCount(int32, int32, + Verbose::Presentation fmt = Verbose::HUMAN); + + protected: + K3LAPI & _k3lapi; +}; + +#endif /* _K3LUTIL_HPP_ */ + diff --git a/src/mod/endpoints/mod_khomp/commons/logger.hpp b/src/mod/endpoints/mod_khomp/commons/logger.hpp new file mode 100644 index 0000000000..6fcf7bffe3 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/logger.hpp @@ -0,0 +1,644 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include +#include +#include + +#include +#include +#include + +#include +#include +#include +#include + +#if defined(COMMONS_LIBRARY_USING_ASTERISK) +extern "C" +{ + #include +} +#elif defined(COMMONS_LIBRARY_USING_CALLWEAVER) +extern "C" +{ + #include +} +#elif defined(COMMONS_LIBRARY_USING_FREESWITCH) +extern "C" +{ + #include +} +#endif +/* + +******************************************************************************** +***************************** 'Logger' user manual ***************************** +******************************************************************************** + +* Description: + +This class does the management of log messages for applications. It works with +the following axioms: + +<*> There are several class of messages. +<*> There are some outputs, which may be files, sockets, or a console device. +<*> There are options for classes, for outputs and for the association of both. + +The last rule also shows the order in which options are processed: first the +'classes' options are processed, then 'output' options are processed, and then +the options for the tuple '(class, output)' are processed. + +The options are mapped like this: + + -> options [prefix, flags] + -> options [prefix] +( , ) -> options [prefix, flags] + + - "prefix" means a fixed string prefix before the real message. + - "flags" means auxiliary flags (DATETIME, THREADID) which are + used to add information based on OS or process context info. + +* Example of use: + +typedef enum +{ + C_DBG_FUNC, + C_DBG_LOCK, + C_WARNING, + C_ERROR, + C_CLI, +} +AstClassId; + +typedef enum +{ + F_CONSOLE, + F_GENERIC, + F_TRACE, +} +AstOutputId; + +// used to indicate the console log // +struct AstConsoleLog {}; + +struct AstPrinter: public Logger::DefaultPrinter +{ + typedef Logger::DefaultPrinter Super; + + using namespace Tagged; + + using Super::operator()(int); + + // just 2 type of descriptors // + typedef Union < int, Union < AstConsoleLog > > Container; + + ast_printer(std::string & msg): Super(msg) {}; + + bool operator()(const AstConsoleLog & log) + { + ast_console_puts(_msg.c_str()); + return true; + }; + +#if 0 + bool operator()(int log) + { + return Super::operator()(log); + }; +#endif +}; + +bool start_log() +{ + typedef Logger::Manager LogManager; + + LogManager logger; + + // shortcut definition // + typedef LogManager::Option LogOption; + + FILE * log_file = fopen( "output.log", "a"); + + if (!log_file) + return false; + + logger.add( F_CONSOLE, AstConsoleLog(), "chan_khomp: "); + logger.add( F_GENERIC, log_file); + + logger.classe( C_WARNING ) + & LogOption(F_CONSOLE, "WARNING: ", LogOption::Flags(LogOption::Flag(LogOption::DATETIME))) + & LogOption(F_GENERIC, "W: ", LogOption::Flags(LogOption::Flag(LogOption::DATETIME))) + + logger.classe( C_DBG_LOCK ).enabled(false); + + logger.classe( C_DBG_LOCK ) + & LogOption(F_GENERIC, "L: ", LogOption::Flags + (LogOption::flag_type(LogOption::ENABLED) & + LogOption::flag_type(LogOption::DATETIME)) + + logger(C_WARNING, "eu sou uma mensagem de warning"); + + logger.classe(C_WARNING).set(F_GENERIC, LogOption::ENABLED, true); + logger.classe(C_WARNING).set(F_CONSOLE, LogOption::ENABLED, false); + + logger.classe(C_CLI).prefix(""); + + return true; +} + +void message_the_user(int fd) +{ + logger(C_CLI, fd, "eu sou uma mensagem de cli!"); + logger(C_WARNING, "eu sou um warning"); +} + +******************************************************************************** +******************************************************************************** + +Now, the code..! + +*/ + +#ifndef _LOGGER_HPP_ +#define _LOGGER_HPP_ + +#include + +struct Logger +{ + /*** a base struct for printing messages in many ways ***/ + + struct DefaultPrinter + { + typedef Tagged::Union < int, Tagged::Union < FILE *, Tagged::Union < std::ostream * > > > BaseType; + + typedef bool ReturnType; + + DefaultPrinter(std::string & msg): _msg(msg) {}; + + bool operator()(std::ostream * out) + { + (*out) << _msg; + out->flush(); + + return out->good(); + } + + bool operator()(FILE * out) + { + if (fputs(_msg.c_str(), out) < 0) + return false; + + if (fflush(out) < 0) + return false; + + return true; + } + + bool operator()(int out) + { +#ifndef KWIN32 + return (write(out, _msg.c_str(), _msg.size()) == (int)_msg.size()); +#else + // no need for file descriptors on windows + return false; +#endif + } + + std::string & msg() { return _msg; } + + protected: + std::string & _msg; + }; + + /*** manage the printing of messages ***/ + + template + struct Manager + { + typedef typename Printer::BaseType BaseType; + + protected: + /* holds a stream, and an optimal message prefix */ + struct OutputOptions + { + OutputOptions(BaseType & stream, std::string & prefix) + : _stream(stream), _prefix(prefix) {}; + + BaseType _stream; + std::string _prefix; + LockType _lock; + }; + + typedef std::map < OutputId, OutputOptions > OutputMap; + + public: + + /* print in a specific 'message class' */ + struct ClassType + { + ClassType(void) + : _enabled(true) + {}; + +// ClassType(ClassType & o) +// : _stream_map(o._stream_map), _prefix(o.prefix), +// _lock(o._lock),_enabled(o._enabled) +// {}; + + /* initializes the options of the (class, stream) pair */ + struct Option + { + typedef enum { ENABLED, DATETIME, THREADID, DATETIMEMS } EnumType; + + typedef Flagger< EnumType > Flags; + typedef typename Flags::InitFlags InitFlags; + + Option(OutputId output, const char * prefix, + Flags flags = InitFlags(ENABLED)) + : _output(output), _prefix(prefix), _flags(flags) {}; + + Option(OutputId output, std::string prefix, + Flags flags = InitFlags(ENABLED)) + : _output(output), _prefix(prefix), _flags(flags) {}; + + Option(OutputId output, + Flags flags = InitFlags(ENABLED)) + : _output(output), _flags(flags) {}; + + OutputId _output; + std::string _prefix; + Flags _flags; + }; + + protected: + + /* holds a prefix and a activation status */ + struct OptionContainer + { + OptionContainer(std::string prefix, typename Option::Flags flags) + : _prefix(prefix), _flags(flags) {}; + + std::string _prefix; + typename Option::Flags _flags; + }; + + typedef std::multimap < OutputId, OptionContainer > OptionMap; + + /* utility function for printing */ + bool print(std::string & msg, BaseType & stream, LockType & lock) + { + lock.lock(); + + Printer p(msg); + bool ret = stream.visit(p); + + lock.unlock(); + + return ret; + }; + +/* + bool print(std::string & msg, BaseType & stream, LockType & lock) + { + lock.lock(); + + Printer p(msg); + bool ret = stream.visit(p); + + lock.unlock(); + + return ret; + }; +*/ + + public: + ClassType & operator&(const Option & value) + { + add(value._output, value._prefix, value._flags); + return *this; + } + + void add(OutputId output_id, std::string prefix, + typename Option::Flags flags) + { + typedef std::pair < OutputId, OptionContainer > pair_type; + _stream_map.insert(pair_type(output_id, OptionContainer(prefix, flags))); + } + + /* get and set methods for active mode */ + void set(OutputId id, typename Option::EnumType flag, bool value = true) + { + typename OptionMap::iterator iter = _stream_map.find(id); + + if (iter == _stream_map.end()) + return; + + (*iter).second._flags.set(flag, value); + } + + bool get(OutputId idx, typename Option::EnumType flag) + { + typename OptionMap::iterator iter = _stream_map.find(idx); + + if (iter == _stream_map.end()) + return false; + + return (*iter).second._flags.is_set(flag); + } + + /* get/adjust the enable/disable value for the class */ + void enabled(bool enabled) { _enabled = enabled; }; + bool enabled() { return _enabled; }; + + /* get/adjust the classe prefix */ + void prefix(const char * prefix) { _prefix = prefix; } + void prefix(std::string & prefix) { _prefix = prefix; } + std::string & prefix() { return _prefix; } + + /* printing function (operator, actually) */ + bool operator()(OutputMap & out_map, std::string & msg) + { + if (!_enabled) + return true; + + typedef typename OptionMap::iterator Iter; + + bool ret = true; + + for (Iter iter = _stream_map.begin(); iter != _stream_map.end(); iter++) + { + OptionContainer & opt = (*iter).second; + + if (!opt._flags[Option::ENABLED]) + continue; + + typename OutputMap::iterator out_iter = out_map.find((*iter).first); + + /* this stream have been added already? if not, skip! */ + if (out_iter == out_map.end()) + continue; + + /* final message */ + std::string out_msg; + + if (opt._flags[Option::DATETIME]) + { +#if defined(COMMONS_LIBRARY_USING_ASTERISK) +#if ASTERISK_AT_LEAST(1,6,0) + struct timeval tv; + struct ast_tm lt; + + gettimeofday(&tv, NULL); + +#else + time_t tv; + struct tm lt; + + time (&tv); +#endif + +#if ASTERISK_AT_LEAST(1,4,5) + ast_localtime (&tv, <, NULL); +#else + localtime_r (&tv, <); +#endif + + out_msg += STG(FMT("[%04d-%02d-%02d %02d:%02d:%02d] ") + % (lt.tm_year + 1900) % (lt.tm_mon + 1) % lt.tm_mday % lt.tm_hour + % lt.tm_min % lt.tm_sec); + +#elif defined(COMMONS_LIBRARY_USING_CALLWEAVER) + time_t tv; + struct tm lt; + + time (&tv); + + localtime_r (&tv, <); + + out_msg += STG(FMT("[%04d-%02d-%02d %02d:%02d:%02d] ") + % (lt.tm_year + 1900) % (lt.tm_mon + 1) % lt.tm_mday % lt.tm_hour + % lt.tm_min % lt.tm_sec); + +#elif defined(COMMONS_LIBRARY_USING_FREESWITCH) + time_t tv; + struct tm lt; + + time (&tv); + + localtime_r (&tv, <); + + out_msg += STG(FMT("[%04d-%02d-%02d %02d:%02d:%02d] ") + % (lt.tm_year + 1900) % (lt.tm_mon + 1) % lt.tm_mday % lt.tm_hour + % lt.tm_min % lt.tm_sec); + +#endif + } + + if (opt._flags[Option::DATETIMEMS]) + { +#if defined(COMMONS_LIBRARY_USING_ASTERISK) +#if ASTERISK_AT_LEAST(1,6,0) + struct timeval tv; + struct ast_tm lt; + + gettimeofday(&tv, NULL); + +#else + time_t tv; + struct tm lt; + + time (&tv); +#endif + +#if ASTERISK_AT_LEAST(1,4,5) + ast_localtime (&tv, <, NULL); +#else + localtime_r (&tv, <); +#endif + +#if ASTERISK_AT_LEAST(1,6,0) + out_msg += STG(FMT("[%04d-%02d-%02d %02d:%02d:%02d:%04d] ") + % (lt.tm_year + 1900) % (lt.tm_mon + 1) % lt.tm_mday % lt.tm_hour % lt.tm_min + % lt.tm_sec % (tv.tv_usec / 1000)); +#else + out_msg += STG(FMT("[%04d-%02d-%02d %02d:%02d:%02d:%04d] ") + % (lt.tm_year + 1900) % (lt.tm_mon + 1) % lt.tm_mday % lt.tm_hour % lt.tm_min + % lt.tm_sec % (tv * 1000)); +#endif + +#elif defined(COMMONS_LIBRARY_USING_CALLWEAVER) + time_t tv; + struct tm lt; + + time (&tv); + + localtime_r (&tv, <); + + out_msg += STG(FMT("[%04d-%02d-%02d %02d:%02d:%02d:%04d] ") + % (lt.tm_year + 1900) % (lt.tm_mon + 1) % lt.tm_mday % lt.tm_hour % lt.tm_min + % lt.tm_sec % (tv * 1000)); + +#elif defined(COMMONS_LIBRARY_USING_FREESWITCH) + time_t tv; + struct tm lt; + + time (&tv); + + localtime_r (&tv, <); + + out_msg += STG(FMT("[%04d-%02d-%02d %02d:%02d:%02d:%04d] ") + % (lt.tm_year + 1900) % (lt.tm_mon + 1) % lt.tm_mday % lt.tm_hour % lt.tm_min + % lt.tm_sec % (tv * 1000)); + +#endif + } + + OutputOptions & out_opt = (*out_iter).second; + + if (opt._flags[Option::THREADID]) + { +#if defined (COMMONS_LIBRARY_USING_ASTERISK) || defined(COMMONS_LIBRARY_USING_CALLWEAVER) || defined(COMMONS_LIBRARY_USING_FREESWITCH) + out_msg += STG(FMT("t=%08p ") % ((void*)pthread_self())); +#endif + } + + out_msg += _prefix; + out_msg += out_opt._prefix; + out_msg += opt._prefix; + out_msg += msg; + out_msg += "\n"; + + ret |= print(out_msg, out_opt._stream, out_opt._lock); + } + + return ret; + } + + bool operator()(BaseType & stream, std::string & msg) + { + std::string final_msg; + + final_msg += _prefix; + final_msg += msg; + final_msg += "\n"; + + return print(final_msg, stream, _lock); + } + + protected: + OptionMap _stream_map; + std::string _prefix; + LockType _lock; + bool _enabled; + }; + + /* util declaration */ + typedef typename ClassType::Option Option; + + /* class_id_type -> ClassType mapper */ + typedef std::map < ClassId, ClassType > ClassMap; + + /* local option pair */ + typedef std::pair < OutputId, OutputOptions > OutputOptionPair; + + void add(OutputId output, BaseType stream, const char * prefix = "") + { + std::string str_prefix(prefix); + + _output_map.insert(OutputOptionPair(output, OutputOptions(stream, str_prefix))); + } + + void add(OutputId output, BaseType stream, std::string prefix) + { + _output_map.insert(OutputOptionPair(output, OutputOptions(stream, prefix))); + } + + ClassType & classe(ClassId classeid) + { + return _classe_map[classeid]; + } + + bool operator()(ClassId classeid, const char * msg) + { + std::string str_msg(msg); + return _classe_map[classeid](_output_map, str_msg); + } + + bool operator()(ClassId classeid, std::string & msg) + { + return _classe_map[classeid](_output_map, msg); + } + + bool operator()(ClassId classeid, Format fmt) + { + std::string str_fmt = STG(fmt); + return _classe_map[classeid](_output_map, str_fmt); + } + + bool operator()(ClassId classeid, BaseType stream, const char * msg) + { + std::string str_msg(msg); + return _classe_map[classeid](stream, str_msg); + } + + bool operator()(ClassId classeid, BaseType stream, std::string & msg) + { + return _classe_map[classeid](stream, msg); + } + + bool operator()(ClassId classeid, BaseType stream, Format fmt) + { + std::string str_fmt = STG(fmt); + return _classe_map[classeid](stream, str_fmt); + } + + protected: + ClassMap _classe_map; + OutputMap _output_map; + }; + + private: + Logger(); +}; + +#endif /* _LOGGER_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/noncopyable.hpp b/src/mod/endpoints/mod_khomp/commons/noncopyable.hpp new file mode 100644 index 0000000000..d32faa8913 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/noncopyable.hpp @@ -0,0 +1,54 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#ifndef _NONCOPYABLE_HPP_ +#define _NONCOPYABLE_HPP_ + +struct NonCopyable +{ + NonCopyable() {}; + private: + NonCopyable(NonCopyable const &) { }; + NonCopyable & operator=(NonCopyable const &) { return *this; }; +}; + +#endif /* _NONCOPYABLE_HPP_ */ + diff --git a/src/mod/endpoints/mod_khomp/commons/refcounter.hpp b/src/mod/endpoints/mod_khomp/commons/refcounter.hpp new file mode 100644 index 0000000000..6ba8ae8b2f --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/refcounter.hpp @@ -0,0 +1,263 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the "LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +/* This struct uses static polymorphism, and derived classes should implement * + * the "unreference()" method, which should release all resources when called */ + +#ifndef _REFCOUNTER_HPP_ +#define _REFCOUNTER_HPP_ + +#define NEW_REFCOUNTER(...) public ReferenceCounter< __VA_ARGS__ > +#define INC_REFCOUNTER(o, ...) ReferenceCounter< __VA_ARGS__ >(static_cast< const ReferenceCounter < __VA_ARGS__ > & >(o)) + +#include + +#include +#include + +#ifdef DEBUG +# include +#endif + +struct ReferenceData: public NonCopyable +{ + ReferenceData() + : _data_count(1) + {}; + + inline unsigned int increment(void) + { + if (!_data_count) + abort(); + + Atomic::doAdd(&_data_count); + + return _data_count; + } + + inline unsigned int decrement(void) + { + if (!_data_count) + abort(); + + Atomic::doSub(&_data_count); + return _data_count; + } + + volatile unsigned int _data_count; +}; + +template < typename T > +struct ReferenceCounter +{ + typedef T Type; + + ReferenceCounter(bool create_counter = true) + : _reference_count(0) + { + reference_restart(create_counter); + +#ifdef DEBUG + std::cerr << ((void*)this) << ": ReferenceCounter() [ref_count=" + << (_reference_count ? (*_reference_count) : -1) << "]" << std::endl; +#endif + }; + + ReferenceCounter(const ReferenceCounter & o) + : _reference_count(0) + { + reference_reflect(o); + +#ifdef DEBUG + std::cerr << ((void*)this) << ": ReferenceCounter(" << ((void*)(&o)) << ") [ref_count=" + << (_reference_count ? (*_reference_count) : -1) << "]" << std::endl; +#endif + }; + + virtual ~ReferenceCounter() + { +#ifdef DEBUG + std::cerr << ((void*)this) << ": ~ReferenceCounter() [ref_count=" + << (_reference_count ? (*_reference_count) : -1) << "]" << std::endl; +#endif + reference_disconnect(_reference_count); + } + + ReferenceCounter & operator=(const ReferenceCounter & o) + { + reference_reflect(o); + +#ifdef DEBUG + std::cerr << ((void*)this) << ": ReferenceCounter::operator=(" << ((void*)(&o)) << ") [ref_count=" + << (_reference_count ? (*_reference_count) : -1) << "]" << std::endl; +#endif + + return *this; + }; + + protected: + inline void reference_restart(bool create_counter = false) + { + ReferenceData * oldref = _reference_count; + + _reference_count = (create_counter ? new ReferenceData() : 0); + + if (oldref) reference_disconnect(oldref); + } + + inline void reference_reflect(const ReferenceCounter & other) + { + ReferenceData * newref = other._reference_count; + ReferenceData * oldref = _reference_count; + + /* NOTE: increment before, avoid our reference being zero, even * + * for a short period of time. */ + + if (newref) newref->increment(); + + _reference_count = newref; + + if (oldref) reference_disconnect(oldref); + }; + + inline void reference_disconnect(ReferenceData *& counter) + { + if (counter) + { + unsigned int result = counter->decrement(); + + if (!result) + { + static_cast< Type * >(this)->unreference(); + delete counter; + } + + counter = 0; + } + }; + + private: + ReferenceData * _reference_count; +}; + +template < typename T > +struct ReferenceContainer: NEW_REFCOUNTER(ReferenceContainer< T >) +{ + /* type */ + typedef T Type; + + /* shorthand */ + typedef ReferenceCounter < ReferenceContainer< Type > > Counter; + + // TODO: make this a generic exception someday + struct NotFound {}; + + ReferenceContainer() + : Counter(false), + _reference_value(0) + {}; + + ReferenceContainer(Type * value) + : _reference_value(value) + {}; + + ReferenceContainer(const ReferenceContainer & value) + : Counter(false), + _reference_value(0) + { + operator()(value); + }; + + virtual ~ReferenceContainer() + {}; + + ReferenceContainer operator=(const ReferenceContainer & value) + { + operator()(value); + return *this; + }; + + /**/ + + void unreference() + { + if (_reference_value) + { + delete _reference_value; + _reference_value = 0; + } + } + + // simulates a copy constructor + void operator()(const ReferenceContainer & value) + { + Counter::reference_reflect(value); + + _reference_value = const_cast(value._reference_value); + }; + + // shortcut for operator below + void operator=(const Type * value) + { + operator()(value); + }; + + // accept value (pointer)! + void operator()(const Type * value) + { + Counter::reference_restart((value != 0)); + + _reference_value = const_cast(value); + }; + + // return value (pointer)! + Type * operator()(void) + { + return _reference_value; + }; + + protected: + Type * _reference_value; + + protected: +}; + +#endif /* _REFCOUNTER_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/regex.cpp b/src/mod/endpoints/mod_khomp/commons/regex.cpp new file mode 100644 index 0000000000..61f941c214 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/regex.cpp @@ -0,0 +1,148 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +#include + +void Regex::Expression::initialize(void) +{ + unsigned int tmplen = strlen(_expression); + + bool extflag = (_flags & E_EXTENDED); + + for (unsigned int i = 0; i < tmplen; ++i) + { + switch (_expression[i]) + { + case '\\': + ++i; + + if (!extflag && i < tmplen) + if (_expression[i] == '(') + ++_subcounter; + + break; + + case '(': + if (extflag) + ++_subcounter; + + default: + break; + } + } + + _errorstate = regcomp(&_comp_regex, _expression, _flags); +} + +std::string Regex::Expression::regerror_as_string(void) +{ + unsigned int count = regerror(_errorstate, &_comp_regex, 0, 0) + 1; + + char * msg = new char[count]; + + regerror(_errorstate, &_comp_regex, msg, count); + + std::string tmp(msg, count); + + delete[] msg; + + return tmp; +} + +void Regex::Match::initialize(void) +{ + if (_expression.valid()) + { + _subcounter = (_expression.subcount() + 2); // 0 + N.. + invalid + _submatches = new regmatch_t[_subcounter]; + _have_match = (regexec(_expression.repr(), _basestring.c_str(), + _subcounter, _submatches, _flags) == 0); + } +} + +std::string Regex::Match::replace(std::string rep, unsigned int index) +{ + ReplaceMap tmp; + tmp.insert(ReplacePair(index,rep)); + return replace(tmp); +} + +std::string Regex::Match::replace(Regex::ReplaceMap & map) +{ + if (!_have_match) + return _basestring; + + std::string buffer = _basestring; + + try + { + if (_submatches[0].rm_so != 0 && (map.find(0) != map.end())) + return _basestring.replace(_submatches[0].rm_so, _submatches[0].rm_eo - _submatches[0].rm_so, map.find(0)->second); + + for (unsigned int n = 1; (_submatches[n].rm_so != -1) && (n < _subcounter); n++) + { + //// s f RRR s f RRR s f RRRR s f + //// XXXYYY(ZZZ)AAA(BBB)CCCEEE(FFFF)GGGG + + bool globalsubs = false; + + if (map.find(n) == map.end()) + { + if (map.find(UINT_MAX) == map.end()) + continue; + + globalsubs = true; + } + + buffer = buffer.replace(_submatches[n].rm_so, + _submatches[n].rm_eo - _submatches[n].rm_so, + map.find((globalsubs ? UINT_MAX : n))->second); + } + } + catch (std::out_of_range e) + { + return ""; + } + + return buffer; +} diff --git a/src/mod/endpoints/mod_khomp/commons/regex.hpp b/src/mod/endpoints/mod_khomp/commons/regex.hpp new file mode 100644 index 0000000000..daf20147a8 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/regex.hpp @@ -0,0 +1,252 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +#include +#include + +#ifndef _REGEX_HPP_ +#define _REGEX_HPP_ + +struct Regex +{ + enum + { + E_EXTENDED = REG_EXTENDED, + E_IGNORE_CASE = REG_ICASE, + E_NO_SUB_MATCH = REG_NOSUB, + E_EXPLICIT_NEWLINE = REG_NEWLINE, + }; + + enum + { + M_NO_BEGIN_OF_LINE = REG_NOTBOL, + M_NO_END_OF_LINE = REG_NOTEOL, + }; + + enum + { + /* mark replace for full match (submatch "0"). */ + REP_BASE = 0u, + /* mark global string for replace. */ + REP_ALL = UINT_MAX, + }; + + typedef std::pair < unsigned int, std::string > ReplacePair; + typedef std::map < unsigned int, std::string > ReplaceMap; + + struct Expression : public NonCopyable + { + Expression(const char * expression, unsigned int flags = 0) + : _expression(expression), _alloced(false), + _subcounter(0), _errorstate(INT_MAX), _flags(flags) + { + initialize(); + } + + Expression(std::string & expression, unsigned int flags = 0) + : _expression(strdup(expression.c_str())), _alloced(true), + _subcounter(0), _errorstate(INT_MAX), _flags(flags) + { + initialize(); + } + + ~Expression() + { + if (_errorstate != INT_MAX) + regfree(&_comp_regex); + + if (_alloced) + { + delete _expression; + _expression = 0; + } + } + + bool valid(void) { return (_errorstate == 0); } + + unsigned int subcount(void) { return _subcounter; } + const regex_t * repr(void) { return &_comp_regex; } + + std::string error(void) + { + switch (_errorstate) + { + case 0: return ""; + case INT_MAX: return "uninitialized"; + default: return regerror_as_string(); + } + } + + private: + void initialize(void); + std::string regerror_as_string(void); + + protected: + const char * _expression; + bool _alloced; + + unsigned int _subcounter; + + int _errorstate; + regex_t _comp_regex; + + unsigned int _flags; + }; + + struct Match: NEW_REFCOUNTER(Match) + { + Match(const char * basestring, Expression & expression, unsigned int flags = 0) + : _basestring(basestring), _expression(expression), _subcounter(0), _submatches(0), + _have_match(false), _flags(flags) + { + initialize(); + } + + Match(std::string & basestring, Expression & expression, unsigned int flags = 0) + : _basestring(basestring), _expression(expression), _subcounter(0), _submatches(0), + _have_match(false), _flags(flags) + { + initialize(); + } + + Match(const Match & o) + : INC_REFCOUNTER(o, Match), + _basestring(o._basestring), _expression(o._expression), + _subcounter(o._subcounter), _submatches(o._submatches), + _have_match(o._have_match), _flags(o._flags) + { + } + + void unreference() + { + delete[] _submatches; + } + + bool matched(void) + { + return _have_match; + } + + bool matched(unsigned int number) + { + if (_have_match && number < _subcounter) + return (_submatches[number].rm_so != -1); + + return false; + } + + std::string submatch(int number) + { + if (!matched(number)) + return ""; + + return _basestring.substr(_submatches[number].rm_so, + _submatches[number].rm_eo - _submatches[number].rm_so); + } + + /** + * \brief gets a map with all matches + * \return std::map with all matches + * \note index 0 in map, is the complete string + * \author Eduardo Nunes Pereira + * + * If fails the empty map is returned + */ + std::map obtain_match_map() + { + int match_counter = 0; + std::map tmp_map; + while(matched(match_counter)) + { + tmp_map.insert(std::make_pair(match_counter,submatch(match_counter))); + match_counter++; + } + + return tmp_map; + } + + /** + * \brief replaces strings matched by parentesis + * \param each item of the vector is a parentesis replaced + * \return string replaced + * \note The overload method match only one string in parentesis. + * \author Eduardo Nunes Pereira + * + * If fails the empty string is returned. + */ + std::string replace(ReplaceMap &); + std::string replace(std::string, unsigned int index = REP_BASE); + + std::string operator[](int number) + { + return submatch(number); + } + + // NOTE: there is already a way to get subcount defined on EXPRESSION class! + + private: + void initialize(void); + + protected: + std::string _basestring; + Expression & _expression; + + unsigned int _subcounter; + regmatch_t * _submatches; + + bool _have_match; + unsigned int _flags; + }; +}; + +#endif /* _REGEX_HPP_ */ + diff --git a/src/mod/endpoints/mod_khomp/commons/ringbuffer.cpp b/src/mod/endpoints/mod_khomp/commons/ringbuffer.cpp new file mode 100644 index 0000000000..428bd29221 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/ringbuffer.cpp @@ -0,0 +1,575 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +/********** BUFFER FUNCTIONS **********/ + +/* writes everything or nothing */ +bool Ringbuffer_traits::traits_provide(char * buffer, const char * value, unsigned int amount, bool skip_overwrite) +{ + /* avoid using different values */ + Buffer_table cache = _pointers; + + const unsigned int reader = cache.reader.complete; + const unsigned int writer = cache.writer.complete; + + const unsigned int dest = cache.writer.complete - 1; + + const bool reader_less = cache.reader.complete < cache.writer.complete; + + if (amount >= _size) + return false; + + bool ret = true; + + /* should we go around the buffer for writing? */ + if (((writer + amount) > _size) && (reader_less || !skip_overwrite)) + { + /* Documentation of the formula used in the 'if' below. + * + * [0|1|2|3|4|5|6|7] => size=8 + * | | + * reader | + * writer + * + * => writer has places [5,6,7,0,1] to write (5 places). + * + * => 8 - (4-2+1) = 8 - (2+1) = 8 - 3 = 5 + * + * > writer goes 1 up, amount goes 1 down. + * > reader goes 1 up, amount goes 1 up. + * > size goes 1 down, amount goes 1 down. + * + */ + + if ((_size - (writer - reader + 1)) <= amount) + { + if (skip_overwrite) + return false; + + do + { + Buffer_pointer extra(cache.reader); + extra.complete = (extra.complete + amount) % _size; + + if (update(cache.reader, extra)) + break; + } + while (true); + + ret = false; + } + + unsigned int wr1 = _size - writer + 1; /* writer is already 1 position after */ + unsigned int wr2 = amount - wr1; + +// fprintf(stderr, "%p> partial write: (%d/%d) %d/%d [%d/%d]\n", this, wr1, wr2, amount, _size, reader, writer); + + /* two partial writes (one at the end, another at the beginning) */ + memcpy((void *) &(buffer[dest]), (const void *) (value), _block * wr1); + memcpy((void *) (buffer), (const void *) &(value[wr1]), _block * wr2); + } + else + { + if (!reader_less && ((reader - writer) <= amount)) + { + if (skip_overwrite) + return false; + + do + { + Buffer_pointer extra(cache.reader); + extra.complete = (extra.complete + amount) % _size; + + if (update(cache.reader, extra)) + break; + } + while (true); + + ret = false; + } + +// fprintf(stderr, "%p> full write: a=%d/s=%d [r=%d/w=%d]\n", this, amount, _size, reader, writer); + + /* we are talking about buffers here, man! */ + memcpy((void *) &(buffer[dest]), (const void *) value, _block * amount); + } + + _pointers.writer.complete = ((dest + amount) % _size) + 1; + _pointers.writer.partial = 1; + +// fprintf(stderr, "%p> write end: %d [block=%d]\n", this, writer, _block); + + return ret; +} + +/* returns the number of itens that have been read */ +unsigned int Ringbuffer_traits::traits_consume(const char * buffer, char * value, unsigned int amount, bool atomic_mode) +{ + /* avoid using different values */ + Buffer_table cache = _pointers; + + const unsigned int writer = _pointers.writer.complete; + const unsigned int reader = _pointers.reader.complete; + + const bool writer_less = writer < reader; + + unsigned int total = 0; + + /* should we go around the buffer for reading? */ + if (writer_less && (reader + amount >= _size)) + { + total = std::min(_size - (reader - writer + 1), amount); + + if ((total == 0) || (atomic_mode && (total < amount))) + return 0; + + unsigned int rd1 = _size - reader; + unsigned int rd2 = total - rd1; + +// fprintf(stderr, "%p> partial read: (%d/%d) %d/%d [%d/%d]\n", this, rd1, rd2, total, _size, reader, writer); + + /* two partial consumes (one at the end, another at the beginning) */ + memcpy((void *) (value), (const void *) &(buffer[reader]), _block * rd1); + memcpy((void *) &(value[rd1]), (const void *) (buffer), _block * rd2); + } + else + { + total = std::min((!writer_less ? writer - (reader + 1) : amount), amount); + + if ((total == 0) || (atomic_mode && (total < amount))) + return 0; + +// fprintf(stderr, "%p> full read: %d/%d [%d/%d]\n", this, total, _size, reader, writer); + + /* we are talking about buffers here, man! */ + memcpy((void *) value, (const void *) &(buffer[reader]), _block * total); + } + + do + { + /* jump the reader forward */ + Buffer_pointer index((cache.reader.complete + total) % _size); + + if (update(cache.reader, index)) + break; + } + while (true); + +// fprintf(stderr, "%p> read end: %d [block=%d]\n", this, reader, _block); + + return total; +} + +/********** TWO-PHASE BUFFER FUNCTIONS ***********/ + +/* returns the number of itens that have been read */ +unsigned int Ringbuffer_traits::traits_consume_begins(const char * buffer, char * value, unsigned int amount, bool atomic_mode) +{ + Buffer_table cache = _pointers; + + /* avoid using different values */ + const unsigned int reader = cache.reader.complete; + const unsigned int writer = cache.writer.complete; + + const bool writer_less = writer < reader; + + unsigned int total = 0; + + /* should we go around the buffer for reading? */ + if (writer_less && (reader + amount >= _size)) + { + total = std::min(_size - (reader - writer + 1), amount); + + if ((total == 0) || (atomic_mode && (total < amount))) + return 0; + + unsigned int rd1 = _size - reader; + unsigned int rd2 = total - rd1; + +// fprintf(stderr, "%p> partial read: (%d/%d) %d/%d [%d/%d]\n", this, rd1, rd2, total, _size, reader, writer); + + /* two partial consumes (one at the end, another at the beginning) */ + memcpy((void *) (value), (const void *) &(buffer[reader]), _block * rd1); + memcpy((void *) &(value[rd1]), (const void *) (buffer), _block * rd2); + } + else + { + total = std::min((!writer_less ? writer - (reader + 1) : amount), amount); + + if ((total == 0) || (atomic_mode && (total < amount))) + return 0; + +// fprintf(stderr, "%p> full read: %d/%d [%d/%d]\n", this, total, _size, reader, writer); + + /* we are talking about buffers here, man! */ + memcpy((void *) value, (const void *) &(buffer[reader]), _block * total); + } + +// fprintf(stderr, "%p> read end: %d [%d]\n", this, _reader, _reader_partial); + + return total; +} + +bool Ringbuffer_traits::traits_consume_commit(unsigned int amount) +{ + /* avoid using different values */ + Buffer_table cache = _pointers; + + const unsigned int writer = cache.writer.complete; + const unsigned int reader = cache.reader.complete; + + const bool writer_less = writer < reader; + + unsigned int total = 0; + + /* should we go around the buffer for reading? */ + if (writer_less && (reader + amount >= _size)) + { + total = std::min(_size - (reader - writer + 1), amount); + + if (total < amount) + return false; + +// fprintf(stderr, "%p> partial read: (%d/%d) %d/%d [%d/%d]\n", this, rd1, rd2, total, _size, reader, writer); + } + else + { + total = std::min((!writer_less ? writer - (reader + 1) : amount), amount); + + if (total < amount) + return false; + +// fprintf(stderr, "%p> full read: %d/%d [%d/%d]\n", this, total, _size, reader, writer); + } + + do + { + /* jump the reader forward */ + Buffer_pointer index(cache.reader); + index.complete = (index.complete + total) % _size; + + if (update(cache.reader, index)) + break; + } + while (true); + +// fprintf(stderr, "%p> read end: %d [%d]\n", this, _reader, _reader_partial); + + return true; +} + +/********** PARTIAL BUFFER FUNCTIONS (bytes) ***********/ + +/* writes everything or nothing */ +bool Ringbuffer_traits::traits_provide_partial(char * buffer, const char * value, unsigned int amount) +{ + /* avoid using different values */ + Buffer_table cache = _pointers; + + const unsigned int reader = (cache.reader.complete * _block) + cache.reader.partial; + const unsigned int writer = ((cache.writer.complete - 1) * _block) + cache.writer.partial; + + const unsigned int size = _size * _block; + const unsigned int dest = writer - 1; + +// fprintf(stderr, "%p> provide partial: %d/%d [%d/%d]\n", this, reader, writer, amount, size); + + const bool reader_less = reader < writer; + + /* should we go around the buffer for writing? */ + if (reader_less && ((writer + amount) > size)) + { + /* Documentation of the formula used in the 'if' below. + * + * [0|1|2|3|4|5|6|7] => size=8 + * | | + * reader | + * writer + * + * => writer has places [5,6,7,0,1] to write (5 places). + * + * => 8 - (4-2+1) = 8 - (2+1) = 8 - 3 = 5 + * + * > writer goes 1 up, amount goes 1 down. + * > reader goes 1 up, amount goes 1 up. + * > size goes 1 down, amount goes 1 down. + * + */ + + if ((size - (writer - reader + 1)) <= amount) + return false; + + unsigned int wr1 = size - writer + 1; /* writer is already 1 position after */ + unsigned int wr2 = amount - wr1; + +// fprintf(stderr, "%p> p partial write: (%d/%d) %d/%d [%d/%d]\n", this, wr1, wr2, amount, size, reader, writer); + + /* two partial writes (one at the end, another at the beginning) */ + memcpy((void *) &(buffer[dest]), (const void *) (value), wr1); + memcpy((void *) (buffer), (const void *) &(value[wr1]), wr2); + } + else + { + if (!reader_less && ((reader - writer) <= amount)) + return false; + +// fprintf(stderr, "%p> p full write: %d/%d [r=%d/w=%d]\n", this, amount, size, reader, writer); + + /* we are talking about buffers here, man! */ + memcpy((void *) &(buffer[dest]), (const void *) value, amount); + } + + unsigned int new_writer = ((dest + amount) % size) + 1; + + /* update "full length position" */ + _pointers.writer.complete = (unsigned int)floor((double) new_writer / (double)_block)+1; + _pointers.writer.partial = (unsigned short)(new_writer % _block); + +// fprintf(stderr, "%p> p write end: %d [block=%d]\n", this, new_writer, _block); + + return true; +} + +/* returns the number of bytes that have been read */ +unsigned int Ringbuffer_traits::traits_consume_partial(const char * buffer, char * value, unsigned int amount) +{ + /* avoid using different values */ + Buffer_table cache = _pointers; + + const unsigned int writer = ((cache.writer.complete - 1) * _block) + cache.writer.partial; + const unsigned int reader = (cache.reader.complete * _block) + cache.reader.partial; + + const unsigned int size = _size * _block; + +// fprintf(stderr, "%p> consume partial: %d/%d [%d/%d]\n", this, reader, writer, amount, size); + + const bool writer_less = writer < reader; + + unsigned int total = 0; + + /* should we go around the buffer for reading? */ + if (writer_less && (reader + amount >= size)) + { + total = std::min(size - (reader - writer + 1), amount); + + if (total == 0) + return 0; + + unsigned int rd1 = size - reader; + unsigned int rd2 = total - rd1; + +// fprintf(stderr, "%p> p partial read: (%d/%d) %d/%d [%d/%d]\n", this, rd1, rd2, total, size, reader, writer); + + /* two partial consumes (one at the end, another at the beginning) */ + memcpy((void *) (value), (const void *) &(buffer[reader]), rd1); + memcpy((void *) &(value[rd1]), (const void *) (buffer), rd2); + } + else + { + total = std::min((writer_less ? amount : writer - (reader + 1)), amount); + + if (total == 0) + return 0; + +// fprintf(stderr, "%p> p full read: %d/%d [r=%d/w=%d]\n", this, total, size, reader, writer); + + /* we are talking about buffers here, man! */ + memcpy((void *) value, (const void *) &(buffer[reader]), total); + } + + do + { + unsigned int new_reader = (((cache.reader.complete * _block) + cache.reader.partial) + total) % size; + + /* jump the reader forward */ + Buffer_pointer index((unsigned int)floor((double)new_reader / (double)_block), + (unsigned short)(new_reader % _block)); + + if (update(cache.reader, index)) + { +// fprintf(stderr, "%p> p read end: %d [block=%d]\n", this, new_reader, _block); + break; + } + } + while (true); + + return total; +} + + + +/********** IO FUNCTIONS **********/ + +/* returns the number of items written to from buffer to stream */ +unsigned int Ringbuffer_traits::traits_put(const char * buffer, std::ostream &fd, unsigned int amount) +{ + /* avoid using different values */ + Buffer_table cache = _pointers; + + const unsigned int reader = cache.reader.complete; + const unsigned int writer = cache.writer.complete; + + const bool writer_less = writer < reader; + + unsigned int total = 0; + + /* should we go around the buffer for reading? */ + if (writer_less && (reader + amount >= _size)) + { + total = std::min(_size - (reader - writer + 1), amount); + + if (total == 0) + return 0; + + unsigned int rd1 = _size - reader; + unsigned int rd2 = total - rd1; + +// fprintf(stderr, "%p> partial read: (%d/%d) %d/%d [%d/%d]\n", this, rd1, rd2, total, _size, reader, writer); + + /* two partial consumes (one at the end, another at the beginning) */ + fd.write((const char *) &(buffer[reader]), _block * rd1); + fd.write((const char *) (buffer), _block * rd2); + } + else + { + total = std::min((!writer_less ? writer - (reader + 1) : amount), amount); + + if (total == 0) + return 0; + +// fprintf(stderr, "%p> full read: %d/%d [%d/%d]\n", this, total, _size, reader, writer); + + /* we are talking about buffers here, man! */ + fd.write((const char *) &(buffer[reader]), _block * total); + } + + do + { + /* jump the reader forward */ + Buffer_pointer index(cache.reader); + index.complete = (index.complete + total) % _size; + + if (update(cache.reader, index)) + break; + } + while (true); + + return total; +} + +/* returns number of items read from stream to buffer */ +unsigned int Ringbuffer_traits::traits_get(char * buffer, std::istream &fd, unsigned int amount) +{ + /* avoid using different values */ + Buffer_table cache = _pointers; + + const unsigned int reader = cache.reader.complete; + const unsigned int writer = cache.writer.complete; + + const unsigned int dest = writer - 1; + + const bool reader_less = reader < writer; + + unsigned int real_amount = 0; + + /* should we go around the buffer for writing? */ + if (reader_less && ((writer + amount) > _size)) + { + /* Documentation of the formula used in the 'if' below. + * + * [0|1|2|3|4|5|6|7] => size=8 + * | | + * reader | + * writer + * + * => writer has places [5,6,7,0,1] to write (5 places). + * + * => 8 - (4-2+1) = 8 - (2+1) = 8 - 3 = 5 + * + * > writer goes 1 up, amount goes 1 down. + * > reader goes 1 up, amount goes 1 up. + * > size goes 1 down, amount goes 1 down. + * + */ + + if ((_size - (writer - reader + 1)) <= amount) + return false; + + unsigned int wr1 = _size - writer + 1; /* writer is already 1 position after */ + unsigned int wr2 = amount - wr1; + +// fprintf(stderr, "%p> partial write: (%d/%d) %d/%d [%d/%d]\n", this, wr1, wr2, amount, _size, reader, writer); + + unsigned int char_amount = 0; + + /* one partial write on the buffer (at the end) */ + fd.read((char *) &(buffer[dest]), _block * wr1); + char_amount += fd.gcount(); + + if (fd.gcount() == (int)(_block * wr1)) + { + /* another partial write on the buffer (at the beginning) */ + fd.read((char *) (buffer), _block * wr2); + char_amount += fd.gcount(); + } + + real_amount = char_amount / _block; + } + else + { + if (!reader_less && ((reader - writer) <= amount)) + return false; + +// fprintf(stderr, "%p> full write: %d/%d [%d/%d]\n", this, amount, _size, reader, writer); + + /* we are talking about buffers here, man! */ + fd.read((char *) &(buffer[dest]), _block * amount); + + real_amount = fd.gcount() / _block; + } + + _pointers.writer.complete = ((dest + real_amount) % _size) + 1; + _pointers.writer.partial = 1; + + return real_amount; +} diff --git a/src/mod/endpoints/mod_khomp/commons/ringbuffer.hpp b/src/mod/endpoints/mod_khomp/commons/ringbuffer.hpp new file mode 100644 index 0000000000..39f8ffe8fb --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/ringbuffer.hpp @@ -0,0 +1,416 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +/* WARNING: This is a generic ringbuffer abstraction, which works for single-sized elements, + partial elements, single/multi-elements read/writes. It is not wise to mix some + functions (partial element write / full element write), since it was not designed + with this use in mind. + + Also, it works only for single-reader + single-writer, since it does not depends + on external mutex functions. + */ + +#include + +#include +#include + +#include +#include + +#ifndef _RINGBUFFER_HPP_ +#define _RINGBUFFER_HPP_ + +struct Buffer_pointer +{ + Buffer_pointer(unsigned int _complete = 0u, unsigned short _partial = 0u) + : complete(_complete), partial(_partial) + {}; + + Buffer_pointer(const Buffer_pointer & o) + : complete(o.complete), partial(o.partial) + {}; + + Buffer_pointer(const volatile Buffer_pointer & o) + : complete(o.complete), partial(o.partial) + {}; + + void operator=(const volatile Buffer_pointer o) + { + complete = o.complete; + partial = o.partial; + } + + void operator=(const Buffer_pointer o) volatile + { + complete = o.complete; + partial = o.partial; + } + + bool operator==(const Buffer_pointer & o) + { + return (complete == o.complete && partial == o.partial); + } + + unsigned int complete:20; + unsigned short partial:12; +} +__attribute__((packed)); + +struct Buffer_table +{ + Buffer_table() + : reader(0,0), + writer(1,1) + {}; + + Buffer_table(const Buffer_table & o) + : reader(o.reader), writer(o.writer) + {}; + + Buffer_table(const volatile Buffer_table & o) + : reader(o.reader), writer(o.writer) + {}; + + void operator=(const volatile Buffer_table o) + { + reader = o.reader; + writer = o.writer; + } + + void operator=(const Buffer_table o) volatile + { + reader = o.reader; + writer = o.writer; + } + + bool operator==(const Buffer_table & o) + { + return (reader == o.reader && writer == o.writer); + } + + Buffer_pointer reader; + Buffer_pointer writer; +} +__attribute__((packed)); + +struct Ringbuffer_traits +{ + Ringbuffer_traits(unsigned int block, unsigned int size) + : _block(block), _size(size) + {}; + + bool traits_provide( char *, const char *, unsigned int, bool); + unsigned int traits_consume(const char *, char *, unsigned int, bool); + + unsigned int traits_consume_begins(const char *, char *, unsigned int, bool); + bool traits_consume_commit(unsigned int); + + bool traits_provide_partial( char *, const char *, unsigned int); + unsigned int traits_consume_partial(const char *, char *, unsigned int); + + unsigned int traits_get( char *, std::istream &, unsigned int); + unsigned int traits_put(const char *, std::ostream &, unsigned int); + + bool update(Buffer_pointer & cache, Buffer_pointer & update) + { + return Atomic::doCAS(&(_pointers.reader), &cache, update); + } + + protected: + const unsigned int _block; + const unsigned int _size; + + volatile Buffer_table _pointers; +}; + +template +struct Ringbuffer: protected Ringbuffer_traits, public NonCopyable +{ + struct BufferFull {}; + struct BufferEmpty {}; + + Ringbuffer(unsigned int size) + : Ringbuffer_traits(sizeof(T), size) + { + _buffer = new T[_size]; + _malloc = true; + }; + + Ringbuffer(unsigned int size, T * buffer) + : Ringbuffer_traits(sizeof(T), size) + { + _buffer = buffer; + _malloc = false; + }; + + ~Ringbuffer() + { + if (_malloc) + delete[] _buffer; + } + + /***** GENERIC RANGE/INDEX CALCULATION FUNCTIONS *****/ + bool may_write(Buffer_table & cache) + { + const unsigned int r = cache.reader.complete; + const unsigned int w = cache.writer.complete; + + return (((r - w) != 1) && (!(r == 0 && w == _size))); + } + + bool may_read(Buffer_table & cache) + { + if ((cache.writer.complete - cache.reader.complete) == 1) + return false; + + return true; + } + + unsigned int writer_next(Buffer_pointer & cache, Buffer_pointer & index) + { + unsigned int dest = cache.complete - 1, + temp = cache.complete + 1; + + if (temp > _size) index.complete = 1; + else index.complete = temp; + + index.partial = 1; + + return dest; + }; + + void reader_next(Buffer_pointer & cache, Buffer_pointer & index) + { + unsigned int temp = cache.complete + 1; + + if (temp == _size) index.complete = 0; + else index.complete = temp; + + index.partial = 0; + } + + /***** BUFFER FUNCTIONS *****/ + + bool provide(const T & value) + { + Buffer_table cache = _pointers; + Buffer_pointer index = _pointers.writer; + + if (!may_write(cache)) + return false; + +// fprintf(stderr, "%p> provide %d/%d!\n", this, reader, writer); + + unsigned int dest = writer_next(cache.writer, index); + + _buffer[dest] = value; + + _pointers.writer = index; + +// fprintf(stderr, "%p> write: %d/%d [%d/%d]\n", this, _pointers.reader, _pointers.writer, _pointers.reader_partial, _pointers.writer_partial); + + return true; + } + + bool consume(T & value) + { + Buffer_table cache = _pointers; + Buffer_pointer index = _pointers.reader; + + if (!may_read(cache)) + return false; + +// fprintf(stderr, "%p> consume %d/%d!\n", this, reader, writer); + + value = _buffer[index.complete]; + + do + { + reader_next(cache.reader, index); + + if (update(cache.reader, index)) + break; + + cache.reader = index; + } + while (true); + +// fprintf(stderr, "%p> read: %d/%d [%d/%d]\n", this, _pointers.reader, _pointers.writer, _pointers.reader_partial, _pointers.writer_partial); + + return true; + } + + /* writes everything or nothing */ + inline bool provide(const T * value, unsigned int amount, bool skip_overwrite = true) + { + return traits_provide((char *)_buffer, (const char *) value, amount, skip_overwrite); + } + + /* returns the number of items that have been read (atomic_mode == true means 'all or nothing') */ + inline unsigned int consume(T * value, unsigned int amount, bool atomic_mode = false) + { + return traits_consume((const char *)_buffer, (char *) value, amount, atomic_mode); + } + + /***** TWO-PHASE BUFFER FUNCTIONS *****/ + + /* returns the number of items that have been read (atomic_mode == true means 'all or nothing') */ + inline unsigned int consume_begins(T * value, unsigned int amount, bool atomic_mode = false) + { + return traits_consume_begins((const char *)_buffer, (char *) value, amount, atomic_mode); + } + + /* returns true if we could commit that much of buffer (use only after consume_begins). * + * note: you may commit less bytes that have been read to keep some data inside the buffer */ + inline bool consume_commit(unsigned int amount) + { + return traits_consume_commit(amount); + } + + /***** TWO-PHASE SINGLE-ELEMENT BUFFER FUNCTIONS *****/ + + T & provider_start(void) + { + Buffer_table cache = _pointers; + + if (!may_write(cache)) + throw BufferFull(); + + unsigned writer = _pointers.writer.complete - 1; + +// fprintf(stderr, "%p> provider start %d/%d!\n", this, reader, writer); + + return _buffer[writer]; + } + + void provider_commit(void) + { + unsigned int temp = _pointers.writer.complete + 1; + +// fprintf(stderr, "%p> provider commit %d!\n", this, temp); + + if (temp > _size) + temp = 1; + + _pointers.writer.complete = temp; + _pointers.writer.partial = 1; + +// fprintf(stderr, "%p> write: %d/%d [%d/%d]\n", this, _pointers.reader, _pointers.writer, _pointers.reader_partial, _pointers.writer_partial); + } + + T & consumer_start(void) + { + Buffer_table cache = _pointers; + + if (!may_read(cache)) + throw BufferEmpty(); + + unsigned int reader = _pointers.reader.complete; + +// fprintf(stderr, "%p> consumer start %d/%d!\n", this, reader, writer); + + return _buffer[reader]; + } + + void consumer_commit(void) + { + Buffer_pointer cache = _pointers.reader; + Buffer_pointer index(cache); + + do + { + reader_next(cache, index); + + if (update(cache, index)) + break; + + cache = index; + } + while (true); + +// fprintf(stderr, "%p> consumer commit %d!\n", this, temp); + +// fprintf(stderr, "%p> read: %d/%d [%d/%d]\n", this, _pointers.reader, _pointers.writer, _pointers.reader_partial, _pointers.writer_partial); + } + + /* writes everything or nothing, but works on bytes (may write incomplete elements) */ + /* WARNING: do not mix this with full element provider */ + inline bool provider_partial(const char *buffer, unsigned int amount) + { + return traits_provide_partial((char *)_buffer, buffer, amount); + } + + /* returns the number of bytes that have been read (may read incomplete elements) */ + /* WARNING: do not mix this with full element consumer */ + inline unsigned int consumer_partial(char *buffer, unsigned int amount) + { + return traits_consume_partial((const char *)_buffer, buffer, amount); + } + + /***** IO FUNCTIONS *****/ + + /* returns the number of items written to from buffer to stream */ + inline unsigned int put(std::ostream &fd, unsigned int amount) + { + return traits_put((char *)_buffer, fd, amount); + } + + /* returns number of items read from stream to buffer */ + inline unsigned int get(std::istream &fd, unsigned int amount) + { + return traits_get((const char *)_buffer, fd, amount); + } + + void clear() + { + _pointers.reader.complete = 0; + _pointers.reader.partial = 0; + _pointers.writer.complete = 1; + _pointers.writer.partial = 1; + } + + protected: + T * _buffer; + bool _malloc; +}; + +#endif /* _RINGBUFFER_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/saved_condition.cpp b/src/mod/endpoints/mod_khomp/commons/saved_condition.cpp new file mode 100644 index 0000000000..4c9f80f47f --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/saved_condition.cpp @@ -0,0 +1,46 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + + +#include + +#include COMMONS_INCLUDE(saved_condition.cpp) + diff --git a/src/mod/endpoints/mod_khomp/commons/saved_condition.hpp b/src/mod/endpoints/mod_khomp/commons/saved_condition.hpp new file mode 100644 index 0000000000..dcfd22423d --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/saved_condition.hpp @@ -0,0 +1,61 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#ifndef _SAVED_CONDITION_COMMON_HPP_ +#define _SAVED_CONDITION_COMMON_HPP_ + +#include + +//#include + +struct SavedConditionCommon +{ + SavedConditionCommon() : _signaled(false) {} + + protected: + bool _signaled; +}; + + +#include COMMONS_INCLUDE(saved_condition.hpp) + +#endif /* _SAVED_CONDITION_COMMON_HPP_ */ + diff --git a/src/mod/endpoints/mod_khomp/commons/scoped_lock.hpp b/src/mod/endpoints/mod_khomp/commons/scoped_lock.hpp new file mode 100644 index 0000000000..a85627f3cd --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/scoped_lock.hpp @@ -0,0 +1,95 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +struct ScopedLockBasic +{ + ScopedLockBasic(void) + : _locked(true) {}; + + ScopedLockBasic(bool locked) + : _locked(locked) {}; + + virtual ~ScopedLockBasic() {}; + + protected: + bool _locked; +}; + + +struct ScopedLock : public ScopedLockBasic +{ + struct LockFailed {}; + + ScopedLock(SimpleLock & mutex) + : ScopedLockBasic(false), _mutex(mutex) + { + switch (_mutex.lock()) + { + case SimpleLock::ISINUSE: + case SimpleLock::FAILURE: + throw LockFailed(); + default: + break; + } + + _locked = true; + } + + ~ScopedLock() + { + unlock(); + } + + void unlock() + { + if (_locked) + { + _locked = false; + _mutex.unlock(); + } + } + + protected: + SimpleLock & _mutex; +}; + diff --git a/src/mod/endpoints/mod_khomp/commons/simple_lock.hpp b/src/mod/endpoints/mod_khomp/commons/simple_lock.hpp new file mode 100644 index 0000000000..4f6619f456 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/simple_lock.hpp @@ -0,0 +1,104 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#ifndef _SIMPLE_LOCK_COMMON_HPP_ +#define _SIMPLE_LOCK_COMMON_HPP_ + +#include + +#include +#include + +#include + +/* This struct uses static polymorphism, and derived classes should implement * + * the "lock/trylock/unlock()" methods for correct code compilation. * + * The base class also features reference counting, so derived classes should * + * implement the "unreference()" method for releasing resources. */ + +template < typename Implementor > +struct SimpleLockCommon: NEW_REFCOUNTER( SimpleLockCommon < Implementor > ) +{ + friend class ReferenceCounter < SimpleLockCommon < Implementor > >; + + typedef enum + { + ISINUSE = 0, // operation not succeded (no error) + SUCCESS = 1, // operation succeded (no error) + FAILURE = 2, // mutex or state is somehow invalid (error! run for your life!) + } + Result; + + SimpleLockCommon() + {}; + + SimpleLockCommon(const SimpleLockCommon & o) + : INC_REFCOUNTER(o, SimpleLockCommon) + {}; + + virtual ~SimpleLockCommon() + {}; + + inline Result lock() + { + return static_cast(this)->lock(); + } + + inline Result trylock() + { + return static_cast(this)->trylock(); + } + + inline void unlock() + { + static_cast(this)->unlock(); + } + + protected: + void unreference(void) + { + static_cast(this)->unreference(); + } +}; + +#include COMMONS_INCLUDE(simple_lock.hpp) + +#endif /* _SIMPLE_LOCK_COMMON_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/strings.cpp b/src/mod/endpoints/mod_khomp/commons/strings.cpp new file mode 100644 index 0000000000..5e1cbc7004 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/strings.cpp @@ -0,0 +1,247 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +void Strings::Merger::add(std::string s) +{ + _list.push_back(s); +}; + +std::string Strings::Merger::merge(const std::string & sep) +{ + list_type::iterator i = _list.begin(); + + std::string res; + + if (i != _list.end()) + { + res += (*i); + ++i; + }; + + while (i != _list.end()) + { + res += sep; + res += (*i); + ++i; + } + + return res; +}; + +std::string Strings::Merger::merge(const char *sep) +{ + std::string ssep(sep); + return merge(ssep); +} + +unsigned int Strings::tokenize(const std::string & str, Strings::vector_type & tokens, + const std::string & delims, long int max_tokens, bool keep_empty) +{ + std::string::size_type base = 0; + + std::string::size_type init = str.find_first_not_of(delims, 0); + std::string::size_type fini = str.find_first_of(delims, init); + + long int cur_token = 1; + + while (std::string::npos != init) + { + if (keep_empty && base < init) + { + std::string::size_type cur_empty = init - base; + + while (cur_empty && cur_token < max_tokens) + { + tokens.push_back(""); + + ++cur_token; + --cur_empty; + } + } + + if (std::string::npos != fini && cur_token < max_tokens) + { + base = fini + 1; + + tokens.push_back(str.substr(init, fini - init)); + ++cur_token; + } + else + { + base = str.size(); // find_first_of(delims, init); + + tokens.push_back(str.substr(init, str.size() - init)); + break; + } + + init = str.find_first_not_of(delims, fini); + fini = str.find_first_of(delims, init); + } + + if (keep_empty && base != str.size()) + { + std::string::size_type cur_empty = str.size() - base + 1; + + while (cur_empty && cur_token < max_tokens) + { + tokens.push_back(""); + + ++cur_token; + --cur_empty; + } + + if (cur_empty) + { + std::string::size_type pos = base + cur_empty - 1; + tokens.push_back(str.substr(pos, str.size() - pos)); + ++cur_token; + } + } + + return (cur_token - 1); +} + +bool Strings::toboolean(std::string str) +{ + std::string tmp(str); + + Strings::lower(tmp); + + if ((tmp == "true") || (tmp == "yes")) return true; + if ((tmp == "false") || (tmp == "no")) return false; + + throw invalid_value(str); +} + +long Strings::tolong(std::string str, int base) +{ + char *str_end = 0; + + unsigned long value = strtol(str.c_str(), &str_end, base); + + if (str_end && *str_end == 0) + return value; + + throw invalid_value(str); +} + +unsigned long Strings::toulong(std::string str, int base) +{ + char *str_end = 0; + + unsigned long value = strtoul(str.c_str(), &str_end, base); + + if (str_end && *str_end == 0) + return value; + + throw invalid_value(str); +} + +unsigned long long Strings::toulonglong(std::string str, int base) +{ +#if defined(_WINDOWS) || defined(_Windows) || defined(_WIN32) || defined(WIN32) + throw not_implemented(); +#else + char *str_end = 0; + + unsigned long long value = strtoull(str.c_str(), &str_end, base); + + if (str_end && *str_end == 0) + return value; + + throw invalid_value(str); +#endif +} + +double Strings::todouble(std::string str) +{ + char *str_end = 0; + + double value = strtod(str.c_str(), &str_end); + + if (str_end && *str_end == 0) + return value; + + throw invalid_value(str); +} + +std::string Strings::fromboolean(bool value) +{ + if (value) return "true"; + else return "false"; +} + +std::string Strings::lower(std::string str) +{ + std::string res; + + for (std::string::iterator i = str.begin(); i != str.end(); i++) + res += tolower((*i)); + + return res; +} + +std::string Strings::hexadecimal(std::string value) +{ + std::string result; + + for (std::string::iterator i = value.begin(); i != value.end(); i++) + { + if (i != value.begin()) + result += " "; + + result += STG(FMT("%2x") % (unsigned int)(*i)); + } + + return result; +} + +std::string Strings::trim(const std::string& str, const std::string& trim_chars) +{ + std::string result(str); + + result.erase( result.find_last_not_of( trim_chars ) + 1 ); + result.erase( 0, result.find_first_not_of( trim_chars ) ); + + return result; +} diff --git a/src/mod/endpoints/mod_khomp/commons/strings.hpp b/src/mod/endpoints/mod_khomp/commons/strings.hpp new file mode 100644 index 0000000000..056b9335c6 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/strings.hpp @@ -0,0 +1,106 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +#include +#include +#include + +#include + +#include + +/* Generic string funcions */ + +#ifndef _STRINGS_HPP_ +#define _STRINGS_HPP_ + +struct Strings +{ + typedef std::list list_type; + typedef std::vector vector_type; + + struct Merger + { + void add(std::string); + + std::string merge(const std::string &); + std::string merge(const char *); + + bool empty() { return _list.empty(); }; + + protected: + list_type _list; + }; + + public: + struct invalid_value + { + invalid_value(const char * value): _value(value) {}; + invalid_value(std::string value): _value(value) {}; + + std::string & value() { return _value; } + + protected: + std::string _value; + }; + + struct not_implemented {}; + + static unsigned int tokenize(const std::string &, vector_type &, const std::string & delims = ",;:", + long int max_toxens = LONG_MAX, bool keep_empty = true); + + static bool toboolean(std::string); + static std::string fromboolean(bool); + + static long tolong(std::string, int base = 10); + static unsigned long toulong(std::string, int base = 10); + static unsigned long long toulonglong(std::string, int base = 10); + static double todouble(std::string); + + static std::string lower(std::string); + static std::string hexadecimal(std::string); + + static std::string trim(const std::string&, const std::string& trim_chars = " \f\n\r\t\v"); +}; + +#endif // _STRINGS_HPP_ // diff --git a/src/mod/endpoints/mod_khomp/commons/tagged_union.hpp b/src/mod/endpoints/mod_khomp/commons/tagged_union.hpp new file mode 100644 index 0000000000..1616268c5f --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/tagged_union.hpp @@ -0,0 +1,307 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#ifndef _TAGGED_UNION_HPP_ +#define _TAGGED_UNION_HPP_ + +#include + +#include +#include + +namespace Tagged +{ + struct EmptyUnion + { + friend class Value; + + EmptyUnion() + : _adjusted(false) {}; + + // copy constructor + EmptyUnion(const EmptyUnion & o) + : _adjusted(o._adjusted) {}; + + // copy assignment operator + EmptyUnion & operator=(const EmptyUnion & o) + { + _adjusted = o._adjusted; + return *this; + }; + + ~EmptyUnion() { _adjusted = false; }; + + bool operator==(const EmptyUnion & o) + { + return true; + }; + + public: + void clear(void) { _adjusted = false; }; + protected: + void setup(void) { _adjusted = true; }; + + protected: + bool value_set(void) { return false; }; + bool value_get(void) { return false; }; + + bool value_check(void) { return false; }; + + template < typename S > + bool value_visit(S & visitor, typename S::ReturnType & ret) + { + return false; + }; + + template < typename S > + bool value_visit_void(S & visitor) + { + return false; + }; + + bool adjusted() { return _adjusted; }; + + private: + bool _adjusted; + }; + + template < typename V, typename E = EmptyUnion > + struct Union: public E + { + friend class Value; + + // default constructor + Union() + : _value(0) {}; + + // constructor with initializer + template < typename U > + Union( U value ) + : _value(0) + { + set(value); + }; + + // copy constructor + Union(const Union & o) + : E(static_cast(o)), + _value( (o._value ? new const V(*(o._value)) : 0) ) + {}; + + // copy assignment operator + Union & operator=(const Union & o) + { + if (_value) + { + delete _value; + _value = 0; + } + + if (o._value) + { + _value = new const V(*(o._value)); + } + + E::operator=(static_cast(o)); + + return *this; + }; + + // destructor + ~Union() + { + if (_value) + { + delete _value; + _value = 0; + } + }; + + // equal sign operator + template < typename U > + void operator=(U value) + { + set(value); + } + + template < typename U > + bool check(void) + { + return value_check(static_cast(0)); + }; + + template < typename U > + const U & get(void) + { + const U * res = 0; + + if (!value_get(&res) || !res) + throw std::runtime_error("type mismatch"); + + return *res; + }; + + template < typename U > + void set(U val) + { + if (E::adjusted()) + clear(); + + if (!value_set(val)) + throw std::runtime_error("unable to set value of invalid type"); + }; + + template < typename S > + typename S::ReturnType visit(S visitor) + { + typename S::ReturnType ret; + + if (!value_visit(visitor, ret)) + throw std::runtime_error("unable to visit empty value"); + + return ret; + }; + + template < typename S > + void visit_void(S visitor) + { + if (!value_visit_void(visitor)) + throw std::runtime_error("unable to visit empty value"); + }; + + void clear() + { + if (_value) + { + delete _value; + _value = 0; + } + + E::clear(); + }; + + // compare (equal) operator + bool operator==(const Union & o) + { + bool are_equal = false; + + if (!_value && !(o._value)) + are_equal = true; + + if (_value && o._value) + are_equal = (*_value == *(o._value)); + + if (are_equal) + return E::operator==(static_cast(o)); + + return false; + }; + + // compare types + bool sameType(const Union & o) + { + if ((!(_value) && !(o._value)) || (_value && o._value)) + return E::operator==(static_cast(o)); + + return false; + }; + + protected: + using E::value_set; + using E::value_get; + + using E::value_check; + using E::value_visit; + using E::value_visit_void; + + bool value_set(V val) + { + _value = new const V(val); + E::setup(); + + return true; + }; + + bool value_get(const V ** val) + { + if (!_value) + return false; + + *val = _value; + return true; + } + + bool value_check(const V * const junk) + { + (void)junk; + return (_value != 0); + }; + + template < typename S > + bool value_visit(S & visitor, typename S::ReturnType & ret) + { + if (_value) + { + ret = visitor(*const_cast(_value)); + return true; + }; + + return E::value_visit(visitor, ret); + }; + + template < typename S > + bool value_visit_void(S & visitor) + { + if (_value) + { + visitor(*const_cast(_value)); + return true; + }; + + return E::value_visit_void(visitor); + }; + + private: + const V * _value; + }; +}; + +#endif /* _TAGGED_UNION_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/thread.hpp b/src/mod/endpoints/mod_khomp/commons/thread.hpp new file mode 100644 index 0000000000..e00d7c875a --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/thread.hpp @@ -0,0 +1,103 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#ifndef _THREAD_COMMON_HPP_ +#define _THREAD_COMMON_HPP_ + +#include + +#include +//#include + +struct ThreadCommon +{ + protected: + template + struct DecomposeFuncPtr; + + template + struct DecomposeFuncPtr + { + typedef ReturnType Return; + }; + + template + struct DecomposeFuncPtr + { + typedef void Return; + }; + + template + struct DecomposeFuncPtr + { + typedef ReturnType Return; + }; + + template< typename FunctionType > + struct DecomposeFunction + { + typedef typename Select < IsClass< FunctionType >::Result, int, + typename DecomposeFuncPtr< FunctionType >::Return >::Result + Return; + }; + + public: + struct ThreadDataCommon + { + ThreadDataCommon() {} + + virtual ~ThreadDataCommon() {} + + virtual int run() = 0; + + ThreadCommon * _thread; + + void * _self; + void * _attribute; + }; + + ThreadCommon() {} +}; + + +#include COMMONS_INCLUDE(thread.hpp) + +#endif /* _THREAD_COMMON_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/timer.cpp b/src/mod/endpoints/mod_khomp/commons/timer.cpp new file mode 100644 index 0000000000..36e32f521a --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/timer.cpp @@ -0,0 +1,352 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +TimerTraits::TimerTraits() +: _thread((Thread*)0), _purify(false), _last_tick(0), _age_count(0), _shutdown(false) +{}; + +bool TimerTraits::start (void) +{ + _shutdown = false; + + _condition.reset(); + _finalized.reset(); + + if (!_thread) + { + _thread = new Thread(TimerTraits::loop_thread(this)); + _purify = true; + } + +#if defined(_WINDOWS) || defined(_Windows) || defined(_WIN32) || defined(WIN32) + // set priority ... +#else + pthread_attr_t attrs; + sched_param param; + + if (pthread_attr_init(&attrs) < 0) + return false; + + if (pthread_attr_setschedpolicy(&attrs, SCHED_RR) < 0) + return false; + + if (pthread_attr_getschedparam(&attrs, ¶m) < 0) + return false; + + param.sched_priority = sched_get_priority_max(SCHED_RR); + + if (pthread_attr_setschedparam(&attrs, ¶m) < 0) + return false; + + // set priority... + +// if (pthread_create(&_thread, &attrs, TimerTraits::loop_thread, NULL) < 0) +// return false; + + _thread->start(); +#endif + + return true; +} + +bool TimerTraits::stop (void) +{ + _shutdown = true; + + _condition.signal(); + + _finalized.wait(10000); /* 10 seconds max wait */ + + if (_thread && _purify) + { + delete _thread; + + _thread = (Thread *)0; + _purify = false; + } + + return true; +} + +//----------------------------------------- + +int TimerTraits::loop_thread::operator()(void) +{ + try + { + _timer->loop(); + } + catch( ... ) + { + /* something wrong happened! */ + } + + _timer->_finalized.signal(); + + return 0; +} + +void TimerTraits::execute(ControlSet::iterator init, const TimerTraits::Control & ctrl) +{ + volatile CallbackFuncType func = (volatile CallbackFuncType) ctrl._func; + volatile CallbackDataType data = (volatile CallbackDataType) ctrl._data; + + _timer_set.erase(init); + + _mutex.unlock(); + + func(data); +} + +void TimerTraits::loop (void) +{ + while (true) + { + if (_shutdown) break; + + _mutex.lock(); + + ControlSet::iterator init = _timer_set.begin(); + + if (init == _timer_set.end()) + { + _mutex.unlock(); + _condition.wait(); + } + else + { + const Control & ctrl = *init; + + unsigned int ts_now = TimerTraits::tick(); + + if (_age_count == ctrl._age) + { + if (ts_now < ctrl._msecs) + { + /* age is right, but it is not time to expire yet... */ + volatile unsigned int wait_time = ctrl._msecs - ts_now; + _mutex.unlock(); + _condition.wait(wait_time); /* expire - now */ + } + else + { + /* age is right, and we should expire! */ + execute(init, ctrl); /* called locked, return unlocked */ + } + } + else if (_age_count < ctrl._age) + { + /* age is not there yet (need some time to overlap)... */ + volatile unsigned int wait_time = (UINT_MAX - ts_now) + ctrl._msecs; + _mutex.unlock(); + _condition.wait(wait_time); /* MAX - now + expire */ + } + else + { + /* age has passed, we should have expired before! */ + execute(init, ctrl); /* called locked, return unlocked */ + } + } + } + + _finalized.signal(); +} + +unsigned int TimerTraits::tick() +{ +#if defined(_WINDOWS) || defined(_Windows) || defined(_WIN32) || defined(WIN32) + unsigned int tick = GetTickCount(); +#else + struct timespec ticks; + + // error condition, make the user notice this.. + if (clock_gettime(CLOCK_MONOTONIC, &ticks) < 0) + return 0; + + unsigned int tick = ( ticks.tv_sec * 1000 ) + ( ticks.tv_nsec / 1000000 ); +#endif + + if (_last_tick > tick) + ++_age_count; + + _last_tick = tick; + + return tick; +} + +//----------------------------------------- + +TimerTraits::Index TimerTraits::traits_add_unlocked (unsigned int msecs, const void * func, const void * data, unsigned int value) +{ + unsigned int ms_tick = TimerTraits::tick(); + + unsigned int ms_left = UINT_MAX - ms_tick; + unsigned int ms_real = msecs; + + unsigned int age_num = _age_count; + + if (ms_left < msecs) + { + ms_real -= ms_left; + ++age_num; + } + else + { + ms_real += ms_tick; + } + + ControlSet::iterator it = _timer_set.insert(Control(age_num,ms_real,func,data,value)); + + if (_timer_set.size() == 1 || _timer_set.begin() == it) + { + _condition.signal(); + }; + + return Index(age_num, ms_real, msecs, func, data, value); +} + +TimerTraits::Index TimerTraits::traits_add (unsigned int msecs, const void * func, const void * data, unsigned int value) +{ + _mutex.lock(); + + Index idx = traits_add_unlocked(msecs, func, data, value); + + _mutex.unlock(); + + return idx; +} + +bool TimerTraits::traits_restart (TimerTraits::Index & idx, bool force) +{ + bool ret = false; + + _mutex.lock(); + + if (idx.valid) + { + if (traits_del_unlocked(idx) || force) + { + idx = traits_add_unlocked(idx.delta, idx.func, idx.data, idx.value); + ret = true; + } + } + + _mutex.unlock(); + + return ret; +} + +bool TimerTraits::traits_del_unlocked (TimerTraits::Index & idx) +{ + bool ret = false; + + if (idx.valid) + { + ControlSet::iterator i = _timer_set.lower_bound(Control(idx.era, idx.msec)); + ControlSet::iterator j = _timer_set.upper_bound(Control(idx.era, idx.msec)); + + for (; i != j; i++) + { + const Control & ctrl = (*i); + + if ((idx.value && !(ctrl._value & idx.value))) + continue; + + if (((idx.func && ctrl._func == idx.func) || !idx.func) && ((idx.data && ctrl._data == idx.data) || !idx.data)) + { + if (_timer_set.begin() == i) + _condition.signal(); + + _timer_set.erase(i); + + ret = true; + break; + } + } + + idx.valid = false; + } + + return ret; +} + +bool TimerTraits::traits_del (TimerTraits::Index & idx) +{ + _mutex.lock(); + + bool ret = traits_del_unlocked(idx); + + _mutex.unlock(); + + return ret; +} + +bool TimerTraits::traits_del (const void * func, const void * data, unsigned int value) +{ + bool ret = false; + + _mutex.lock(); + + for (ControlSet::iterator i = _timer_set.begin(); i != _timer_set.end(); i++) + { + const Control & ctrl = (*i); + + if ((value && !(ctrl._value & value))) + continue; + + if (((func && ctrl._func == func) || !func) && ((data && ctrl._data == data) || !data)) + { + if (_timer_set.begin() == i) + _condition.signal(); + + _timer_set.erase(i); + + ret = true; + break; + } + } + + _mutex.unlock(); + + return ret; +} diff --git a/src/mod/endpoints/mod_khomp/commons/timer.hpp b/src/mod/endpoints/mod_khomp/commons/timer.hpp new file mode 100644 index 0000000000..382efa1645 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/timer.hpp @@ -0,0 +1,224 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#if defined(_WINDOWS) || defined(_Windows) || defined(_WIN32) || defined(WIN32) +#include +#else +#include +#endif + +#include + +#include +#include +#include +#include + +#ifndef _TIMER_HPP_ +#define _TIMER_HPP_ + +struct TimerTraits +{ + typedef bool (* CallbackFuncType)(const void * volatile); + typedef const void * CallbackDataType; + + TimerTraits(); + + virtual ~TimerTraits() {}; + + protected: + + /* pre-declaration, used below */ + struct ControlCompare; + + struct Control + { + Control(unsigned int age, unsigned int msecs, const void * func = 0, const void * data = 0, unsigned int value = 0) + : _age(age), _msecs(msecs), _func(func), _data(data), _value(value) {} + + unsigned int _age; + + unsigned int _msecs; + + const void * _func; + const void * _data; + + unsigned int _value; + }; + + struct ControlCompare + { + bool operator()(const Control & c1, const Control & c2) const + { + return (c1._age < c2._age ? true : c1._msecs < c2._msecs); + } + }; + + typedef std::multiset < Control, ControlCompare > ControlSet; + + public: + struct Index + { + Index(): era(0), msec(0), valid(false) {}; + + Index(unsigned int _era, unsigned int _msec, unsigned int _delta, const void * _func, const void * _data, unsigned int _value) + : era(_era), msec(_msec), delta(_delta), func(_func), data(_data), value(_value), valid(true) {}; + + unsigned int era; + unsigned int msec; + + unsigned int delta; + + const void * func; + const void * data; + + unsigned int value; + + bool valid; + + void reset(void) { era = 0; msec = 0; valid = false; }; + }; + + /* timer add/remove functions */ + Index traits_add (unsigned int msecs, const void * func, const void * data = 0, unsigned int value = 0); + + bool traits_restart (Index & idx, bool force); + + bool traits_del (Index & idx); + bool traits_del (const void * func, const void * data = 0, unsigned int value = 0); + + /* timer start/stop functions */ + bool start(void); + bool stop(void); + + protected: + Index traits_add_unlocked (unsigned int msecs, const void * func, const void * data, unsigned int value); + + bool traits_del_unlocked (Index & idx); + + protected: + void execute(ControlSet::iterator, const Control &); + + void loop(void); + + struct loop_thread + { + loop_thread(TimerTraits *timer) : _timer(timer) {}; + + int operator()(void); + + protected: + TimerTraits * _timer; + }; + + unsigned int tick(); + + /* variables */ + + SavedCondition _condition; + + SimpleLock _mutex; + Thread * _thread; + bool _purify; + + ControlSet _timer_set; + + unsigned int _last_tick; + unsigned int _age_count; + + SavedCondition _finalized; + bool _shutdown; +}; + +template < typename F, typename D > +struct TimerTemplate: NEW_REFCOUNTER(TimerTemplate< F, D >) +{ + typedef TimerTraits::Index Index; + typedef TimerTraits::Control Control; + + TimerTemplate() + : _timer(new TimerTraits()) + {}; + + TimerTemplate(const TimerTemplate< F, D > & o) + : INC_REFCOUNTER(o, TimerTemplate< F, D >), + _timer(o._timer) + {}; + + void unreference(void) + { + if (_timer) + delete _timer; + }; + + bool start() { return _timer->start(); } + bool stop() { return _timer->stop(); } + + inline Index add(unsigned int msecs, F * func, D data = 0, unsigned int value = 0) + { + return _timer->traits_add(msecs, (const void *)func, (void *)(data), value); + } + + inline bool restart(Index & idx, bool force = false) + { + return _timer->traits_restart(idx, force); + } + + inline bool del(Index & idx) + { + return _timer->traits_del(idx); + } + + inline bool del(F * func, D data, unsigned int value = 0) + { + return _timer->traits_del((const void *)func, (void *)(data), value); + } + + inline bool del(unsigned int value) + { + return _timer->traits_del((const void *)0, (void *)0, value); + } + + protected: + TimerTraits * _timer; +}; + +#endif /* _TIMER_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/types.hpp b/src/mod/endpoints/mod_khomp/commons/types.hpp new file mode 100644 index 0000000000..adbd8abe36 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/types.hpp @@ -0,0 +1,81 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#ifndef _TYPES_HPP_ +#define _TYPES_HPP_ + +/*** Used for conditional compilation based on K3L version ***/ + +#define K3L_AT_LEAST(major,minor,build) \ + (((k3lApiMajorVersion == major) && ((k3lApiMinorVersion == minor) && (k3lApiBuildVersion >= build)) || \ + ((k3lApiMajorVersion == major) && (k3lApiMinorVersion > minor))) || \ + (k3lApiMajorVersion > major)) + +#define K3L_EXACT(major,minor,build) \ + ((k3lApiMajorVersion == major) && (k3lApiMinorVersion == minor) && (k3lApiBuildVersion >= build)) + +/*** Used for checking information on classes and stuff.. ***/ + +template< typename T > +class IsClass +{ + protected: + template< typename X > static char ( &A( void(X::*)() ) )[1]; + template< typename X > static char ( &A( X ) )[2]; + public: + static bool const Result = sizeof( A< T >(0) ) == 1; +}; + +/*** Used for template metaprogramming ***/ + +template < bool Value, typename Then, typename Else > +struct Select +{ + typedef Then Result; +}; + +template < typename Then, typename Else > +struct Select < false, Then, Else > +{ + typedef Else Result; +}; + +#endif /* _TYPES_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/commons/variant.hpp b/src/mod/endpoints/mod_khomp/commons/variant.hpp new file mode 100644 index 0000000000..410a770a6e --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/variant.hpp @@ -0,0 +1,127 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include + +#include + +#ifndef _VARIANT_H_ +#define _VARIANT_H_ + +/* this is internal, should not be used by the user */ +struct NoArgumentDefined {}; + +template < typename UserReturnType, typename UserArgumentType = NoArgumentDefined > +struct VariantBaseType +{ + typedef UserReturnType ReturnType; + typedef UserArgumentType ArgumentType; + + virtual ~VariantBaseType() {}; + + virtual int which() = 0; + + virtual ReturnType visit(void) { return ReturnType(); }; + virtual ReturnType visit(ArgumentType) { return ReturnType(); }; +}; + +template < typename BaseType = VariantBaseType < void > > +struct Variant: NEW_REFCOUNTER(Variant < BaseType >) +{ + typedef typename BaseType::ReturnType ReturnType; + typedef typename BaseType::ArgumentType ArgumentType; + + struct InvalidType {}; + + Variant(BaseType * value, bool is_owner = false) + : _value(value), _is_owner(is_owner) {}; + + Variant(const Variant & v) + : INC_REFCOUNTER(v, Variant < BaseType >), + _value(v._value), _is_owner(v._is_owner) {}; + + virtual ~Variant() {}; + + void unreference() + { + if (_is_owner && _value) + { + delete _value; + _value = 0; + } + }; + + template < typename ValueType > + ValueType & get(void) + { + try + { + ValueType & ret = dynamic_cast < ValueType & > (*_value); + return ret; + } + catch (std::bad_cast & e) + { + throw InvalidType(); + } + }; + + int which() + { + return _value->which(); + } + + ReturnType visit(void) + { + return _value->visit(); + } + + ReturnType visit(ArgumentType arg) + { + return _value->visit(arg); + } + + protected: + BaseType * _value; + bool _is_owner; +}; + +#endif /* _VARIANT_H_ */ + diff --git a/src/mod/endpoints/mod_khomp/commons/verbose.cpp b/src/mod/endpoints/mod_khomp/commons/verbose.cpp new file mode 100644 index 0000000000..182d159ca1 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/verbose.cpp @@ -0,0 +1,3188 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include +#include + +#define PRESENTATION_CHECK_RETURN(fmt, txtexact, txthuman) \ + { \ + switch(fmt) \ + { \ + case EXACT: return txtexact; \ + case HUMAN: return txthuman; \ + } \ + return txtexact; \ + } + +/********************************************/ + +std::string Verbose::channelStatus(int32 dev, int32 obj, int32 cs, Verbose::Presentation fmt) +{ + try + { + K3L_CHANNEL_CONFIG & config = _api.channel_config(dev, obj); + return Verbose::channelStatus(config.Signaling, cs, fmt); + } + catch (...) + { + return presentation(fmt, "", "Unknown"); + } +} + +#if K3L_AT_LEAST(2,0,0) +std::string Verbose::event(int32 obj, K3L_EVENT *ev, R2CountryType r2_country, Verbose::Presentation fmt) +#else +std::string Verbose::event(int32 obj, K3L_EVENT *ev, Verbose::Presentation fmt) +#endif +{ + try + { + K3L_CHANNEL_CONFIG & config = _api.channel_config(ev->DeviceId, obj); +#if K3L_AT_LEAST(2,0,0) + return Verbose::event(config.Signaling, obj, ev, r2_country, fmt); +#else + return Verbose::event(config.Signaling, obj, ev, fmt); +#endif + } + catch (...) + { +#if K3L_AT_LEAST(2,0,0) + return Verbose::event(ksigInactive, obj, ev, r2_country, fmt); +#else + return Verbose::event(ksigInactive, obj, ev, fmt); +#endif + } +} + +/********************************************/ + +std::string Verbose::echoLocation(KEchoLocation ec, Verbose::Presentation fmt) +{ + switch (ec) + { +#if K3L_AT_LEAST(1,5,4) + case kelNetwork: return presentation(fmt, "kelNetwork", "Network"); +#else + case kelE1: return presentation(fmt, "kelE1", "Network"); +#endif + case kelCtBus: return presentation(fmt, "kelCtBus", "CT-Bus"); + }; + + return presentation(fmt, "", "Unknown"); +}; + +std::string Verbose::echoCancellerConfig(KEchoCancellerConfig ec, Verbose::Presentation fmt) +{ + switch (ec) + { + case keccNotPresent: return presentation(fmt, "keccNotPresent", "Not Present"); + case keccOneSingleBank: return presentation(fmt, "keccOneSingleBank", "One, Single Bank"); + case keccOneDoubleBank: return presentation(fmt, "keccOneDoubleBank", "One, Double Bank"); + case keccTwoSingleBank: return presentation(fmt, "keccTwoSingleBank", "Two, Single Bank"); + case keccTwoDoubleBank: return presentation(fmt, "keccTwoDoubleBank", "Two, Double Bank"); + case keccFail: return presentation(fmt, "keccFail", "Failure"); + }; + + return presentation(fmt, "", "Unknown"); +}; + +// TODO: internal_deviceType / internal_deviceModel + +std::string Verbose::deviceName(KDeviceType dt, int32 model, Verbose::Presentation fmt) +{ + try + { + std::string value; + + value += internal_deviceType(dt); + value += "-"; + value += internal_deviceModel(dt, model); + + return value; + } + catch (internal_not_found & e) + { + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[type/model='%d/%d']") % (int)dt % (int)model), + STG(FMT("Unknown device type/model (%d/%d)") % (int)dt % (int)model)); + } +} + +std::string Verbose::deviceType(KDeviceType dt, Verbose::Presentation fmt) +{ + try + { + return internal_deviceType(dt); + } + catch (internal_not_found & e) + { + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[type='%d']") % (int)dt), + STG(FMT("Unknown device type (%d)") % (int)dt)); + } +} + +std::string Verbose::internal_deviceType(KDeviceType dt) +{ + switch (dt) + { + case kdtE1: return "K2E1"; + +#if K3L_AT_LEAST(1,6,0) + case kdtFXO: return "KFXO"; +#else + case kdtFX: return "KFXO"; +#endif + + case kdtConf: return "KCONF"; + case kdtPR: return "KPR"; + case kdtE1GW: return "KE1GW"; + +#if K3L_AT_LEAST(1,6,0) + case kdtFXOVoIP: return "KFXVoIP"; +#else + case kdtFXVoIP: return "KFXVoIP"; +#endif + +#if K3L_AT_LEAST(1,5,0) + case kdtE1IP: return "K2E1"; +#endif +#if K3L_AT_LEAST(1,5,1) + case kdtE1Spx: return "K2E1"; + case kdtGWIP: return "KGWIP"; +#endif + +#if K3L_AT_LEAST(1,6,0) + case kdtFXS: return "KFXS"; + case kdtFXSSpx: return "KFXS"; + case kdtGSM: return "KGSM"; + case kdtGSMSpx: return "KGSM"; +#endif + +#if K3L_AT_LEAST(2,1,0) + case kdtGSMUSB: return "KGSMUSB"; + case kdtGSMUSBSpx: return "KGSMUSB"; + + case kdtE1FXSSpx: return "KE1FXS"; + case kdtDevTypeCount: return "DevTypeCount"; +#endif + +#if K3L_EXACT(2,1,0) + case kdtReserved1: return "Reserved1"; +#endif + +#if K3L_AT_LEAST(2,2,0) + case kdtE1AdHoc: return "KE1AdHoc"; +#endif + } + + throw internal_not_found(); +} + +std::string Verbose::deviceModel(KDeviceType dt, int32 model, Verbose::Presentation fmt) +{ + try + { + return internal_deviceModel(dt, model); + } + catch (internal_not_found & e) + { + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[model='%d']") % (int)model), + STG(FMT("Unknown device model (%d)") % (int)model)); + } +} + +std::string Verbose::internal_deviceModel(KDeviceType dt, int32 model) +{ + switch (dt) + { + case kdtE1: + switch ((KE1DeviceModel)model) + { + case kdmE1600: return "600"; + case kdmE1600E: return "600E"; +#if K3L_AT_LEAST(2,0,0) + case kdmE1600EX: return "600EX"; +#endif + } + throw internal_not_found(); + +#if K3L_AT_LEAST(1,6,0) + case kdtFXO: + switch ((KFXODeviceModel)model) +#else + case kdtFX: + switch ((KFXDeviceModel)model) +#endif + { +#if K3L_AT_LEAST(1,6,0) + case kdmFXO80: return "80"; + case kdmFXOHI: return "HI"; + case kdmFXO160HI: return "160HI"; +#if K3L_AT_LEAST(2,1,0) + case kdmFXO240HI: return "240HI"; +#endif +#else + case kdmFXO80: return "80"; +#endif + } + + throw internal_not_found(); + + case kdtConf: + switch ((KConfDeviceModel)model) + { + case kdmConf240: return "240"; + case kdmConf120: return "120"; +#if K3L_AT_LEAST(2,0,0) + case kdmConf240EX: return "240EX"; + case kdmConf120EX: return "120EX"; +#endif + } + + throw internal_not_found(); + + case kdtPR: + switch ((KPRDeviceModel)model) + { +#if K3L_AT_LEAST(1,6,0) + case kdmPR300v1: return "300v1"; + case kdmPR300SpxBased: return "300S"; +#if K3L_AT_LEAST(2,0,0) + case kdmPR300EX: return "300EX"; +#endif + case kdmPR300: return "300"; + } +#endif + throw internal_not_found(); + +#if K3L_AT_LEAST(1,4,0) + case kdtE1GW: + switch ((KE1GWDeviceModel)model) + { +#if K3L_AT_LEAST(1,6,0) + case kdmE1GW640: return "640"; +#if K3L_AT_LEAST(2,0,0) + case kdmE1GW640EX: return "640EX"; +#endif +#else + case kdmE1600V: return "600V"; + case kdmE1600EV: return "600EV"; +#endif + } + + throw internal_not_found(); +#endif + +#if K3L_AT_LEAST(1,6,0) + case kdtFXOVoIP: + switch ((KFXOVoIPDeviceModel)model) + { + case kdmFXGW180: return "180"; + } + + throw internal_not_found(); + +#elif K3L_AT_LEAST(1,4,0) + case kdtFXVoIP: + switch ((KFXVoIPDeviceModel)model) + { + case kdmFXO80V: return "80V"; + } + + throw internal_not_found(); +#endif + +#if K3L_AT_LEAST(1,5,0) + case kdtE1IP: + switch ((KE1IPDeviceModel)model) + { +#if K3L_AT_LEAST(1,6,0) + case kdmE1IP: return "E1IP"; +#if K3L_AT_LEAST(2,0,0) + case kdmE1IPEX: return "E1IPEX"; +#endif +#else + case kdmE1600EG: return "600EG"; +#endif + } + + throw internal_not_found(); +#endif + +#if K3L_AT_LEAST(1,5,1) + case kdtE1Spx: + switch ((KE1SpxDeviceModel)model) + { + case kdmE1Spx: return "SPX"; + case kdm2E1Based: return "SPX-2E1"; +#if K3L_AT_LEAST(2,0,0) + case kdmE1SpxEX: return "SPXEX"; +#endif + } + throw internal_not_found(); + + case kdtGWIP: + switch ((KGWIPDeviceModel)model) + { +#if K3L_AT_LEAST(1,6,0) + case kdmGWIP: return "GWIP"; +#if K3L_AT_LEAST(2,0,0) + case kdmGWIPEX: return "GWIPEX"; +#endif +#else + case kdmGW600G: return "600G"; + case kdmGW600EG: return "600EG"; +#endif + } + + throw internal_not_found(); +#endif + +#if K3L_AT_LEAST(1,6,0) + case kdtFXS: + switch ((KFXSDeviceModel)model) + { + case kdmFXS300: return "300"; +#if K3L_AT_LEAST(2,0,0) + case kdmFXS300EX: return "300EX"; +#endif + } + + throw internal_not_found(); + + case kdtFXSSpx: + switch ((KFXSSpxDeviceModel)model) + { + case kdmFXSSpx300: return "SPX"; + case kdmFXSSpx2E1Based: return "SPX-2E1"; +#if K3L_AT_LEAST(2,0,0) + case kdmFXSSpx300EX: return "SPXEX"; +#endif + } + + throw internal_not_found(); + + case kdtGSM: + switch ((KGSMDeviceModel)model) + { + case kdmGSM: return "40"; +#if K3L_AT_LEAST(2,0,0) + case kdmGSMEX: return "40EX"; +#endif + } + + throw internal_not_found(); + + case kdtGSMSpx: + switch ((KGSMSpxDeviceModel)model) + { + case kdmGSMSpx: return "SPX"; +#if K3L_AT_LEAST(2,0,0) + case kdmGSMSpxEX: return "SPXEX"; +#endif + } + + throw internal_not_found(); + +#if K3L_AT_LEAST(2,1,0) + case kdtGSMUSB: + switch ((KGSMUSBDeviceModel)model) + { + case kdmGSMUSB: return "20"; + } + + throw internal_not_found(); + + case kdtGSMUSBSpx: + switch ((KGSMUSBSpxDeviceModel)model) + { + case kdmGSMUSBSpx: return "SPX"; + } + + throw internal_not_found(); + + case kdtE1FXSSpx: + switch ((KGSMSpxDeviceModel)model) + { + case kdmE1FXSSpx: return "SPX"; + case kdmE1FXSSpxEX: return "SPXEX"; + } + + throw internal_not_found(); +#if K3L_AT_LEAST(2,2,0) + case kdtE1AdHoc: + switch((KE1AdHocModel)model) + { + case kdmE1AdHoc100: return "E1AdHoc100"; + case kdmE1AdHoc100E: return "E1AdHoc100E"; + case kdmE1AdHoc240: return "E1AdHoc240"; + case kdmE1AdHoc240E: return "E1AdHoc240E"; + case kdmE1AdHoc400: return "E1AdHoc240"; + case kdmE1AdHoc400E: return "E1AdHoc240E"; + } + throw internal_not_found(); +#endif + +#if K3L_EXACT(2,1,0) + case kdtReserved1: +#endif + case kdtDevTypeCount: + throw internal_not_found(); + +#endif +#endif + } + + throw internal_not_found(); +} + +std::string Verbose::signaling(KSignaling sig, Verbose::Presentation fmt) +{ + switch (sig) + { + case ksigInactive: return presentation(fmt, "ksigInactive", "Inactive"); + case ksigAnalog: return presentation(fmt, "ksigAnalog", "FXO (analog)"); + case ksigContinuousEM: return presentation(fmt, "ksigContinuousEM", "E+M Continuous"); + case ksigPulsedEM: return presentation(fmt, "ksigPulsedEM", "E+M PUlsed"); + case ksigOpenCAS: return presentation(fmt, "ksigOpenCAS", "Open CAS"); + case ksigOpenR2: return presentation(fmt, "ksigOpenR2", "Open R2"); + case ksigR2Digital: return presentation(fmt, "ksigR2Digital", "R2/MFC"); + case ksigUserR2Digital: return presentation(fmt, "ksigUserR2Digital", "R2/Other"); +#if K3L_AT_LEAST(1,4,0) + case ksigSIP: return presentation(fmt, "ksigSIP", "SIP"); +#endif + +#if K3L_AT_LEAST(1,5,1) + case ksigOpenCCS: return presentation(fmt, "ksigOpenCCS", "Open CCS"); + case ksigPRI_EndPoint: return presentation(fmt, "ksigPRI_EndPoint", "ISDN Endpoint"); + case ksigPRI_Network: return presentation(fmt, "ksigPRI_Network", "ISDN Network"); + case ksigPRI_Passive: return presentation(fmt, "ksigPRI_Passive", "ISDN Passive"); +#endif +#if K3L_AT_LEAST(1,5,3) + case ksigLineSide: return presentation(fmt, "ksigLineSide", "Line Side"); +#endif +#if K3L_AT_LEAST(1,6,0) + case ksigAnalogTerminal: return presentation(fmt, "ksigAnalogTerminal", "FXS (analog)"); + case ksigGSM: return presentation(fmt, "ksigGSM", "GSM"); + case ksigCAS_EL7: return presentation(fmt, "ksigCAS_EL7", "CAS EL7"); + case ksigE1LC: return presentation(fmt, "ksigE1LC", "E1 LC"); +#endif +#if K3L_AT_LEAST(2,1,0) + case ksigISUP: return presentation(fmt, "ksigISUP", "ISUP"); +#endif +#if K3L_EXACT(2,1,0) + case ksigFax: return presentation(fmt, "ksigFax", "Fax"); +#endif +#if K3L_AT_LEAST(2,2,0) + case ksigISUPPassive: return presentation(fmt, "ksigISUPPassive", "ISUP Passive"); +#endif + } + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KSignaling='%d']") % (int)sig), + STG(FMT("Unknown signaling (%d)") % (int)sig)); +} + +std::string Verbose::systemObject(KSystemObject so, Verbose::Presentation fmt) +{ + switch (so) + { + case ksoLink: return presentation(fmt, "ksoLink", "Link"); + case ksoLinkMon: return presentation(fmt, "ksoLinkMon", "Link Monitor"); + case ksoChannel: return presentation(fmt, "ksoChannel", "Channel"); +#if K3L_AT_LEAST(2,1,0) + case ksoGsmChannel:return presentation(fmt, "ksoGsmChannel","GsmChannel"); +#endif + case ksoH100: return presentation(fmt, "ksoH100", "H.100"); + case ksoFirmware: return presentation(fmt, "ksoFirmware", "Firmware"); + case ksoDevice: return presentation(fmt, "ksoDevice", "Device"); + case ksoAPI: return presentation(fmt, "ksoAPI", "Software Layer"); + } + + return presentation(fmt, + STG(FMT("[KSystemObject='%d']") % (int)so), + STG(FMT("Unknown object (%d)") % (int)so)); +} + +std::string Verbose::mixerTone(KMixerTone mt, Verbose::Presentation fmt) +{ + switch (mt) + { + case kmtSilence: return presentation(fmt, "kmtSilence", "Silence"); + case kmtDial: return presentation(fmt, "kmtDial", "Dialtone begin"); + case kmtEndOf425: return presentation(fmt, "kmtEndOf425", "Dialtone end"); + case kmtBusy: return presentation(fmt, "kmtBusy", "Busy"); + case kmtFax: return presentation(fmt, "kmtFax", "Fax"); + case kmtVoice: return presentation(fmt, "kmtVoice", "Voice"); +#if K3L_AT_LEAST(1,5,0) + case kmtCollect: return presentation(fmt, "kmtCollect", "Collect Call"); +#endif +#if K3L_AT_LEAST(1,5,1) + case kmtEndOfDtmf: return presentation(fmt, "kmtEndOfDtmf", "DTMF end"); +#endif + } + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KMixerTone='%d']") % (int)mt), + STG(FMT("Unknonwn tone (%d)") % (int)mt)); +} + +std::string Verbose::mixerSource(KMixerSource ms, Verbose::Presentation fmt) +{ + switch (ms) + { + case kmsChannel: return presentation(fmt, "kmsChannel", "Channel"); + case kmsPlay: return presentation(fmt, "kmsPlay", "Player"); + case kmsGenerator: return presentation(fmt, "kmsGenerator", "Generator"); + case kmsCTbus: return presentation(fmt, "kmsCTbus", "CT-bus"); +#if (K3L_AT_LEAST(1,4,0) && !K3L_AT_LEAST(1,6,0)) + case kmsVoIP: return presentation(fmt, "kmsVoIP", "VoIP"); +#endif +#if K3L_AT_LEAST(1,6,0) + case kmsNoDelayChannel: return presentation(fmt, "kmsNoDelayChannel", "No delay channel"); +#endif + } + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KMixerSource='%d']") % (int)ms), + STG(FMT("Unknonwn source (%d)") % (int)ms)); +} + +std::string Verbose::channelFeatures(int32 flags, Verbose::Presentation fmt) +{ + if (0x00 != flags) + { + Strings::Merger strs; + + if (kcfDtmfSuppression & flags) strs.add(presentation(fmt, "DtmfSuppression", "DTMF Suppression")); + if (kcfCallProgress & flags) strs.add(presentation(fmt, "CallProgress", "Call Progress")); + if (kcfPulseDetection & flags) strs.add(presentation(fmt, "PulseDetection", "Pulse Detection")); + if (kcfAudioNotification & flags) strs.add(presentation(fmt, "AudioNotification", "Audio Notification")); + if (kcfEchoCanceller & flags) strs.add(presentation(fmt, "EchoCanceller", "Echo Canceller")); + if (kcfAutoGainControl & flags) strs.add(presentation(fmt, "AutoGainControl", "Input AGC")); + if (kcfHighImpEvents & flags) strs.add(presentation(fmt, "HighImpEvents", "High Impedance Events")); +#if K3L_AT_LEAST(1,6,0) + if (kcfCallAnswerInfo & flags) strs.add(presentation(fmt, "CallAnswerInfo", "Call Answer Info")); +#if !K3L_AT_LEAST(2,2,0) + if (kcfOutputVolume & flags) strs.add(presentation(fmt, "OutputVolume", "Output Volume")); +#endif + if (kcfPlayerAGC & flags) strs.add(presentation(fmt, "PlayerAGC", "Player AGC")); +#endif + + return presentation(fmt, + STG(FMT("kcf{%s}") % strs.merge(",")), + STG(FMT("%s") % strs.merge(", "))); + }; + + PRESENTATION_CHECK_RETURN(fmt, "", "No features"); +} + +std::string Verbose::seizeFail(KSeizeFail sf, Verbose::Presentation fmt) +{ + switch (sf) + { + case ksfChannelLocked: return presentation(fmt, "ksfChannelLocked", "Channel Locked"); + case ksfChannelBusy: return presentation(fmt, "ksfChannelBusy", "Channel Busy"); + case ksfIncomingChannel: return presentation(fmt, "ksfIncomingChannel", "Incoming Channel"); + case ksfDoubleSeizure: return presentation(fmt, "ksfDoubleSeizure", "Double Seizure"); + case ksfCongestion: return presentation(fmt, "ksfCongestion", "Congestion"); + case ksfNoDialTone: return presentation(fmt, "ksfNoDialTone", "No Dial Tone"); + } + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KSeizeFail='%d']") % (int)sf), + STG(FMT("Unknown seize fail (%d)") % (int)sf)); +} + +#if K3L_AT_LEAST(1,5,0) +std::string Verbose::internal_sipFailures(KSIP_Failures code, Verbose::Presentation fmt) +{ + switch (code) + { +#if K3L_AT_LEAST(1,6,0) + case kveResponse_200_OK_Success: return presentation(fmt, "kveResponse_200_OK_Success", "200 OK"); +#endif + case kveRedirection_300_MultipleChoices: return presentation(fmt, "kveRedirection_300_MultipleChoices", "300 Multiple Choices"); + case kveRedirection_301_MovedPermanently: return presentation(fmt, "kveRedirection_301_MovedPermanently", "301 Moved Permanently"); + case kveRedirection_302_MovedTemporarily: return presentation(fmt, "kveRedirection_302_MovedTemporarily", "302 Moved Temporarily"); + case kveRedirection_305_UseProxy: return presentation(fmt, "kveRedirection_305_UseProxy", "305 Use Proxy"); + case kveRedirection_380_AlternativeService: return presentation(fmt, "kveRedirection_380_AlternativeService", "380 Alternate Service"); + case kveFailure_400_BadRequest: return presentation(fmt, "kveFailure_400_BadRequest", "400 Bad Request"); + case kveFailure_401_Unauthorized: return presentation(fmt, "kveFailure_401_Unauthorized", "401 Unauthorized"); + case kveFailure_402_PaymentRequired: return presentation(fmt, "kveFailure_402_PaymentRequired", "402 Payment Required"); + case kveFailure_403_Forbidden: return presentation(fmt, "kveFailure_403_Forbidden", "403 Forbidden"); + case kveFailure_404_NotFound: return presentation(fmt, "kveFailure_404_NotFound", "404 Not Found"); + case kveFailure_405_MethodNotAllowed: return presentation(fmt, "kveFailure_405_MethodNotAllowed", "405 Method Not Allowed"); + case kveFailure_406_NotAcceptable: return presentation(fmt, "kveFailure_406_NotAcceptable", "406 Not Acceptable"); + case kveFailure_407_ProxyAuthenticationRequired: return presentation(fmt, "kveFailure_407_ProxyAuthenticationRequired", "407 Proxy Authentication Required"); + case kveFailure_408_RequestTimeout: return presentation(fmt, "kveFailure_408_RequestTimeout", "408 Request Timeout"); + case kveFailure_410_Gone: return presentation(fmt, "kveFailure_410_Gone", "410 Gone"); + case kveFailure_413_RequestEntityTooLarge: return presentation(fmt, "kveFailure_413_RequestEntityTooLarge", "413 Request Entity Too Large"); + case kveFailure_414_RequestURI_TooLong: return presentation(fmt, "kveFailure_414_RequestURI_TooLong", "414 Request URI Too Long"); + case kveFailure_415_UnsupportedMediaType: return presentation(fmt, "kveFailure_415_UnsupportedMediaType", "415 Unsupported Media Type"); + case kveFailure_416_UnsupportedURI_Scheme: return presentation(fmt, "kveFailure_416_UnsupportedURI_Scheme", "416 Unsupported URI Scheme"); + case kveFailure_420_BadExtension: return presentation(fmt, "kveFailure_420_BadExtension", "420 Bad Extension"); + case kveFailure_421_ExtensionRequired: return presentation(fmt, "kveFailure_421_ExtensionRequired", "421 Extension Required"); + case kveFailure_423_IntervalTooBrief: return presentation(fmt, "kveFailure_423_IntervalTooBrief", "423 Internal Too Brief"); + case kveFailure_480_TemporarilyUnavailable: return presentation(fmt, "kveFailure_480_TemporarilyUnavailable", "480 Temporarily Unavailable"); + case kveFailure_481_CallDoesNotExist: return presentation(fmt, "kveFailure_481_CallDoesNotExist", "481 Call Does Not Exist"); + case kveFailure_482_LoopDetected: return presentation(fmt, "kveFailure_482_LoopDetected", "482 Loop Detected"); + case kveFailure_483_TooManyHops: return presentation(fmt, "kveFailure_483_TooManyHops", "483 Too Many Hops"); + case kveFailure_484_AddressIncomplete: return presentation(fmt, "kveFailure_484_AddressIncomplete", "484 Address Incomplete"); + case kveFailure_485_Ambiguous: return presentation(fmt, "kveFailure_485_Ambiguous", "485 Ambiguous"); + case kveFailure_486_BusyHere: return presentation(fmt, "kveFailure_486_BusyHere", "486 Busy Here"); + case kveFailure_487_RequestTerminated: return presentation(fmt, "kveFailure_487_RequestTerminated", "487 Request Terminated"); + case kveFailure_488_NotAcceptableHere: return presentation(fmt, "kveFailure_488_NotAcceptableHere", "488 Not Acceptable Here"); + case kveFailure_491_RequestPending: return presentation(fmt, "kveFailure_491_RequestPending", "491 Request Pending"); + case kveFailure_493_Undecipherable: return presentation(fmt, "kveFailure_493_Undecipherable", "493 Undecipherable"); + case kveServer_500_InternalError: return presentation(fmt, "kveServer_500_InternalError", "500 Internal Error"); + case kveServer_501_NotImplemented: return presentation(fmt, "kveServer_501_NotImplemented", "501 Not Implemented"); + case kveServer_502_BadGateway: return presentation(fmt, "kveServer_502_BadGateway", "502 Bad Gateway"); + case kveServer_503_ServiceUnavailable: return presentation(fmt, "kveServer_503_ServiceUnavailable", "503 Service Unavailable"); + case kveServer_504_TimeOut: return presentation(fmt, "kveServer_504_TimeOut", "504 Timed Out"); + case kveServer_505_VersionNotSupported: return presentation(fmt, "kveServer_505_VersionNotSupported", "505 Version Not Supported"); + case kveServer_513_MessageTooLarge: return presentation(fmt, "kveServer_513_MessageTooLarge", "513 Message Too Large"); + case kveGlobalFailure_600_BusyEverywhere: return presentation(fmt, "kveGlobalFailure_600_BusyEverywhere", "600 Busy Everywhere"); + case kveGlobalFailure_603_Decline: return presentation(fmt, "kveGlobalFailure_603_Decline", "603 Decline"); + case kveGlobalFailure_604_DoesNotExistAnywhere: return presentation(fmt, "kveGlobalFailure_604_DoesNotExistAnywhere", "604 Does Not Exist Anywhere"); + case kveGlobalFailure_606_NotAcceptable: return presentation(fmt, "kveGlobalFailure_606_NotAcceptable", "606 Not Acceptable"); + } + + throw internal_not_found(); +} + +std::string Verbose::sipFailures(KSIP_Failures code, Verbose::Presentation fmt) +{ + try + { + return internal_sipFailures(code, fmt); + } + catch (internal_not_found & e) + { + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KSIP_Failures='%d']") % (int)code), + STG(FMT("Unknown SIP failure (%d)") % (int)code)); + } +} + +#endif + +#if K3L_AT_LEAST(1,5,1) +std::string Verbose::internal_isdnCause(KQ931Cause code, Verbose::Presentation fmt) +{ + switch (code) + { + case kq931cNone: return presentation(fmt, "kq931cNone", "None"); + case kq931cUnallocatedNumber: return presentation(fmt, "kq931cUnallocatedNumber", "Unallocated number"); + case kq931cNoRouteToTransitNet: return presentation(fmt, "kq931cNoRouteToTransitNet", "No route to transmit to network"); + case kq931cNoRouteToDest: return presentation(fmt, "kq931cNoRouteToDest", "No route to destination"); +#if 1 /* this changed during K3L 1.6.0 development cycle... */ + case kq931cSendSpecialInfoTone: return presentation(fmt, "kq931cSendSpecialInfoTone", "Send special information tone"); + case kq931cMisdialedTrunkPrefix: return presentation(fmt, "kq931cMisdialedTrunkPrefix", "Misdialed trunk prefix"); +#endif + case kq931cChannelUnacceptable: return presentation(fmt, "kq931cChannelUnacceptable", "Channel unacceptable"); + case kq931cCallAwarded: return presentation(fmt, "kq931cCallAwarded", "Call awarded"); +#if 1 /* this changed during K3L 1.6.0 development cycle... */ + case kq931cPreemption: return presentation(fmt, "kq931cPreemption", "Preemption"); + case kq931cPreemptionCircuitReuse: return presentation(fmt, "kq931cPreemptionCircuitReuse", "Preemption circuit reuse"); + case kq931cQoR_PortedNumber: return presentation(fmt, "kq931cQoR_PortedNumber", "QoR ported number"); +#endif + case kq931cNormalCallClear: return presentation(fmt, "kq931cNormalCallClear", "Normal call clear"); + case kq931cUserBusy: return presentation(fmt, "kq931cUserBusy", "User busy"); + case kq931cNoUserResponding: return presentation(fmt, "kq931cNoUserResponding", "No user responding"); + case kq931cNoAnswerFromUser: return presentation(fmt, "kq931cNoAnswerFromUser", "No answer from user"); +#if 1 /* this changed during K3L 1.6.0 development cycle... */ + case kq931cSubscriberAbsent: return presentation(fmt, "kq931cSubscriberAbsent", "Subscriber absent"); +#endif + case kq931cCallRejected: return presentation(fmt, "kq931cCallRejected", "Call rejected"); + case kq931cNumberChanged: return presentation(fmt, "kq931cNumberChanged", "Number changed"); +#if 1 /* this changed during K3L 1.6.0 development cycle... */ + case kq931cRedirectionToNewDest: return presentation(fmt, "kq931cRedirectionToNewDest", "Redirection to new destination"); + case kq931cCallRejectedFeatureDest: return presentation(fmt, "kq931cCallRejectedFeatureDest", "Call rejected feature destination"); + case kq931cExchangeRoutingError: return presentation(fmt, "kq931cExchangeRoutingError", "Exchange routing error"); +#endif + case kq931cNonSelectedUserClear: return presentation(fmt, "kq931cNonSelectedUserClear", "Non selected user clear"); + case kq931cDestinationOutOfOrder: return presentation(fmt, "kq931cDestinationOutOfOrder", "Destination out of order"); + case kq931cInvalidNumberFormat: return presentation(fmt, "kq931cInvalidNumberFormat", "Invalid number format"); + case kq931cFacilityRejected: return presentation(fmt, "kq931cFacilityRejected", "Facility rejected"); + case kq931cRespStatusEnquiry: return presentation(fmt, "kq931cRespStatusEnquiry", "Response status enquiry"); + case kq931cNormalUnspecified: return presentation(fmt, "kq931cNormalUnspecified", "Normal unespecified"); + case kq931cNoCircuitChannelAvail: return presentation(fmt, "kq931cNoCircuitChannelAvail", "No circuit channel available"); + case kq931cNetworkOutOfOrder: return presentation(fmt, "kq931cNetworkOutOfOrder", "Network out of order"); +#if 1 /* this changed during K3L 1.6.0 development cycle... */ + case kq931cPermanentFrameConnOutOfService: return presentation(fmt, "kq931cPermanentFrameConnOutOfService", "Permanent frame connection out of service"); + case kq931cPermanentFrameConnOperational: return presentation(fmt, "kq931cPermanentFrameConnOperational", "Permanent frame connection operational"); +#endif + case kq931cTemporaryFailure: return presentation(fmt, "kq931cTemporaryFailure", "Temporary failure"); + case kq931cSwitchCongestion: return presentation(fmt, "kq931cSwitchCongestion", "Switch congestion"); + case kq931cAccessInfoDiscarded: return presentation(fmt, "kq931cAccessInfoDiscarded", "Access information discarded"); + case kq931cRequestedChannelUnav: return presentation(fmt, "kq931cRequestedChannelUnav", "Requested channel unavailable"); + case kq931cPrecedenceCallBlocked: return presentation(fmt, "kq931cPrecedenceCallBlocked", "Precedence call blocked"); + case kq931cResourceUnavailable: return presentation(fmt, "kq931cResourceUnavailable", "Request resource unavailable"); + case kq931cQosUnavailable: return presentation(fmt, "kq931cQosUnavailable", "QoS unavailable"); + case kq931cReqFacilityNotSubsc: return presentation(fmt, "kq931cReqFacilityNotSubsc", "Request facility not subscribed"); + case kq931cOutCallsBarredWithinCUG: return presentation(fmt, "kq931cOutCallsBarredWithinCUG", "Out calls barred within UG"); + case kq931cInCallsBarredWithinCUG: return presentation(fmt, "kq931cInCallsBarredWithinCUG", "In calls barred within UG"); + case kq931cBearerCapabNotAuthor: return presentation(fmt, "kq931cBearerCapabNotAuthor", "Bearer capability not authorized"); + case kq931cBearerCapabNotAvail: return presentation(fmt, "kq931cBearerCapabNotAvail", "Bearer capability not available"); +#if 1 /* this changed during K3L 1.6.0 development cycle... */ + case kq931cInconsistency: return presentation(fmt, "kq931cInconsistency", "Inconsistency"); +#endif + case kq931cServiceNotAvailable: return presentation(fmt, "kq931cServiceNotAvailable", "Service not available"); + case kq931cBcNotImplemented: return presentation(fmt, "kq931cBcNotImplemented", "Bearer capability not implemented"); + case kq931cChannelTypeNotImplem: return presentation(fmt, "kq931cChannelTypeNotImplem", "Channel type not implemented"); + case kq931cReqFacilityNotImplem: return presentation(fmt, "kq931cReqFacilityNotImplem", "Request facility not implemented"); + case kq931cOnlyRestrictedBcAvail: return presentation(fmt, "kq931cOnlyRestrictedBcAvail", "Only restricted bearer capability available"); + case kq931cServiceNotImplemented: return presentation(fmt, "kq931cServiceNotImplemented", "Service not implemented"); + case kq931cInvalidCrv: return presentation(fmt, "kq931cInvalidCrv", "Invalid call reference value"); + case kq931cChannelDoesNotExist: return presentation(fmt, "kq931cChannelDoesNotExist", "Channel does not exist"); + case kq931cCallIdDoesNotExist: return presentation(fmt, "kq931cCallIdDoesNotExist", "Call identification does not exist"); + case kq931cCallIdInUse: return presentation(fmt, "kq931cCallIdInUse", "Call identification in use"); + case kq931cNoCallSuspended: return presentation(fmt, "kq931cNoCallSuspended", "No call suspended"); + case kq931cCallIdCleared: return presentation(fmt, "kq931cCallIdCleared", "Call identification cleared"); +#if 1 /* this changed during K3L 1.6.0 development cycle... */ + case kq931cUserNotMemberofCUG: return presentation(fmt, "kq931cUserNotMemberofCUG", "User not member of UG"); +#endif + case kq931cIncompatibleDestination: return presentation(fmt, "kq931cIncompatibleDestination", "Incompatible destination"); + case kq931cInvalidTransitNetSel: return presentation(fmt, "kq931cInvalidTransitNetSel", "Invalid transit network selected"); + case kq931cInvalidMessage: return presentation(fmt, "kq931cInvalidMessage", "Invalid message"); + case kq931cMissingMandatoryIe: return presentation(fmt, "kq931cMissingMandatoryIe", "Missing mandatory information element"); + case kq931cMsgTypeNotImplemented: return presentation(fmt, "kq931cMsgTypeNotImplemented", "Message type not implemented"); + case kq931cMsgIncompatWithState: return presentation(fmt, "kq931cMsgIncompatWithState", "Message incompatible with state"); + case kq931cIeNotImplemented: return presentation(fmt, "kq931cIeNotImplemented", "Information element not implemented"); + case kq931cInvalidIe: return presentation(fmt, "kq931cInvalidIe", "Invalid information element"); + case kq931cMsgIncompatWithState2: return presentation(fmt, "kq931cMsgIncompatWithState2", "Message incompatible with state (2)"); + case kq931cRecoveryOnTimerExpiry: return presentation(fmt, "kq931cRecoveryOnTimerExpiry", "Recovery on timer expiry"); + case kq931cProtocolError: return presentation(fmt, "kq931cProtocolError", "Protocol error"); +#if 1 /* this changed during K3L 1.6.0 development cycle... */ + case kq931cMessageWithUnrecognizedParam: return presentation(fmt, "kq931cMessageWithUnrecognizedParam", "Message with unrecognized parameters"); + case kq931cProtocolErrorUnspecified: return presentation(fmt, "kq931cProtocolErrorUnspecified", "Protocol error unspecified"); +#endif + case kq931cInterworking: return presentation(fmt, "kq931cInterworking", "Interworking"); + case kq931cCallConnected: return presentation(fmt, "kq931cCallConnected", "Call connected"); + case kq931cCallTimedOut: return presentation(fmt, "kq931cCallTimedOut", "Call timeout"); + case kq931cCallNotFound: return presentation(fmt, "kq931cCallNotFound", "Call not found"); + case kq931cCantReleaseCall: return presentation(fmt, "kq931cCantReleaseCall", "Cannot realese call"); + case kq931cNetworkFailure: return presentation(fmt, "kq931cNetworkFailure", "Network failure"); + case kq931cNetworkRestart: return presentation(fmt, "kq931cNetworkRestart", "Network restart"); + } + + throw internal_not_found(); +} + +std::string Verbose::isdnCause(KQ931Cause code, Verbose::Presentation fmt) +{ + try + { + return internal_isdnCause(code); + } + catch (internal_not_found & e) + { + return STG(FMT("[KQ931Cause='%d']") % (int)code); + } +} +#endif + +#if K3L_AT_LEAST(1,5,2) +std::string Verbose::isdnDebug(int32 flags, Verbose::Presentation fmt) +{ + if (0x00 != flags) + { + Strings::Merger strs; + + if (flags & kidfQ931) strs.add("Q931"); + if (flags & kidfLAPD) strs.add("LAPD"); + if (flags & kidfSystem) strs.add("System"); + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("kidf{%s}") % strs.merge(",")), + strs.merge(", ")); + } + + return presentation(fmt, "", "No debug active"); +} +#endif + +#if K3L_AT_LEAST(2,0,0) +std::string Verbose::internal_signGroupB(KSignGroupB group, R2CountryType country, Verbose::Presentation fmt) +#else +std::string Verbose::internal_signGroupB(KSignGroupB group, Verbose::Presentation fmt) +#endif +{ +#if K3L_AT_LEAST(2,0,0) + switch (country) + { + case R2_COUNTRY_ARG: + switch ((KSignGroupB_Argentina)group) + { + case kgbArNumberChanged: return presentation(fmt, "kgbArNumberChanged", "Number Changed"); + case kgbArBusy: return presentation(fmt, "kgbArBusy", "Busy"); + case kgbArCongestion: return presentation(fmt, "kgbArCongestion", "Congestion"); + case kgbArInvalidNumber: return presentation(fmt, "kgbArInvalidNumber", "Invalid Number"); + case kgbArLineFreeCharged: return presentation(fmt, "kgbArLineFreeCharged", "Line Free Charged"); + case kgbArLineFreeNotCharged: return presentation(fmt, "kgbArLineFreeNotCharged", "Line Free Not Charged"); + case kgbArLineOutOfOrder: return presentation(fmt, "kgbArLineOutOfOrder", "Line Out Of Order"); + case kgbArNone: return presentation(fmt, "kgbArNone", "None"); + } + break; + + case R2_COUNTRY_BRA: + switch ((KSignGroupB_Brazil)group) + { + case kgbBrLineFreeCharged: return presentation(fmt, "kgbBrLineFreeCharged", "Line Free Charged"); + case kgbBrLineFreeNotCharged: return presentation(fmt, "kgbBrLineFreeNotCharged", "Line Free Not Charged"); + case kgbBrLineFreeChargedLPR: return presentation(fmt, "kgbBrLineFreeChargedLPR", "Line Free Charged PLR"); + case kgbBrBusy: return presentation(fmt, "kgbBrBusy", "Busy"); + case kgbBrNumberChanged: return presentation(fmt, "kgbBrNumberChanged", "Number Changed"); + case kgbBrCongestion: return presentation(fmt, "kgbBrCongestion", "Congestion"); + case kgbBrInvalidNumber: return presentation(fmt, "kgbBrInvalidNumber", "Invalid Number"); + case kgbBrLineOutOfOrder: return presentation(fmt, "kgbBrLineOutOfOrder", "Line Out Of Order"); + case kgbBrNone: return presentation(fmt, "kgbBrNone", "None"); + } + break; + + case R2_COUNTRY_CHI: + switch ((KSignGroupB_Chile)group) + { + case kgbClNumberChanged: return presentation(fmt, "kgbClNumberChanged", "Number Changed"); + case kgbClBusy: return presentation(fmt, "kgbClBusy", "Busy"); + case kgbClCongestion: return presentation(fmt, "kgbClCongestion", "Congestion"); + case kgbClInvalidNumber: return presentation(fmt, "kgbClInvalidNumber", "Invalid Number"); + case kgbClLineFreeCharged: return presentation(fmt, "kgbClLineFreeCharged", "Line Free Charged"); + case kgbClLineFreeNotCharged: return presentation(fmt, "kgbClLineFreeNotCharged", "Line Free Not Charged"); + case kgbClLineOutOfOrder: return presentation(fmt, "kgbClLineOutOfOrder", "Line Out Of Order"); + case kgbClNone: return presentation(fmt, "kgbClNone", "None"); + } + break; + + case R2_COUNTRY_MEX: + switch ((KSignGroupB_Mexico)group) + { + case kgbMxLineFreeCharged: return presentation(fmt, "kgbMxLineFreeCharged", "Line Free Charged"); + case kgbMxBusy: return presentation(fmt, "kgbMxBusy", "Busy"); + case kgbMxLineFreeNotCharged: return presentation(fmt, "kgbMxLineFreeNotCharged", "Line Free Not Charged"); + case kgbMxNone: return presentation(fmt, "kgbMxNone", "None"); + } + break; + + case R2_COUNTRY_URY: + switch ((KSignGroupB_Uruguay)group) + { + case kgbUyNumberChanged: return presentation(fmt, "kgbUyNumberChanged", "Number Changed"); + case kgbUyBusy: return presentation(fmt, "kgbUyBusy", "Busy"); + case kgbUyCongestion: return presentation(fmt, "kgbUyCongestion", "Congestion"); + case kgbUyInvalidNumber: return presentation(fmt, "kgbUyInvalidNumber", "Invalid Number"); + case kgbUyLineFreeCharged: return presentation(fmt, "kgbUyLineFreeCharged", "Line Free Charged"); + case kgbUyLineFreeNotCharged: return presentation(fmt, "kgbUyLineFreeNotCharged", "Line Free Not Charged"); + case kgbUyLineOutOfOrder: return presentation(fmt, "kgbUyLineOutOfOrder", "Line Out Of Order"); + case kgbUyNone: return presentation(fmt, "kgbUyNone", "None"); + } + break; + + case R2_COUNTRY_VEN: + switch ((KSignGroupB_Venezuela)group) + { + case kgbVeLineFreeChargedLPR: return presentation(fmt, "kgbVeLineFreeChargedLPR", "Line Free Charged PLR"); + case kgbVeNumberChanged: return presentation(fmt, "kgbVeNumberChanged", "Number Changed"); + case kgbVeBusy: return presentation(fmt, "kgbVeBusy", "Busy"); + case kgbVeCongestion: return presentation(fmt, "kgbVeCongestion", "Congestion"); + case kgbVeInformationTone: return presentation(fmt, "kgbVeInformationTone", "Information Tone"); + case kgbVeLineFreeCharged: return presentation(fmt, "kgbVeLineFreeCharged", "Line Free Charged"); + case kgbVeLineFreeNotCharged: return presentation(fmt, "kgbVeLineFreeNotCharged", "Line Free Not Charged"); + case kgbVeLineBlocked: return presentation(fmt, "kgbVeLineBlocked", "Line Blocked"); + case kgbVeIntercepted: return presentation(fmt, "kgbVeIntercepted", "Intercepted"); + case kgbVeDataTrans: return presentation(fmt, "kgbVeDataTrans", "Data Transfer"); + case kgbVeNone: return presentation(fmt, "kgbVeNone", "None"); + } + break; + } +#else + switch ((KSignGroupB)group) + { + case kgbLineFreeCharged: return presentation(fmt, "kgbLineFreeCharged", "Line Free Charged"); + case kgbLineFreeNotCharged: return presentation(fmt, "kgbLineFreeNotCharged", "Line Free Not Charged"); + case kgbLineFreeChargedLPR: return presentation(fmt, "kgbLineFreeChargedLPR", "Line Free Charged PLR"); + case kgbBusy: return presentation(fmt, "kgbBusy", "Busy"); + case kgbNumberChanged: return presentation(fmt, "kgbNumberChanged", "Number Changed"); + case kgbCongestion: return presentation(fmt, "kgbCongestion", "Congestion"); + case kgbInvalidNumber: return presentation(fmt, "kgbInvalidNumber", "Invalid Number"); + case kgbLineOutOfOrder: return presentation(fmt, "kgbLineOutOfOrder", "Line Out Of Order"); + case kgbNone: return presentation(fmt, "kgbNone", "None"); + } +#endif + + throw internal_not_found(); +} + +#if K3L_AT_LEAST(2,0,0) +std::string Verbose::signGroupB(KSignGroupB group, R2CountryType r2_country, Verbose::Presentation fmt) +#else +std::string Verbose::signGroupB(KSignGroupB group, Verbose::Presentation fmt) +#endif +{ + try + { +#if K3L_AT_LEAST(2,0,0) + return internal_signGroupB(group, r2_country, fmt); +#else + return internal_signGroupB(group, fmt); +#endif + } + catch (internal_not_found & e) + { + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KSignGroupB='%d']") % (int)group), + STG(FMT("Unknown group B (%d)") % (int)group)); + } +} + +#if K3L_AT_LEAST(2,0,0) +std::string Verbose::internal_signGroupII(KSignGroupII group, R2CountryType country, Verbose::Presentation fmt) +#else +std::string Verbose::internal_signGroupII(KSignGroupII group, Verbose::Presentation fmt) +#endif +{ +#if K3L_AT_LEAST(2,0,0) + switch (country) + { + case R2_COUNTRY_ARG: + switch ((KSignGroupII_Argentina)group) + { + case kg2ArOrdinary: return presentation(fmt, "kg2ArOrdinary", "Ordinary"); + case kg2ArPriority: return presentation(fmt, "kg2ArPriority", "Priority"); + case kg2ArMaintenance: return presentation(fmt, "kg2ArMaintenance", "Maintenance"); + case kg2ArLocalPayPhone: return presentation(fmt, "kg2ArLocalPayPhone", "Local pay phone"); + case kg2ArTrunkOperator: return presentation(fmt, "kg2ArTrunkOperator", "Trunk operator"); + case kg2ArDataTrans: return presentation(fmt, "kg2ArDataTrans", "Data transfer"); + case kg2ArCPTP: return presentation(fmt, "kg2ArCPTP", "CPTP"); + case kg2ArSpecialLine: return presentation(fmt, "kg2ArSpecialLine", "Special line"); + case kg2ArMobileUser: return presentation(fmt, "kg2ArMobileUser", "Mobile user"); + case kg2ArPrivateRedLine: return presentation(fmt, "kg2ArPrivateRedLine", "Private red line"); + case kg2ArSpecialPayPhoneLine: return presentation(fmt, "kg2ArSpecialPayPhoneLine", "Special pay phone line"); + } + break; + + case R2_COUNTRY_BRA: + switch ((KSignGroupII_Brazil)group) + { + case kg2BrOrdinary: return presentation(fmt, "kg2BrOrdinary", "Ordinary"); + case kg2BrPriority: return presentation(fmt, "kg2BrPriority", "Priority"); + case kg2BrMaintenance: return presentation(fmt, "kg2BrMaintenance", "Maintenance"); + case kg2BrLocalPayPhone: return presentation(fmt, "kg2BrLocalPayPhone", "Local pay phone"); + case kg2BrTrunkOperator: return presentation(fmt, "kg2BrTrunkOperator", "Trunk operator"); + case kg2BrDataTrans: return presentation(fmt, "kg2BrDataTrans", "Data transfer"); + case kg2BrNonLocalPayPhone: return presentation(fmt, "kg2BrNonLocalPayPhone", "Non local pay phone"); + case kg2BrCollectCall: return presentation(fmt, "kg2BrCollectCall", "Collect call"); + case kg2BrOrdinaryInter: return presentation(fmt, "kg2BrOrdinaryInter", "Ordinary international"); + case kg2BrTransfered: return presentation(fmt, "kg2BrTransfered", "Transfered"); + } + break; + + case R2_COUNTRY_CHI: + switch ((KSignGroupII_Chile)group) + { + case kg2ClOrdinary: return presentation(fmt, "kg2ClOrdinary", "Ordinary"); + case kg2ClPriority: return presentation(fmt, "kg2ClPriority", "Priority"); + case kg2ClMaintenance: return presentation(fmt, "kg2ClMaintenance", "Maintenance"); + case kg2ClTrunkOperator: return presentation(fmt, "kg2ClTrunkOperator", "Trunk operator"); + case kg2ClDataTrans: return presentation(fmt, "kg2ClDataTrans", "Data transfer"); + case kg2ClUnidentifiedSubscriber: return presentation(fmt, "kg2ClUnidentifiedSubscriber", "Unidentified subscriber"); + } + break; + + case R2_COUNTRY_MEX: + switch ((KSignGroupII_Mexico)group) + { + case kg2MxTrunkOperator: return presentation(fmt, "kg2MxTrunkOperator", "Trunk operator"); + case kg2MxOrdinary: return presentation(fmt, "kg2MxOrdinary", "Ordinary"); + case kg2MxMaintenance: return presentation(fmt, "kg2MxMaintenance", "Maintenance"); + } + break; + + case R2_COUNTRY_URY: + switch ((KSignGroupII_Uruguay)group) + { + case kg2UyOrdinary: return presentation(fmt, "kg2UyOrdinary", "Ordinary"); + case kg2UyPriority: return presentation(fmt, "kg2UyPriority", "Priority"); + case kg2UyMaintenance: return presentation(fmt, "kg2UyMaintenance", "Maintenance"); + case kg2UyLocalPayPhone: return presentation(fmt, "kg2UyLocalPayPhone", "Local pay phone"); + case kg2UyTrunkOperator: return presentation(fmt, "kg2UyTrunkOperator", "Trunk operator"); + case kg2UyDataTrans: return presentation(fmt, "kg2UyDataTrans", "Data transfer"); + case kg2UyInternSubscriber: return presentation(fmt, "kg2UyInternSubscriber", "International subscriber"); + } + break; + + case R2_COUNTRY_VEN: + switch ((KSignGroupII_Venezuela)group) + { + case kg2VeOrdinary: return presentation(fmt, "kg2VeOrdinary", "Ordinary"); + case kg2VePriority: return presentation(fmt, "kg2VePriority", "Priority"); + case kg2VeMaintenance: return presentation(fmt, "kg2VeMaintenance", "Maintenance"); + case kg2VeLocalPayPhone: return presentation(fmt, "kg2VeLocalPayPhone", "Local pay phone"); + case kg2VeTrunkOperator: return presentation(fmt, "kg2VeTrunkOperator", "Trunk operator"); + case kg2VeDataTrans: return presentation(fmt, "kg2VeDataTrans", "Data transfer"); + case kg2VeNoTransferFacility: return presentation(fmt, "kg2VeNoTransferFacility", "No transfer facility"); + } + break; + } +#else + switch ((KSignGroupII)group) + { + case kg2Ordinary: return presentation(fmt, "kg2Ordinary", "Ordinary"); + case kg2Priority: return presentation(fmt, "kg2Priority", "Priority"); + case kg2Maintenance: return presentation(fmt, "kg2Maintenance", "Maintenance"); + case kg2LocalPayPhone: return presentation(fmt, "kg2LocalPayPhone", "Local pay phone"); + case kg2TrunkOperator: return presentation(fmt, "kg2TrunkOperator", "Trunk operator"); + case kg2DataTrans: return presentation(fmt, "kg2DataTrans", "Data transfer"); + case kg2NonLocalPayPhone: return presentation(fmt, "kg2NonLocalPayPhone", "Non local pay phone"); + case kg2CollectCall: return presentation(fmt, "kg2CollectCall", "Collect call"); + case kg2OrdinaryInter: return presentation(fmt, "kg2OrdinaryInter", "Ordinary international"); + case kg2Transfered: return presentation(fmt, "kg2Transfered", "Transfered"); + } +#endif + + throw internal_not_found(); +} + +#if K3L_AT_LEAST(2,0,0) +std::string Verbose::signGroupII(KSignGroupII group, R2CountryType r2_country, Verbose::Presentation fmt) +#else +std::string Verbose::signGroupII(KSignGroupII group, Verbose::Presentation fmt) +#endif +{ + try + { +#if K3L_AT_LEAST(2,0,0) + return internal_signGroupII(group, r2_country); +#else + return internal_signGroupII(group); +#endif + } + catch (internal_not_found & e) + { + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KSignGroupII='%d']") % (int)group), + STG(FMT("Unknown group II (%d)") % (int)group)); + } +} + +#if K3L_AT_LEAST(2,0,0) +std::string Verbose::callFail(KSignaling sig, R2CountryType country, int32 info, Verbose::Presentation fmt) +#else +std::string Verbose::callFail(KSignaling sig, int32 info, Verbose::Presentation fmt) +#endif +{ + try + { + switch (sig) + { + case ksigInactive: + throw internal_not_found(); + + case ksigAnalog: + if (('a' <= ((char)info) && 'z' >= ((char)info)) || ('A' <= ((char)info) && 'Z' >= ((char)info))) + return STG(FMT("%c") % (char)info); + else + throw internal_not_found(); + +#if K3L_AT_LEAST(1,5,4) + case ksigLineSide: +#endif +#if K3L_EXACT(2,1,0) + case ksigISUP: + case ksigFax: +#endif +#if K3L_AT_LEAST(1,6,0) + case ksigCAS_EL7: + case ksigE1LC: + return "NOT IMPLEMENTED"; + + case ksigAnalogTerminal: +#endif + case ksigContinuousEM: + case ksigPulsedEM: + + case ksigR2Digital: + case ksigOpenR2: +#if K3L_AT_LEAST(2,0,0) + return internal_signGroupB((KSignGroupB)info, country); +#else + return internal_signGroupB((KSignGroupB)info); +#endif + + case ksigOpenCAS: + case ksigUserR2Digital: +#if K3L_AT_LEAST(2,0,0) + return internal_signGroupB((KSignGroupB)info, R2_COUNTRY_BRA); +#else + return internal_signGroupB((KSignGroupB)info); +#endif + +#if K3L_AT_LEAST(1,5,0) + case ksigSIP: + return internal_sipFailures((KSIP_Failures)info); +#endif + +#if K3L_AT_LEAST(1,5,1) + case ksigOpenCCS: + case ksigPRI_EndPoint: + case ksigPRI_Network: + case ksigPRI_Passive: +#if K3L_AT_LEAST(2,2,0) + case ksigISUP: + case ksigISUPPassive: +#endif + return internal_isdnCause((KQ931Cause)info); +#endif + +#if K3L_AT_LEAST(1,6,0) + case ksigGSM: + return internal_gsmCallCause((KGsmCallCause)info); +#endif + } + } + catch (internal_not_found & e) + { + /* this exception is used for breaking the control flow */ + } + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[%s, callFail='%d']") % signaling(sig, fmt) % (int)info), + STG(FMT("Unknown call fail code for '%s' (%d)") % signaling(sig, fmt) % (int)info)); +} + +std::string Verbose::channelFail(KSignaling sig, int32 code, Verbose::Presentation fmt) +{ + try + { + switch (sig) + { + case ksigInactive: + case ksigAnalog: + case ksigSIP: +#if K3L_EXACT(2,1,0) + case ksigISUP: + case ksigFax: +#endif + throw internal_not_found(); + +#if K3L_AT_LEAST(1,6,0) + case ksigGSM: + return internal_gsmMobileCause((KGsmMobileCause)code); + + case ksigAnalogTerminal: + case ksigCAS_EL7: + case ksigE1LC: +#endif + + case ksigContinuousEM: + case ksigPulsedEM: + + case ksigLineSide: + + case ksigOpenCAS: + case ksigOpenR2: + case ksigR2Digital: + case ksigUserR2Digital: + switch ((KChannelFail)code) + { + case kfcRemoteFail: return presentation(fmt, "kfcRemoteFail", "Remote failure"); + case kfcLocalFail: return presentation(fmt, "kfcLocalFail", "Local failure"); + case kfcRemoteLock: return presentation(fmt, "kfcRemoteLock", "Remote lock"); + case kfcLineSignalFail: return presentation(fmt, "kfcLineSignalFail", "Line signal failure"); + case kfcAcousticSignalFail: return presentation(fmt, "kfcAcousticSignalFail", "Acoustic signal failure"); + } + + throw internal_not_found(); + +#if K3L_AT_LEAST(1,5,1) + case ksigOpenCCS: + case ksigPRI_EndPoint: + case ksigPRI_Network: + case ksigPRI_Passive: +#if K3L_AT_LEAST(2,2,0) + case ksigISUP: + case ksigISUPPassive: +#endif + return internal_isdnCause((KQ931Cause)code); +#endif + } + } + catch (internal_not_found & e) + { + /* this exception is used for breaking the control flow */ + } + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[%s, channelFail='%d']") % signaling(sig, fmt) % (int)code), + STG(FMT("Unknown channel fail code for '%s' (%d)") % signaling(sig, fmt) % (int)code)); +} + +std::string Verbose::internalFail(KInternalFail inf, Verbose::Presentation fmt) +{ + switch (inf) + { + case kifInterruptCtrl: return presentation(fmt, "kifInterruptCtrl", "Interrupt control"); + case kifCommunicationFail: return presentation(fmt, "kifCommunicationFail", "Communication failure"); + case kifProtocolFail: return presentation(fmt, "kifProtocolFail", "Protocol failure"); + case kifInternalBuffer: return presentation(fmt, "kifInternalBuffer", "Internal buffer"); + case kifMonitorBuffer: return presentation(fmt, "kifMonitorBuffer", "Monitor buffer"); + case kifInitialization: return presentation(fmt, "kifInitialization", "Initialization"); + case kifInterfaceFail: return presentation(fmt, "kifInterfaceFail", "Interface failure"); + case kifClientCommFail: return presentation(fmt, "kifClientCommFail", "Client communication failure"); + } + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KInternalFail='%d']") % (int)inf), + STG(FMT("Unknown internal failure (%d)") % (int)inf)); +} + +std::string Verbose::linkErrorCounter(KLinkErrorCounter ec, Verbose::Presentation fmt) +{ + switch (ec) + { + case klecChangesToLock: return presentation(fmt, "klecChangesToLock", "Changes to lock"); + case klecLostOfSignal: return presentation(fmt, "klecLostOfSignal", "Lost of signal"); + case klecAlarmNotification: return presentation(fmt, "klecAlarmNotification", "Alarm notification"); + case klecLostOfFrame: return presentation(fmt, "klecLostOfFrame", "Lost of frame"); + case klecLostOfMultiframe: return presentation(fmt, "klecLostOfMultiframe", "Lost of multiframe"); + case klecRemoteAlarm: return presentation(fmt, "klecRemoteAlarm", "Remote alarm"); + case klecUnknowAlarm: return presentation(fmt, "klecUnknowAlarm", "Slip alarm"); + case klecPRBS: return presentation(fmt, "klecPRBS", "PRBS"); + case klecWrogrBits: return presentation(fmt, "klecWrongBits", "Wrong bits"); + case klecJitterVariation: return presentation(fmt, "klecJitterVariation", "Jitter variation"); + case klecFramesWithoutSync: return presentation(fmt, "klecFramesWithoutSync", "Frames without sync"); + case klecMultiframeSignal: return presentation(fmt, "klecMultiframeSignal", "Multiframe Signal"); + case klecFrameError: return presentation(fmt, "klecFrameError", "Frame error"); + case klecBipolarViolation: return presentation(fmt, "klecBipolarViolation", "Bipolar violation"); + case klecCRC4: return presentation(fmt, "klecCRC4", "CRC4 error"); + case klecCount: return ""; /* this should never be verbosed */ + } + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KLinkErrorCounter='%d']") % (int)ec), + STG(FMT("Unknown link error counter (%d)") % (int)ec)); +} + +std::string Verbose::callStatus(KCallStatus code, Verbose::Presentation fmt) +{ + switch (code) + { + case kcsFree: return presentation(fmt, "kcsFree", "Free"); + case kcsIncoming: return presentation(fmt, "kcsIncoming", "Incoming"); + case kcsOutgoing: return presentation(fmt, "kcsOutgoing", "Outgoing"); + case kcsFail: return presentation(fmt, "kcsFail", "Failure"); + } + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KCallStatus='%d']") % (int)code), + STG(FMT("Unknown call status (%d)") % (int)code)); +} + +std::string Verbose::linkStatus(KSignaling sig, int32 code, Verbose::Presentation fmt) +{ + switch (sig) + { + case ksigInactive: + return presentation(fmt, "[ksigInactive]", "Inactive trunk"); + + case ksigAnalog: + return presentation(fmt, "[ksigAnalog]", "Analog trunk"); + +#if K3L_AT_LEAST(1,4,1) + case ksigSIP: + return presentation(fmt, "[ksigSIP]", "SIP trunk"); +#endif + +#if K3L_AT_LEAST(1,6,0) + case ksigGSM: + return presentation(fmt, "[ksigGSM]", "GSM trunk"); +#endif + +#if K3L_EXACT(2,1,0) + case ksigFax: + return presentation(fmt, "[ksigFax]", "FAX"); +#endif + case ksigContinuousEM: + case ksigPulsedEM: + + case ksigOpenCAS: + case ksigOpenR2: + case ksigR2Digital: + case ksigUserR2Digital: + +#if K3L_AT_LEAST(1,5,1) + case ksigOpenCCS: + case ksigPRI_EndPoint: + case ksigPRI_Network: + case ksigPRI_Passive: +#endif +#if K3L_AT_LEAST(1,5,3) + case ksigLineSide: +#endif +#if K3L_AT_LEAST(1,6,0) + case ksigAnalogTerminal: + case ksigCAS_EL7: + case ksigE1LC: +#endif +#if K3L_AT_LEAST(2,2,0) + case ksigISUP: + case ksigISUPPassive: +#endif + if (kesOk == code) + { + return presentation(fmt, "kesOk", "Up"); + } + else + { + Strings::Merger strs; + + if (kesSignalLost & code) strs.add(presentation(fmt, "SignalLost", "Signal lost")); + if (kesNetworkAlarm & code) strs.add(presentation(fmt, "NetworkAlarm", "Network alarm")); + if (kesFrameSyncLost & code) strs.add(presentation(fmt, "FrameSyncLost", "Frame sync lost")); + if (kesMultiframeSyncLost & code) strs.add(presentation(fmt, "MultiframeSyncLost", "Multiframe sync lost")); + if (kesRemoteAlarm & code) strs.add(presentation(fmt, "RemoteAlarm", "Remote alarm")); + if (kesHighErrorRate & code) strs.add(presentation(fmt, "HighErrorRate", "High error rate")); + if (kesUnknownAlarm & code) strs.add(presentation(fmt, "UnknownAlarm", "Slip alarm")); + if (kesE1Error & code) strs.add(presentation(fmt, "E1Error", "E1 error")); + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("kes{%s}") % strs.merge(",")), + strs.merge(", ")); + } + } + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[%s, linkStatus='%d']") % signaling(sig) % (int)code), + STG(FMT("Unknown link status for '%s' (%d)") % signaling(sig) % (int)code)); +} + +std::string Verbose::channelStatus(KSignaling sig, int32 flags, Verbose::Presentation fmt) +{ + try + { + switch (sig) + { + case ksigInactive: + return presentation(fmt, "[ksigInactive]", "Inactive channel"); + +#if K3L_AT_LEAST(1,4,1) + case ksigSIP: + return presentation(fmt, "[ksigSIP]", "SIP channel"); +#endif +#if K3L_EXACT(2,1,0) + case ksigISUP: + return presentation(fmt, "[ksigISUP]", "ISUP trunk"); + case ksigFax: + return presentation(fmt, "[ksigFax]", "FAX"); +#endif + + case ksigAnalog: +#if K3L_AT_LEAST(1,6,0) + switch ((KFXOChannelStatus)flags) +#else + switch ((KFXChannelStatus)flags) +#endif + { + case kfcsDisabled: return presentation(fmt, "kfcsDisabled", "Disabled"); + case kfcsEnabled: return presentation(fmt, "kfcsEnabled", "Enabled"); + } + + throw internal_not_found(); + +#if K3L_AT_LEAST(1,6,0) + case ksigAnalogTerminal: + switch ((KFXSChannelStatus)flags) + { + case kfxsOnHook: return presentation(fmt, "kfxsOnHook", "On Hook"); + case kfxsOffHook: return presentation(fmt, "kfxsOffHook", "Off Hook"); + case kfxsRinging: return presentation(fmt, "kfxsRinging", "Ringing"); + case kfxsFail: return presentation(fmt, "kfxsFail", "Failure"); + } + + throw internal_not_found(); + + case ksigGSM: + switch ((KGsmChannelStatus)flags) + { + case kgsmIdle: return presentation(fmt, "kgsmIdle", "Idle"); + case kgsmCallInProgress: return presentation(fmt, "kgsmCallInProgress", "Call in progress"); + case kgsmSMSInProgress: return presentation(fmt, "kgsmSMSInProgress", "SMS in progress"); + case kgsmModemError: return presentation(fmt, "kgsmModemError", "Modem error"); + case kgsmSIMCardError: return presentation(fmt, "kgsmSIMCardError", "SIM card error"); + case kgsmNetworkError: return presentation(fmt, "kgsmNetworkError", "Network error"); + case kgsmNotReady: return presentation(fmt, "kgsmNotReady", "Initializing"); + } + + throw internal_not_found(); +#endif + + /* deprecated, but still.. */ + case ksigPulsedEM: + case ksigContinuousEM: + + case ksigOpenCAS: + case ksigOpenR2: + case ksigR2Digital: + case ksigUserR2Digital: + +#if K3L_AT_LEAST(1,5,1) + case ksigOpenCCS: + case ksigPRI_EndPoint: + case ksigPRI_Network: + case ksigPRI_Passive: +#endif +#if K3L_AT_LEAST(1,5,3) + case ksigLineSide: +#endif +#if K3L_AT_LEAST(1,6,0) + case ksigCAS_EL7: + case ksigE1LC: +#endif +#if K3L_AT_LEAST(2,2,0) + case ksigISUP: + case ksigISUPPassive: +#endif + { + if (flags == kecsFree) + { + return presentation(fmt, "kecsFree", "Free"); + } + else + { + Strings::Merger strs; + + if (flags & kecsBusy) + strs.add("Busy"); + + switch (flags & 0x06) + { + case kecsOutgoing: + strs.add("Outgoing"); + break; + case kecsIncoming: + strs.add("Incoming"); + break; + case kecsLocked: + strs.add("Locked"); + default: + break; + } + + int32 value = (flags & 0xf0); + + if (kecsOutgoingLock & value) + strs.add(presentation(fmt, "OutgoingLock", "Outgoing Lock")); + + if (kecsLocalFail & value) + strs.add(presentation(fmt, "LocalFail", "Local Failure")); + + if (kecsIncomingLock & value) + strs.add(presentation(fmt, "IncomingLock", "Incoming Lock")); + + if (kecsRemoteLock & value) + strs.add(presentation(fmt, "RemoteLock", "Remote Lock")); + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("kecs{%s}") % strs.merge(",")), + strs.merge(", ")); + } + + throw internal_not_found(); + } + } + } + catch (internal_not_found & e) + { + /* we use this exception to break the control flow */ + } + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[%s, channelStatus='%d']") % signaling(sig) % flags), + STG(FMT("Unknown channel status for '%s' (%d)") % signaling(sig) % flags)); +} + +std::string Verbose::status(KLibraryStatus code, Verbose::Presentation fmt) +{ + switch (code) + { + case ksSuccess: return presentation(fmt, "ksSuccess", "Success"); + case ksFail: return presentation(fmt, "ksFail", "Failure"); + case ksTimeOut: return presentation(fmt, "ksTimeOut", "Time Out"); + case ksBusy: return presentation(fmt, "ksBusy", "Busy"); + case ksLocked: return presentation(fmt, "ksLocked", "Locked"); + case ksInvalidParams: return presentation(fmt, "ksInvalidParams", "Invalid Parameters"); + case ksEndOfFile: return presentation(fmt, "ksEndOfFile", "End of File"); + case ksInvalidState: return presentation(fmt, "ksInvalidState", "Invalid State"); + case ksServerCommFail: return presentation(fmt, "ksServerCommFail", "Communication Failure"); + case ksOverflow: return presentation(fmt, "ksOverflow", "Overflow"); + case ksUnderrun: return presentation(fmt, "ksUnderrun", "Underrun"); + +#if K3L_AT_LEAST(1,4,0) + case ksNotFound: return presentation(fmt, "ksNotFound", "Not Found"); + case ksNotAvailable: return presentation(fmt, "ksNotAvaiable", "Not Available"); +#endif + } + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KLibraryStatus='%d']") % (int)code), + STG(FMT("Unknown library status (%d)") % (int)code)); +} + +std::string Verbose::h100configIndex(KH100ConfigIndex code, Verbose::Presentation fmt) +{ + switch (code) + { + case khciDeviceMode: return presentation(fmt, "khciDeviceMode", "Device Mode"); + case khciMasterGenClock: return presentation(fmt, "khciMasterGenClock", "Master Generated Clock"); + case khciCTNetRefEnable: return presentation(fmt, "khciCTNetRefEnable", "CTBus Network Reference Enable"); + case khciSCbusEnable: return presentation(fmt, "khciSCbusEnable", "SCBus Enable"); + case khciHMVipEnable: return presentation(fmt, "khciHMVipEnable", "HMVip Enable"); + case khciMVip90Enable: return presentation(fmt, "khciMVip90Enable", "MVip90 Enable"); + case khciCTbusDataEnable: return presentation(fmt, "khciCTbusDataEnable", "CTBus Data Enable"); + case khciCTbusFreq03_00: return presentation(fmt, "khciCTbusFreq03_00", "CTBus Frequency 03 00"); // TODO: find better name + case khciCTbusFreq07_04: return presentation(fmt, "khciCTbusFreq07_04", "CTBus Frequency 07 04"); // TODO: find better name + case khciCTbusFreq11_08: return presentation(fmt, "khciCTbusFreq11_08", "CTBus Frequency 11 08"); // TODO: find better name + case khciCTbusFreq15_12: return presentation(fmt, "khciCTbusFreq15_12", "CTBus Frequency 15 12"); // TODO: find better name + case khciMax: return presentation(fmt, "khciMax", "Max"); // TODO: find better name + case khciMasterDevId: return presentation(fmt, "khciMasterDevId", "Master Device Number"); + case khciSecMasterDevId: return presentation(fmt, "khciSecMasterDevId", "Secondary Master Device Number"); + case khciCtNetrefDevId: return presentation(fmt, "khciCtNetrefDevId", "CTBus Network Reference Device Number"); +#if K3L_AT_LEAST(1,6,0) + case khciMaxH100ConfigIndex: return ""; /* do not verbose this value */ +#endif + } + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KH100ConfigIndex='%d']") % (int)code), + STG(FMT("Unknown H.100 config index (%d)") % (int)code)); +} + +#if K3L_AT_LEAST(1,6,0) +std::string Verbose::callStartInfo(KCallStartInfo code, Verbose::Presentation fmt) +{ + switch (code) + { + case kcsiHumanAnswer: return presentation(fmt, "kcsiHumanAnswer", "Human Answer"); + case kcsiAnsweringMachine: return presentation(fmt, "kcsiAnsweringMachine", "Answering Machine"); + case kcsiCellPhoneMessageBox: return presentation(fmt, "kcsiCellPhoneMessageBox", "Cell Phone Message Box"); + case kcsiCarrierMessage: return presentation(fmt, "kcsiCarrierMessage", "Carrier Message"); + case kcsiUnknown: return presentation(fmt, "kcsiUnknown", "Unknown"); + } + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KCallStartInfo='%d']") % (int)code), + STG(FMT("Unknown call answer info (%d)") % (int)code)); +} + +std::string Verbose::gsmCallCause(KGsmCallCause code, Verbose::Presentation fmt) +{ + try + { + return internal_gsmCallCause(code, fmt); + } + catch (internal_not_found & e) + { + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KGsmCallCause='%d']") % (int)code), + STG(FMT("Unknown GSM call cause (%d)") % (int)code)); + } +} + +std::string Verbose::internal_gsmCallCause(KGsmCallCause code, Verbose::Presentation fmt) +{ + switch (code) + { + case kgccNone: return presentation(fmt, "kgccNone", "None"); + case kgccUnallocatedNumber: return presentation(fmt, "kgccUnallocatedNumber", "Unallocated number"); + case kgccNoRouteToDest: return presentation(fmt, "kgccNoRouteToDest", "No route to destination"); + case kgccChannelUnacceptable: return presentation(fmt, "kgccChannelUnacceptable", "Channel unacceptable"); + case kgccOperatorDeterminedBarring: return presentation(fmt, "kgccOperatorDeterminedBarring", "Operator determined barring"); + case kgccNormalCallClear: return presentation(fmt, "kgccNormalCallClear", "Normal call clear"); + case kgccUserBusy: return presentation(fmt, "kgccUserBusy", "User busy"); + case kgccNoUserResponding: return presentation(fmt, "kgccNoUserResponding", "No user responding"); + case kgccNoAnswerFromUser: return presentation(fmt, "kgccNoAnswerFromUser", "No answer from user"); + case kgccCallRejected: return presentation(fmt, "kgccCallRejected", "Call rejected"); + case kgccNumberChanged: return presentation(fmt, "kgccNumberChanged", "Number changed"); + case kgccNonSelectedUserClear: return presentation(fmt, "kgccNonSelectedUserClear", "Non Selected user clear"); + case kgccDestinationOutOfOrder: return presentation(fmt, "kgccDestinationOutOfOrder", "Destination out of order"); + case kgccInvalidNumberFormat: return presentation(fmt, "kgccInvalidNumberFormat", "Invalid number format"); + case kgccFacilityRejected: return presentation(fmt, "kgccFacilityRejected", "Facility rejected"); + case kgccRespStatusEnquiry: return presentation(fmt, "kgccRespStatusEnquiry", "Response status enquiry"); + case kgccNormalUnspecified: return presentation(fmt, "kgccNormalUnspecified", "Normal, unspecified"); + case kgccNoCircuitChannelAvail: return presentation(fmt, "kgccNoCircuitChannelAvail", "No circuit channel available"); + case kgccNetworkOutOfOrder: return presentation(fmt, "kgccNetworkOutOfOrder", "Network out of order"); + case kgccTemporaryFailure: return presentation(fmt, "kgccTemporaryFailure", "Temporary failure"); + case kgccSwitchCongestion: return presentation(fmt, "kgccSwitchCongestion", "Switch congestion"); + case kgccAccessInfoDiscarded: return presentation(fmt, "kgccAccessInfoDiscarded", "Access information discarded"); + case kgccRequestedChannelUnav: return presentation(fmt, "kgccRequestedChannelUnav", "Requested channel unavailable"); + case kgccResourceUnavailable: return presentation(fmt, "kgccResourceUnavailable", "Resource unavailable"); + case kgccQosUnavailable: return presentation(fmt, "kgccQosUnavailable", "QoS unavailable"); + case kgccReqFacilityNotSubsc: return presentation(fmt, "kgccReqFacilityNotSubsc", "Request facility not subscribed"); + case kgccCallBarredWitchCUG: return presentation(fmt, "kgccCallBarredWitchCUG", "Call barred with UG"); + case kgccBearerCapabNotAuthor: return presentation(fmt, "kgccBearerCapabNotAuthor", "Bearer capability not authorized"); + case kgccBearerCapabNotAvail: return presentation(fmt, "kgccBearerCapabNotAvail", "Bearer capability not available"); + case kgccServiceNotAvailable: return presentation(fmt, "kgccServiceNotAvailable", "Service not available"); + case kgccBcNotImplemented: return presentation(fmt, "kgccBcNotImplemented", "Bearer capability not implemented"); + case kgccReqFacilityNotImplem: return presentation(fmt, "kgccReqFacilityNotImplem", "Request facility not implemented"); + case kgccOnlyRestrictedBcAvail: return presentation(fmt, "kgccOnlyRestrictedBcAvail", "Only restricted bearer capability available"); + case kgccServiceNotImplemented: return presentation(fmt, "kgccServiceNotImplemented", "Service not implemented"); + case kgccInvalidCrv: return presentation(fmt, "kgccInvalidCrv", "Invalid call reference value"); + case kgccUserNotMemberOfCUG: return presentation(fmt, "kgccUserNotMemberOfCUG", "User not member of UG"); + case kgccIncompatibleDestination: return presentation(fmt, "kgccIncompatibleDestination", "Incompatible destination"); + case kgccInvalidTransitNetSel: return presentation(fmt, "kgccInvalidTransitNetSel", "Invalid transit network selected"); + case kgccInvalidMessage: return presentation(fmt, "kgccInvalidMessage", "Invalid message"); + case kgccMissingMandatoryIe: return presentation(fmt, "kgccMissingMandatoryIe", "Missing mandatory information element"); + case kgccMsgTypeNotImplemented: return presentation(fmt, "kgccMsgTypeNotImplemented", "Message type not implemented"); + case kgccMsgIncompatWithState: return presentation(fmt, "kgccMsgIncompatWithState", "Message incompatible with state"); + case kgccIeNotImplemented: return presentation(fmt, "kgccIeNotImplemented", "Information element not implemented"); + case kgccInvalidIe: return presentation(fmt, "kgccInvalidIe", "Invalid information element"); + case kgccMsgIncompatWithState2: return presentation(fmt, "kgccMsgIncompatWithState2", "Message incompatible with state (2)"); + case kgccRecoveryOnTimerExpiry: return presentation(fmt, "kgccRecoveryOnTimerExpiry", "Recovery on timer expiry"); + case kgccProtocolError: return presentation(fmt, "kgccProtocolError", "Protocol error"); + case kgccInterworking: return presentation(fmt, "kgccInterworking", "Interworking"); + } + + throw internal_not_found(); +} + +std::string Verbose::gsmMobileCause(KGsmMobileCause code, Verbose::Presentation fmt) +{ + try + { + return internal_gsmMobileCause(code, fmt); + } + catch (internal_not_found & e) + { + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KGsmMobileCause='%d']") % (int)code), + STG(FMT("Unknown GSM mobile cause (%d)") % (int)code)); + } +} + +std::string Verbose::internal_gsmMobileCause(KGsmMobileCause code, Verbose::Presentation fmt) +{ + switch (code) + { + case kgmcPhoneFailure: return presentation(fmt, "kgmcPhoneFailure", "Phone failure"); + case kgmcNoConnectionToPhone: return presentation(fmt, "kgmcNoConnectionToPhone", "No connection to phone"); + case kgmcPhoneAdaptorLinkReserved: return presentation(fmt, "kgmcPhoneAdaptorLinkReserved", "Phone adaptor link reserved"); +#if 0 /* this changed during K3L 1.6.0 development cycle... */ + case kgmcCoperationNotAllowed: return presentation(fmt, "kgmcCoperationNotAllowed", ""); + case kgmcCoperationNotSupported: return presentation(fmt, "kgmcCoperationNotSupported", ""); +#else + case kgmcOperationNotAllowed: return presentation(fmt, "kgmcOperationNotAllowed", "Operation not allowed"); + case kgmcOperationNotSupported: return presentation(fmt, "kgmcOperationNotSupported", "Operation not supported"); +#endif + case kgmcPH_SIMPINRequired: return presentation(fmt, "kgmcPH_SIMPINRequired", "Phone SIM PIN required"); + case kgmcPH_FSIMPINRequired: return presentation(fmt, "kgmcPH_FSIMPINRequired", "Phone FSIM PIN required"); + case kgmcPH_FSIMPUKRequired: return presentation(fmt, "kgmcPH_FSIMPUKRequired", "Phone FSIM PUK required"); + case kgmcSIMNotInserted: return presentation(fmt, "kgmcSIMNotInserted", "SIM not inserted"); + case kgmcSIMPINRequired: return presentation(fmt, "kgmcSIMPINRequired", "SIM PIN required"); + case kgmcSIMPUKRequired: return presentation(fmt, "kgmcSIMPUKRequired", "SIM PUK required"); + case kgmcSIMFailure: return presentation(fmt, "kgmcSIMFailure", "SIM failure"); + case kgmcSIMBusy: return presentation(fmt, "kgmcSIMBusy", "SIM busy"); + case kgmcSIMWrong: return presentation(fmt, "kgmcSIMWrong", "SIM wrong"); + case kgmcIncorrectPassword: return presentation(fmt, "kgmcIncorrectPassword", "Incorrect password"); + case kgmcSIMPIN2Required: return presentation(fmt, "kgmcSIMPIN2Required", "SIM PIN2 required"); + case kgmcSIMPUK2Required: return presentation(fmt, "kgmcSIMPUK2Required", "SIM PUK2 required"); + case kgmcMemoryFull: return presentation(fmt, "kgmcMemoryFull", "Memory full"); + case kgmcInvalidIndex: return presentation(fmt, "kgmcInvalidIndex", "Invalid index"); + case kgmcNotFound: return presentation(fmt, "kgmcNotFound", "Not found"); + case kgmcMemoryFailure: return presentation(fmt, "kgmcMemoryFailure", "Memory failure"); + case kgmcTextStringTooLong: return presentation(fmt, "kgmcTextStringTooLong", "Text string too long"); + case kgmcInvalidCharInTextString: return presentation(fmt, "kgmcInvalidCharInTextString", "Invalid character in text string"); + case kgmcDialStringTooLong: return presentation(fmt, "kgmcDialStringTooLong", "Dial string too long"); + case kgmcInvalidCharInDialString: return presentation(fmt, "kgmcInvalidCharInDialString", "Invalid character in dial string"); + case kgmcNoNetworkService: return presentation(fmt, "kgmcNoNetworkService", "No network service"); + case kgmcNetworkTimeout: return presentation(fmt, "kgmcNetworkTimeout", "Network timeout"); + case kgmcNetworkNotAllowed: return presentation(fmt, "kgmcNetworkNotAllowed", "Network not allowed"); + case kgmcCommandAborted: return presentation(fmt, "kgmcCommandAborted", "Command aborted"); + case kgmcNumParamInsteadTextParam: return presentation(fmt, "kgmcNumParamInsteadTextParam", "Number parameter instead of text parameter"); + case kgmcTextParamInsteadNumParam: return presentation(fmt, "kgmcTextParamInsteadNumParam", "Text parameter instead of number parameter"); + case kgmcNumericParamOutOfBounds: return presentation(fmt, "kgmcNumericParamOutOfBounds", "Numeric parameter out of bounds"); + case kgmcTextStringTooShort: return presentation(fmt, "kgmcTextStringTooShort", "Text string too short"); + case kgmcNetworkPINRequired: return presentation(fmt, "kgmcNetworkPINRequired", "Network PIN required"); + case kgmcNetworkPUKRequired: return presentation(fmt, "kgmcNetworkPUKRequired", "Network PUK required"); + case kgmcNetworkSubsetPINRequired: return presentation(fmt, "kgmcNetworkSubsetPINRequired", "Network subset PIN required"); + case kgmcNetworkSubnetPUKRequired: return presentation(fmt, "kgmcNetworkSubnetPUKRequired", "Network subset PUK required"); + case kgmcServiceProviderPINRequired: return presentation(fmt, "kgmcServiceProviderPINRequired", "Network service provider PIN required"); + case kgmcServiceProviderPUKRequired: return presentation(fmt, "kgmcServiceProviderPUKRequired", "Network service provider PUK required"); + case kgmcCorporatePINRequired: return presentation(fmt, "kgmcCorporatePINRequired", "Corporate PIN required"); + case kgmcCorporatePUKRequired: return presentation(fmt, "kgmcCorporatePUKRequired", "Corporate PUK required"); + case kgmcSIMServiceOptNotSupported: return presentation(fmt, "kgmcSIMServiceOptNotSupported", "SIM Service option not supported"); + case kgmcUnknown: return presentation(fmt, "kgmcUnknown", "Unknown"); + case kgmcIllegalMS_N3: return presentation(fmt, "kgmcIllegalMS_N3", "Illegal MS #3"); + case kgmcIllegalME_N6: return presentation(fmt, "kgmcIllegalME_N6", "Illegal MS #6"); + case kgmcGPRSServicesNotAllowed_N7: return presentation(fmt, "kgmcGPRSServicesNotAllowed_N7", "GPRS service not allowed #7"); + case kgmcPLMNNotAllowed_No11: return presentation(fmt, "kgmcPLMNNotAllowed_No11", "PLMN not allowed #11"); + case kgmcLocationAreaNotAllowed_N12: return presentation(fmt, "kgmcLocationAreaNotAllowed_N12", "Location area not allowed #12"); + case kgmcRoamingNotAllowed_N13: return presentation(fmt, "kgmcRoamingNotAllowed_N13", "Roaming not allowed #13"); + case kgmcServiceOptNotSupported_N32: return presentation(fmt, "kgmcServiceOptNotSupported_N32", "Service option not supported #32"); + case kgmcReqServOptNotSubscribed_N33: return presentation(fmt, "kgmcReqServOptNotSubscribed_N33", "Registration service option not subscribed #33"); + case kgmcServOptTempOutOfOrder_N34: return presentation(fmt, "kgmcServOptTempOutOfOrder_N34", "Service option temporary out of order #34"); + case kgmcLongContextActivation: return presentation(fmt, "kgmcLongContextActivation", "Long context activation"); + case kgmcUnspecifiedGPRSError: return presentation(fmt, "kgmcUnspecifiedGPRSError", "Unspecified GPRS error"); + case kgmcPDPAuthenticationFailure: return presentation(fmt, "kgmcPDPAuthenticationFailure", "PDP authentication failure"); + case kgmcInvalidMobileClass: return presentation(fmt, "kgmcInvalidMobileClass", "Invalid mobile class"); + case kgmcGPRSDisconnectionTmrActive: return presentation(fmt, "kgmcGPRSDisconnectionTmrActive", "GPRS disconnection TMR active"); + case kgmcTooManyActiveCalls: return presentation(fmt, "kgmcTooManyActiveCalls", "Too many active calls"); + case kgmcCallRejected: return presentation(fmt, "kgmcCallRejected", "Call rejected"); + case kgmcUnansweredCallPending: return presentation(fmt, "kgmcUnansweredCallPending", "Unanswered call pending"); + case kgmcUnknownCallingError: return presentation(fmt, "kgmcUnknownCallingError", "Unknown calling error"); + case kgmcNoPhoneNumRecognized: return presentation(fmt, "kgmcNoPhoneNumRecognized", "No phone number recognized"); + case kgmcCallStateNotIdle: return presentation(fmt, "kgmcCallStateNotIdle", "Call state not idle"); + case kgmcCallInProgress: return presentation(fmt, "kgmcCallInProgress", "Call in progress"); + case kgmcDialStateError: return presentation(fmt, "kgmcDialStateError", "Dial state error"); + case kgmcUnlockCodeRequired: return presentation(fmt, "kgmcUnlockCodeRequired", "Unlock code required"); + case kgmcNetworkBusy: return presentation(fmt, "kgmcNetworkBusy", "Network busy"); + case kgmcInvalidPhoneNumber: return presentation(fmt, "kgmcInvalidPhoneNumber", "Invalid phone number"); + case kgmcNumberEntryAlreadyStarted: return presentation(fmt, "kgmcNumberEntryAlreadyStarted", "Number entry already started"); + case kgmcCancelledByUser: return presentation(fmt, "kgmcCancelledByUser", "Cancelled by user"); + case kgmcNumEntryCouldNotBeStarted: return presentation(fmt, "kgmcNumEntryCouldNotBeStarted", "Number entry could not be started"); + case kgmcDataLost: return presentation(fmt, "kgmcDataLost", "Data lost"); + case kgmcInvalidBessageBodyLength: return presentation(fmt, "kgmcInvalidBessageBodyLength", "Invalid message body length"); + case kgmcInactiveSocket: return presentation(fmt, "kgmcInactiveSocket", "Inactive socket"); + case kgmcSocketAlreadyOpen: return presentation(fmt, "kgmcSocketAlreadyOpen", "Socket already open"); +#if K3L_AT_LEAST(2,1,0) + case kgmcSuccess: return presentation(fmt, "kgmcSuccess", "Success"); +#endif + } + + throw internal_not_found(); +} + +std::string Verbose::gsmSmsCause(KGsmSmsCause code, Verbose::Presentation fmt) +{ + try + { + return internal_gsmSmsCause(code, fmt); + } + catch (internal_not_found & e) + { + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KGsmSmsCause='%d']") % (int)code), + STG(FMT("Unknown GSM SMS cause (%d)") % (int)code)); + } +} + +std::string Verbose::internal_gsmSmsCause(KGsmSmsCause code, Verbose::Presentation fmt) +{ + switch (code) + { +#if K3L_AT_LEAST(2,1,0) + case kgscNone: return presentation(fmt, "kgscNone", "None"); +#endif + case kgscUnassigned: return presentation(fmt, "kgscUnassigned", "Unassigned number"); + case kgscOperatorDeterminedBarring: return presentation(fmt, "kgscOperatorDeterminedBarring", "Operator determined barring"); + case kgscCallBarred: return presentation(fmt, "kgscCallBarred", "Call barred"); + case kgscSMSTransferRejected: return presentation(fmt, "kgscSMSTransferRejected", "SMS transfer rejected"); + case kgscDestinationOutOfService: return presentation(fmt, "kgscDestinationOutOfService", "Destination out of service"); + case kgscUnidentifiedSubscriber: return presentation(fmt, "kgscUnidentifiedSubscriber", "Unidentified subscriber"); + case kgscFacilityRejected: return presentation(fmt, "kgscFacilityRejected", "Facility rejected"); + case kgscUnknownSubscriber: return presentation(fmt, "kgscUnknownSubscriber", "Unknown subscriber"); + case kgscNetworkOutOfOrder: return presentation(fmt, "kgscNetworkOutOfOrder", "Network out of order"); + case kgscTemporaryFailure: return presentation(fmt, "kgscTemporaryFailure", "Temporary failure"); + case kgscCongestion: return presentation(fmt, "kgscCongestion", "Congestion"); + case kgscResourcesUnavailable: return presentation(fmt, "kgscResourcesUnavailable", "Resources unavailable"); + case kgscFacilityNotSubscribed: return presentation(fmt, "kgscFacilityNotSubscribed", "Facility not subscribed"); + case kgscFacilityNotImplemented: return presentation(fmt, "kgscFacilityNotImplemented", "Facility not implemented"); + case kgscInvalidSMSTransferRefValue: return presentation(fmt, "kgscInvalidSMSTransferRefValue", "Invalid SMS transfer reference value"); + case kgscInvalidMessage: return presentation(fmt, "kgscInvalidMessage", "Invalid message"); + case kgscInvalidMandatoryInformation: return presentation(fmt, "kgscInvalidMandatoryInformation", "Invalid mandatory information"); + case kgscMessageTypeNonExistent: return presentation(fmt, "kgscMessageTypeNonExistent", "Message type non existent"); + case kgscMsgNotCompatWithSMProtState: return presentation(fmt, "kgscMsgNotCompatWithSMProtState", "Message not compatible with SMS protection state"); + case kgscInformationElementNonExiste: return presentation(fmt, "kgscInformationElementNonExiste", "Information element non existent"); + case kgscProtocolError: return presentation(fmt, "kgscProtocolError", "Protocol error"); + case kgscInterworking: return presentation(fmt, "kgscInterworking", "Interworking"); + case kgscTelematicInterworkingNotSup: return presentation(fmt, "kgscTelematicInterworkingNotSup", "Telematic interworking not supported"); + case kgscSMSTypeZeroNotSupported: return presentation(fmt, "kgscSMSTypeZeroNotSupported", "SMS type zero not supported"); + case kgscCannotReplaceSMS: return presentation(fmt, "kgscCannotReplaceSMS", "Cannot replace SMS"); + case kgscUnspecifiedTPPIDError: return presentation(fmt, "kgscUnspecifiedTPPIDError", "Unspecified TPPID error"); + case kgscAlphabetNotSupported: return presentation(fmt, "kgscAlphabetNotSupported", "Alphabet not supported"); + case kgscMessageClassNotSupported: return presentation(fmt, "kgscMessageClassNotSupported", "Message class not supported"); + case kgscUnspecifiedTPDCSError: return presentation(fmt, "kgscUnspecifiedTPDCSError", "Unspecified TPDCS error"); + case kgscCommandCannotBeActioned: return presentation(fmt, "kgscCommandCannotBeActioned", "Command cannot be actioned"); + case kgscCommandUnsupported: return presentation(fmt, "kgscCommandUnsupported", "Command unsupported"); + case kgscUnspecifiedTPCommandError: return presentation(fmt, "kgscUnspecifiedTPCommandError", "Unspecified TP command error"); + case kgscTPDUNotSupported: return presentation(fmt, "kgscTPDUNotSupported", "TPDU not supported"); + case kgscSCBusy: return presentation(fmt, "kgscSCBusy", "SC busy"); + case kgscNoSCSubscription: return presentation(fmt, "kgscNoSCSubscription", "No SC subscription"); + case kgscSCSystemFailure: return presentation(fmt, "kgscSCSystemFailure", "SC system failure"); + case kgscInvalidSMEAddress: return presentation(fmt, "kgscInvalidSMEAddress", "Invalid SME address"); + case kgscDestinationSMEBarred: return presentation(fmt, "kgscDestinationSMEBarred", "Destination SME barred"); + case kgscSMRejectedDuplicateSM: return presentation(fmt, "kgscSMRejectedDuplicateSM", "SM rejected duplicate SM"); + case kgscTPVPFNotSupported: return presentation(fmt, "kgscTPVPFNotSupported", "TPVPF not supported"); + case kgscTPVPNotSupported: return presentation(fmt, "kgscTPVPNotSupported", "TPVP not supported"); + case kgscSIMSMSStorageFull: return presentation(fmt, "kgscSIMSMSStorageFull", "SIM SMS storage full"); + case kgscNoSMSStorageCapabilityInSIM: return presentation(fmt, "kgscNoSMSStorageCapabilityInSIM", "No SMS storage capability in SIM"); + case kgscErrorInMS: return presentation(fmt, "kgscErrorInMS", "Error in SMS"); + case kgscMemoryCapacityExceeded: return presentation(fmt, "kgscMemoryCapacityExceeded", "Memory capatity exceeded"); + case kgscSIMDataDownloadError: return presentation(fmt, "kgscSIMDataDownloadError", "SIM data download error"); + case kgscUnspecifiedError: return presentation(fmt, "kgscUnspecifiedError", "Unspecified error"); + case kgscPhoneFailure: return presentation(fmt, "kgscPhoneFailure", "Phone failure"); + case kgscSmsServiceReserved: return presentation(fmt, "kgscSmsServiceReserved", "SMS service reserved"); + case kgscOperationNotAllowed: return presentation(fmt, "kgscOperationNotAllowed", "Operation not allowed"); + case kgscOperationNotSupported: return presentation(fmt, "kgscOperationNotSupported", "Operation not supported"); + case kgscInvalidPDUModeParameter: return presentation(fmt, "kgscInvalidPDUModeParameter", "Invalid PDU mode parameter"); + case kgscInvalidTextModeParameter: return presentation(fmt, "kgscInvalidTextModeParameter", "Invalid text mode parameter"); + case kgscSIMNotInserted: return presentation(fmt, "kgscSIMNotInserted", "SIM not inserted"); + case kgscSIMPINNecessary: return presentation(fmt, "kgscSIMPINNecessary", "SIM PIN necessary"); + case kgscPH_SIMPINNecessary: return presentation(fmt, "kgscPH_SIMPINNecessary", "Phone SIM PIN necessary"); + case kgscSIMFailure: return presentation(fmt, "kgscSIMFailure", "SIM failure"); + case kgscSIMBusy: return presentation(fmt, "kgscSIMBusy", "SIM busy"); + case kgscSIMWrong: return presentation(fmt, "kgscSIMWrong", "SIM wrong"); + case kgscMemoryFailure: return presentation(fmt, "kgscMemoryFailure", "Memory failure"); + case kgscInvalidMemoryIndex: return presentation(fmt, "kgscInvalidMemoryIndex", "Invalid memory index"); + case kgscMemoryFull: return presentation(fmt, "kgscMemoryFull", "Memory full"); + case kgscSMSCAddressUnknown: return presentation(fmt, "kgscSMSCAddressUnknown", "SMSC address unknown"); + case kgscNoNetworkService: return presentation(fmt, "kgscNoNetworkService", "No network service"); + case kgscNetworkTimeout: return presentation(fmt, "kgscNetworkTimeout", "Network timeout"); + case kgscUnknownError: return presentation(fmt, "kgscUnknownError", "Unknown error"); + case kgscNetworkBusy: return presentation(fmt, "kgscNetworkBusy", "Network busy"); + case kgscInvalidDestinationAddress: return presentation(fmt, "kgscInvalidDestinationAddress", "Invalid destination address"); + case kgscInvalidMessageBodyLength: return presentation(fmt, "kgscInvalidMessageBodyLength", "Invalid message body length"); + case kgscPhoneIsNotInService: return presentation(fmt, "kgscPhoneIsNotInService", "Phone is not in service"); + case kgscInvalidPreferredMemStorage: return presentation(fmt, "kgscInvalidPreferredMemStorage", "Invalid preferred memory storage"); + case kgscUserTerminated: return presentation(fmt, "kgscUserTerminated", "User terminated"); + } + + throw internal_not_found(); +} + +std::string Verbose::q931ProgressIndication(KQ931ProgressIndication code, Verbose::Presentation fmt) +{ + try + { + return internal_q931ProgressIndication(code); + } + catch (internal_not_found & e) + { + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KQ931ProgressIndication='%d']") % (int)code), + STG(FMT("Unknown Q931 progress indication (%d)") % (int)code)); + } +} + +std::string Verbose::internal_q931ProgressIndication(KQ931ProgressIndication code, Verbose::Presentation fmt) +{ + switch (code) + { + case kq931pTonesMaybeAvailable: return presentation(fmt, "kq931pTonesMaybeAvailable", "Tones may be available"); + case kq931pDestinationIsNonIsdn: return presentation(fmt, "kq931pDestinationIsNonIsdn", "Destination is not ISDN"); + case kq931pOriginationIsNonIsdn: return presentation(fmt, "kq931pOriginationIsNonIsdn", "Origination is not ISDN"); + case kq931pCallReturnedToIsdn: return presentation(fmt, "kq931pCallReturnedToIsdn", "Call returned to ISDN"); + case kq931pTonesAvailable: return presentation(fmt, "kq931pTonesAvailable", "Tones available"); + } + + throw internal_not_found(); +} + +#endif /* K3L_AT_LEAST(1,6,0) */ + + + + +#if K3L_AT_LEAST(2,1,0) +std::string Verbose::faxResult(KFaxResult code, Verbose::Presentation fmt) +{ + switch (code) + { + case kfaxrEndOfTransmission: return presentation(fmt, "kfaxrEndOfTransmission", "EndOfTransmission"); + case kfaxrStoppedByCommand: return presentation(fmt, "kfaxrStoppedByCommand", "StoppedByCommand"); + case kfaxrProtocolTimeout: return presentation(fmt, "kfaxrProtocolTimeout", "ProtocolTimeout"); + case kfaxrProtocolError: return presentation(fmt, "kfaxrProtocolError", "ProtocolError"); + case kfaxrRemoteDisconnection: return presentation(fmt, "kfaxrRemoteDisconnection", "RemoteDisconnection"); + case kfaxrFileError: return presentation(fmt, "kfaxrFileError", "FileError"); + case kfaxrUnknown: return presentation(fmt, "kfaxrUnknown", "Unknown"); + case kfaxrEndOfReception: return presentation(fmt, "kfaxrEndOfReception", "EndOfReception"); + case kfaxrCompatibilityError: return presentation(fmt, "kfaxrCompatibilityError", "CompatibilityError"); + case kfaxrQualityError: return presentation(fmt, "kfaxrQualityError", "QualityError"); + } + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KFaxResult='%d']") % (int)code), + STG(FMT("Unknown fax result (%d)") % (int)code)); +} + +std::string Verbose::faxFileErrorCause(KFaxFileErrorCause code, Verbose::Presentation fmt) +{ + switch (code) + { + case kfaxfecTransmissionStopped: return presentation(fmt, "kfaxfecTransmissionStopped", "TransmissionStopped"); + case kfaxfecTransmissionError: return presentation(fmt, "kfaxfecTransmissionError", "TransmissionError"); + case kfaxfecListCleared: return presentation(fmt, "kfaxfecListCleared", "ListCleared"); + case kfaxfecCouldNotOpen: return presentation(fmt, "kfaxfecCouldNotOpen", "CouldNotOpen"); + case kfaxfecInvalidHeader: return presentation(fmt, "kfaxfecInvalidHeader", "InvalidHeader"); + case kfaxfecDataNotFound: return presentation(fmt, "kfaxfecDataNotFound", "DataNotFound"); + case kfaxfecInvalidHeight: return presentation(fmt, "kfaxfecInvalidHeight", "InvalidHeight"); + case kfaxfecUnsupportedWidth: return presentation(fmt, "kfaxfecUnsupportedWidth", "UnsupportedWidth"); + case kfaxfecUnsupportedCompression: return presentation(fmt, "kfaxfecUnsupportedCompression", "UnsupportedCompression"); + case kfaxfecUnsupportedRowsPerStrip: return presentation(fmt, "kfaxfecUnsupportedRowsPerStrip", "UnsupportedRowsPerStrip"); + case kfaxfecUnknown: return presentation(fmt, "kfaxfecUnknown", "Unknown"); + } + + PRESENTATION_CHECK_RETURN(fmt, + STG(FMT("[KFaxFileErrorCause='%d']") % (int)code), + STG(FMT("Unknown fax file error cause (%d)") % (int)code)); +} + +#endif + + +/********/ + +std::string Verbose::commandName(int32 code) +{ + switch ((kcommand)code) + { + case K_CM_SEIZE: return "CM_SEIZE"; + case K_CM_SYNC_SEIZE: return "CM_SYNC_SEIZE"; + case K_CM_DIAL_DTMF: return "CM_DIAL_DTMF"; +#if K3L_AT_LEAST(1,6,0) + case K_CM_SIP_REGISTER: return "CM_SIP_REGISTER"; +#endif + case K_CM_DISCONNECT: return "CM_DISCONNECT"; + case K_CM_CONNECT: return "CM_CONNECT"; + case K_CM_PRE_CONNECT: return "CM_PRE_CONNECT"; + case K_CM_CAS_CHANGE_LINE_STT: return "CM_CAS_CHANGE_LINE_STT"; + case K_CM_CAS_SEND_MFC: return "CM_CAS_SEND_MFC"; + case K_CM_SET_FORWARD_CHANNEL: return "CM_SET_FORWARD_CHANNEL"; + case K_CM_CAS_SET_MFC_DETECT_MODE: return "CM_CAS_SET_MFC_DETECT_MODE"; + case K_CM_DROP_COLLECT_CALL: return "CM_DROP_COLLECT_CALL"; + +#if K3L_AT_LEAST(1,5,0) + case K_CM_MAKE_CALL: return "CM_MAKE_CALL"; +#endif + +#if K3L_AT_LEAST(1,4,0) + case K_CM_RINGBACK: return "CM_RINGBACK"; +#endif + +#if K3L_AT_LEAST(1,5,1) + case K_CM_USER_INFORMATION: return "CM_USER_INFORMATION"; +#endif + +#if K3L_AT_LEAST(1,4,0) && !K3L_AT_LEAST(2,2,0) + case K_CM_VOIP_SEIZE: return "CM_VOIP_SEIZE"; + +#if !K3L_AT_LEAST(2,0,0) + /* internal commands */ + case K_CM_VOIP_START_DEBUG: return "CM_VOIP_START_DEBUG"; + case K_CM_VOIP_STOP_DEBUG: return "CM_VOIP_STOP_DEBUG"; + case K_CM_VOIP_DUMP_STAT: return "CM_VOIP_DUMP_STAT"; +#endif +#endif + +#if K3L_AT_LEAST(1,5,2) && !K3L_AT_LEAST(2,0,0) + /* internal command */ + case K_CM_ISDN_DEBUG: return "CM_ISDN_DEBUG"; +#endif + + case K_CM_LOCK_INCOMING: return "CM_LOCK_INCOMING"; + case K_CM_UNLOCK_INCOMING: return "CM_UNLOCK_INCOMING"; + case K_CM_LOCK_OUTGOING: return "CM_LOCK_OUTGOING"; + case K_CM_UNLOCK_OUTGOING: return "CM_UNLOCK_OUTGOING"; + + case K_CM_START_SEND_FAIL: return "CM_START_SEND_FAIL"; + case K_CM_STOP_SEND_FAIL: return "CM_STOP_SEND_FAIL"; + +#if K3L_AT_LEAST(1,5,3) + case K_CM_END_OF_NUMBER: return "CM_END_OF_NUMBER"; +#endif + +#if K3L_AT_LEAST(1,6,0) + case K_CM_SS_TRANSFER: return "CM_SS_TRANSFER"; + case K_CM_GET_SMS: return "CM_GET_SMS"; + case K_CM_PREPARE_SMS: return "CM_PREPARE_SMS"; + case K_CM_SEND_SMS: return "CM_SEND_SMS"; +#endif +#if K3L_HAS_MPTY_SUPPORT + case K_CM_HOLD_SWITCH: return "CM_HOLD_SWITCH"; + case K_CM_MPTY_CONF: return "CM_MPTY_CONF"; + case K_CM_MPTY_SPLIT: return "CM_MPTY_SPLIT"; +#endif + + case K_CM_ENABLE_DTMF_SUPPRESSION: return "CM_ENABLE_DTMF_SUPPRESSION"; + case K_CM_DISABLE_DTMF_SUPPRESSION: return "CM_DISABLE_DTMF_SUPPRESSION"; + case K_CM_ENABLE_AUDIO_EVENTS: return "CM_ENABLE_AUDIO_EVENTS"; + case K_CM_DISABLE_AUDIO_EVENTS: return "CM_DISABLE_AUDIO_EVENTS"; + case K_CM_ENABLE_CALL_PROGRESS: return "CM_ENABLE_CALL_PROGRESS"; + case K_CM_DISABLE_CALL_PROGRESS: return "CM_DISABLE_CALL_PROGRESS"; + case K_CM_FLASH: return "CM_FLASH"; + case K_CM_ENABLE_PULSE_DETECTION: return "CM_ENABLE_PULSE_DETECTION"; + case K_CM_DISABLE_PULSE_DETECTION: return "CM_DISABLE_PULSE_DETECTION"; + case K_CM_ENABLE_ECHO_CANCELLER: return "CM_ENABLE_ECHO_CANCELLER"; + case K_CM_DISABLE_ECHO_CANCELLER: return "CM_DISABLE_ECHO_CANCELLER"; + case K_CM_ENABLE_AGC: return "CM_ENABLE_AGC"; + case K_CM_DISABLE_AGC: return "CM_DISABLE_AGC"; + case K_CM_ENABLE_HIGH_IMP_EVENTS: return "CM_ENABLE_HIGH_IMP_EVENTS"; + case K_CM_DISABLE_HIGH_IMP_EVENTS: return "CM_DISABLE_HIGH_IMP_EVENTS"; + +#if K3L_AT_LEAST(1,6,0) + case K_CM_ENABLE_CALL_ANSWER_INFO: return "CM_ENABLE_CALL_ANSWER_INFO"; + case K_CM_DISABLE_CALL_ANSWER_INFO: return "CM_DISABLE_CALL_ANSWER_INFO"; +#endif + + case K_CM_RESET_LINK: return "CM_RESET_LINK"; + +#if K3L_AT_LEAST(1,6,0) + case K_CM_CLEAR_LINK_ERROR_COUNTER: return "CM_CLEAR_LINK_ERROR_COUNTER"; +#endif + + case K_CM_SEND_DTMF: return "CM_SEND_DTMF"; + case K_CM_STOP_AUDIO: return "CM_STOP_AUDIO"; + case K_CM_HARD_RESET: return "CM_HARD_RESET"; + + case K_CM_SEND_TO_CTBUS: return "CM_SEND_TO_CTBUS"; + case K_CM_RECV_FROM_CTBUS: return "CM_RECV_FROM_CTBUS"; + case K_CM_SETUP_H100: return "CM_SETUP_H100"; + + case K_CM_MIXER: return "CM_MIXER"; + case K_CM_CLEAR_MIXER: return "CM_CLEAR_MIXER"; + case K_CM_PLAY_FROM_FILE: return "CM_PLAY_FROM_FILE"; + case K_CM_RECORD_TO_FILE: return "CM_RECORD_TO_FILE"; + case K_CM_PLAY_FROM_STREAM: return "CM_PLAY_FROM_STREAM"; + case K_CM_STOP_PLAY: return "CM_STOP_PLAY"; + case K_CM_STOP_RECORD: return "CM_STOP_RECORD"; + case K_CM_PAUSE_PLAY: return "CM_PAUSE_PLAY"; + case K_CM_PAUSE_RECORD: return "CM_PAUSE_RECORD"; + case K_CM_INCREASE_VOLUME: return "CM_INCREASE_VOLUME"; + case K_CM_DECREASE_VOLUME: return "CM_DECREASE_VOLUME"; + case K_CM_LISTEN: return "CM_LISTEN"; + case K_CM_STOP_LISTEN: return "CM_STOP_LISTEN"; + case K_CM_PREPARE_FOR_LISTEN: return "CM_PREPARE_FOR_LISTEN"; + + case K_CM_PLAY_SOUND_CARD: return "CM_PLAY_SOUND_CARD"; + case K_CM_STOP_SOUND_CARD: return "CM_STOP_SOUND_CARD"; + + case K_CM_MIXER_CTBUS: return "CM_MIXER_CTBUS"; + case K_CM_PLAY_FROM_STREAM_EX: return "CM_PLAY_FROM_STREAM_EX"; + case K_CM_ENABLE_PLAYER_AGC: return "CM_ENABLE_PLAYER_AGC"; + case K_CM_DISABLE_PLAYER_AGC: return "CM_DISABLE_PLAYER_AGC"; + case K_CM_START_STREAM_BUFFER: return "CM_START_STREAM_BUFFER"; + case K_CM_ADD_STREAM_BUFFER: return "CM_ADD_STREAM_BUFFER"; + case K_CM_STOP_STREAM_BUFFER: return "CM_STOP_STREAM_BUFFER"; + case K_CM_SEND_BEEP: return "CM_SEND_BEEP"; + case K_CM_SEND_BEEP_CONF: return "CM_SEND_BEEP_CONF"; + case K_CM_ADD_TO_CONF: return "CM_ADD_TO_CONF"; + case K_CM_REMOVE_FROM_CONF: return "CM_REMOVE_FROM_CONF"; + case K_CM_RECORD_TO_FILE_EX: return "CM_RECORD_TO_FILE_EX"; + +#if K3L_AT_LEAST(1,5,4) + case K_CM_SET_VOLUME: return "CM_SET_VOLUME"; +#endif + case K_CM_SET_LINE_CONDITION: return "CM_SET_LINE_CONDITION"; + case K_CM_SEND_LINE_CONDITION: return "CM_SEND_LINE_CONDITION"; + case K_CM_SET_CALLER_CATEGORY: return "CM_SET_CALLER_CATEGORY"; + case K_CM_DIAL_MFC: return "CM_DIAL_MFC"; + + case K_CM_INTERNAL_PLAY: return "CM_INTERNAL_PLAY"; + case K_CM_RESUME_PLAY: return "CM_RESUME_PLAY"; + case K_CM_RESUME_RECORD: return "CM_RESUME_RECORD"; + case K_CM_INTERNAL_PLAY_EX: return "CM_INTERNAL_PLAY_EX"; +#if !K3L_AT_LEAST(2,0,0) + case K_CM_PING: return "CM_PING"; +#if K3L_AT_LEAST(1,6,0) + case K_CM_LOG_REQUEST: return "CM_LOG_REQUEST"; + case K_CM_LOG_CREATE_DISPATCHER: return "CM_LOG_CREATE_DISPATCHER"; + case K_CM_LOG_DESTROY_DISPATCHER: return "CM_LOG_DESTROY_DISPATCHER"; +#endif +#endif + +#if K3L_AT_LEAST(1,6,0) + case K_CM_START_CADENCE: return "CM_START_CADENCE"; + case K_CM_STOP_CADENCE: return "CM_STOP_CADENCE"; + case K_CM_CHECK_NEW_SMS: return "CM_CHECK_NEW_SMS"; + case K_CM_SEND_TO_MODEM: return "CM_SEND_TO_MODEM"; +#endif +#if K3L_AT_LEAST(2,1,0) + case K_CM_START_FAX_TX: return "CM_START_FAX_TX"; + case K_CM_STOP_FAX_TX: return "CM_STOP_FAX_TX"; + case K_CM_ADD_FAX_FILE: return "CM_ADD_FAX_FILE"; + case K_CM_ADD_FAX_PAGE_BREAK: return "CM_ADD_FAX_PAGE_BREAK"; + case K_CM_START_FAX_RX: return "CM_START_FAX_RX"; + case K_CM_STOP_FAX_RX: return "CM_STOP_FAX_RX"; + case K_CM_SIM_CARD_SELECT: return "CM_SIM_CARD_SELECT"; +#endif + +#if K3L_AT_LEAST(2,1,0) + case K_CM_NOTIFY_WATCHDOG: return "CM_NOTIFY_WATCHDOG"; + case K_CM_STOP_WATCHDOG: return "CM_STOP_WATCHDOG"; + case K_CM_WATCHDOG_COUNT: return "CM_WATCHDOG_COUNT"; + case K_CM_START_WATCHDOG: return "CM_START_WATCHDOG"; +#endif + + } + + return STG(FMT("[command='%d']") % code); +} + +std::string Verbose::eventName(int32 code) +{ + switch ((kevent)code) + { + case K_EV_CHANNEL_FREE: return "EV_CHANNEL_FREE"; + case K_EV_CONNECT: return "EV_CONNECT"; + case K_EV_DISCONNECT: return "EV_DISCONNECT"; + case K_EV_CALL_SUCCESS: return "EV_CALL_SUCCESS"; + case K_EV_CALL_FAIL: return "EV_CALL_FAIL"; + case K_EV_NO_ANSWER: return "EV_NO_ANSWER"; + case K_EV_BILLING_PULSE: return "EV_BILLING_PULSE"; + case K_EV_SEIZE_SUCCESS: return "EV_SEIZE_SUCCESS"; + case K_EV_SEIZE_FAIL: return "EV_SEIZE_FAIL"; + case K_EV_SEIZURE_START: return "EV_SEIZURE_START"; + case K_EV_CAS_LINE_STT_CHANGED: return "EV_CAS_LINE_STT_CHANGED"; + case K_EV_CAS_MFC_RECV: return "EV_CAS_MFC_RECV"; + +#if K3L_AT_LEAST(1,5,0) + case K_EV_NEW_CALL: return "EV_NEW_CALL"; +#endif + +#if K3L_AT_LEAST(1,5,1) + case K_EV_USER_INFORMATION: return "EV_USER_INFORMATION"; +#endif + +#if K3L_AT_LEAST(1,5,3) + case K_EV_DIALED_DIGIT: return "EV_DIALED_DIGIT"; +#endif + +#if K3L_AT_LEAST(1,6,0) + case K_EV_SIP_REGISTER_INFO: return "EV_SIP_REGISTER_INFO"; +#endif + +#if K3L_AT_LEAST(1,4,0) + case K_EV_CALL_HOLD_START: return "EV_CALL_HOLD_START"; + case K_EV_CALL_HOLD_STOP: return "EV_CALL_HOLD_STOP"; +#endif + +#if K3L_AT_LEAST(1,6,0) + case K_EV_SS_TRANSFER_FAIL: return "EV_SS_TRANSFER_FAIL"; + case K_EV_FLASH: return "EV_FLASH"; +#endif + + case K_EV_DTMF_DETECTED: return "EV_DTMF_DETECTED"; + case K_EV_DTMF_SEND_FINISH: return "EV_DTMF_SEND_FINISH"; + case K_EV_AUDIO_STATUS: return "EV_AUDIO_STATUS"; + case K_EV_CADENCE_RECOGNIZED: return "EV_CADENCE_RECOGNIZED"; + + case K_EV_END_OF_STREAM: return "EV_END_OF_STREAM"; + case K_EV_PULSE_DETECTED: return "EV_PULSE_DETECTED"; + +#if K3L_AT_LEAST(1,5,1) + case K_EV_POLARITY_REVERSAL: return "EV_POLARITY_REVERSAL"; +#endif + +#if K3L_AT_LEAST(1,6,0) + case K_EV_ISDN_PROGRESS_INDICATOR: return "EV_ISDN_PROGRESS_INDICATOR"; + case K_EV_CALL_ANSWER_INFO: return "EV_CALL_ANSWER_INFO"; + case K_EV_COLLECT_CALL: return "EV_COLLECT_CALL"; + case K_EV_SIP_DTMF_DETECTED: return "EV_SIP_DTMF_DETECTED"; + + case K_EV_RECV_FROM_MODEM: return "EV_RECV_FROM_MODEM"; + case K_EV_NEW_SMS: return "EV_NEW_SMS"; + case K_EV_SMS_INFO: return "EV_SMS_INFO"; + case K_EV_SMS_DATA: return "EV_SMS_DATA"; + case K_EV_SMS_SEND_RESULT: return "EV_SMS_SEND_RESULT"; + case K_EV_RING_DETECTED: return "EV_RING_DETECTED"; + case K_EV_PHYSICAL_LINK_DOWN: return "EV_PHYSICAL_LINK_DOWN"; + case K_EV_PHYSICAL_LINK_UP: return "EV_PHYSICAL_LINK_UP"; +#endif +#if K3L_HAS_MPTY_SUPPORT + case K_EV_CALL_MPTY_START: return "EV_CALL_MPTY_START"; + case K_EV_CALL_MPTY_STOP: return "EV_CALL_MPTY_STOP"; + case K_EV_GSM_COMMAND_STATUS: return "EV_GSM_COMMAND_STATUS"; +#endif +#if !K3L_AT_LEAST(2,0,0) + case K_EV_PONG: return "EV_PONG"; +#endif + case K_EV_CHANNEL_FAIL: return "EV_CHANNEL_FAIL"; + case K_EV_REFERENCE_FAIL: return "EV_REFERENCE_FAIL"; + case K_EV_INTERNAL_FAIL: return "EV_INTERNAL_FAIL"; + case K_EV_HARDWARE_FAIL: return "EV_HARDWARE_FAIL"; + case K_EV_LINK_STATUS: return "EV_LINK_STATUS"; + +#if K3L_AT_LEAST(1,4,0) + case K_EV_CLIENT_RECONNECT: return "EV_CLIENT_RECONNECT"; + case K_EV_VOIP_SEIZURE: return "EV_VOIP_SEIZURE"; +#endif + case K_EV_SEIZURE: return "EV_SEIZURE"; +#if K3L_AT_LEAST(2,1,0) + case K_EV_FAX_CHANNEL_FREE: return "EV_FAX_CHANNEL_FREE"; + case K_EV_FAX_FILE_SENT: return "EV_FAX_FILE_SENT"; + case K_EV_FAX_FILE_FAIL: return "EV_FAX_FILE_FAIL"; + /*case K_EV_FAX_MESSAGE_CONFIRMATION:return "EV_FAX_MESSAGE_CONFIRMATION";*/ + case K_EV_FAX_TX_TIMEOUT: return "EV_FAX_TX_TIMEOUT"; + case K_EV_FAX_PAGE_CONFIRMATION:return "EV_FAX_PAGE_CONFIRMATION"; + case K_EV_FAX_REMOTE_INFO: return "EV_FAX_REMOTE_INFO"; +#endif + +#if K3L_AT_LEAST(2,1,0) + case K_EV_WATCHDOG_COUNT: return "EV_WATCHDOG_COUNT"; +#endif + } + + return STG(FMT("[event='%d']") % code); +} + + +#if K3L_AT_LEAST(2,0,0) +std::string Verbose::command(int32 dev, K3L_COMMAND *k3lcmd, R2CountryType r2_country, Verbose::Presentation fmt) +#else +std::string Verbose::command(int32 dev, K3L_COMMAND *k3lcmd, Verbose::Presentation fmt) +#endif +{ +#if K3L_AT_LEAST(2,0,0) + return command(k3lcmd->Cmd, dev, k3lcmd->Object, (const char *) k3lcmd->Params, r2_country, fmt); +#else + return command(k3lcmd->Cmd, dev, k3lcmd->Object, (const char *) k3lcmd->Params, fmt); +#endif +} + +#if K3L_AT_LEAST(2,0,0) +std::string Verbose::command(int32 cmd_code, int32 dev_idx, int32 obj_idx, const char * params, R2CountryType r2_country, Verbose::Presentation fmt) +#else +std::string Verbose::command(int32 cmd_code, int32 dev_idx, int32 obj_idx, const char * params, Verbose::Presentation fmt) +#endif +{ + unsigned short int dev = (unsigned short int) dev_idx; + unsigned short int obj = (unsigned short int) obj_idx; + + kcommand code = (kcommand) cmd_code; + + std::string buf, extra; + + switch (code) + { + case K_CM_SEIZE: + case K_CM_SYNC_SEIZE: + //case K_CM_VOIP_SEIZE://deprecated + case K_CM_DIAL_MFC: + case K_CM_DIAL_DTMF: + + case K_CM_CONNECT: + case K_CM_PRE_CONNECT: + case K_CM_DISCONNECT: + case K_CM_DROP_COLLECT_CALL: + + case K_CM_START_SEND_FAIL: + case K_CM_STOP_SEND_FAIL: + + case K_CM_ENABLE_DTMF_SUPPRESSION: + case K_CM_DISABLE_DTMF_SUPPRESSION: + case K_CM_ENABLE_AUDIO_EVENTS: + case K_CM_DISABLE_AUDIO_EVENTS: + case K_CM_ENABLE_CALL_PROGRESS: + case K_CM_DISABLE_CALL_PROGRESS: + case K_CM_ENABLE_PULSE_DETECTION: + case K_CM_DISABLE_PULSE_DETECTION: + case K_CM_ENABLE_ECHO_CANCELLER: + case K_CM_DISABLE_ECHO_CANCELLER: + case K_CM_ENABLE_AGC: + case K_CM_DISABLE_AGC: + case K_CM_ENABLE_HIGH_IMP_EVENTS: + case K_CM_DISABLE_HIGH_IMP_EVENTS: + + case K_CM_FLASH: + case K_CM_RESET_LINK: + case K_CM_CLEAR_MIXER: + + case K_CM_LOCK_INCOMING: + case K_CM_UNLOCK_INCOMING: + case K_CM_LOCK_OUTGOING: + case K_CM_UNLOCK_OUTGOING: + + case K_CM_INCREASE_VOLUME: + case K_CM_DECREASE_VOLUME: + + case K_CM_STOP_RECORD: + case K_CM_PAUSE_RECORD: + case K_CM_RESUME_RECORD: + + case K_CM_STOP_LISTEN: + + case K_CM_PLAY_SOUND_CARD: + case K_CM_STOP_SOUND_CARD: + case K_CM_RINGBACK: +#if K3L_AT_LEAST(1,4,0) && !K3L_AT_LEAST(2,0,0) + case K_CM_VOIP_START_DEBUG: + case K_CM_VOIP_STOP_DEBUG: + case K_CM_VOIP_DUMP_STAT: +#endif + +#if K3L_AT_LEAST(1,5,3) + case K_CM_END_OF_NUMBER: +#endif + +#if K3L_AT_LEAST(1,5,4) + case K_CM_SET_VOLUME: +#endif + +#if K3L_AT_LEAST(1,6,0) + case K_CM_ENABLE_CALL_ANSWER_INFO: + case K_CM_DISABLE_CALL_ANSWER_INFO: + + case K_CM_SS_TRANSFER: + + case K_CM_CHECK_NEW_SMS: + case K_CM_GET_SMS: + case K_CM_PREPARE_SMS: + case K_CM_SEND_SMS: + + case K_CM_START_CADENCE: + case K_CM_STOP_CADENCE: + case K_CM_SEND_TO_MODEM: +#endif +#if K3L_HAS_MPTY_SUPPORT + case K_CM_HOLD_SWITCH: + case K_CM_MPTY_CONF: + case K_CM_MPTY_SPLIT: +#endif +#if K3L_AT_LEAST(2,1,0) + case K_CM_SIM_CARD_SELECT: +#endif + if (params != NULL) + { + extra += "param='"; + extra += (params ? params : ""); + extra += "'"; + + return show(buf, commandName(code), Target(CHANNEL, dev, obj), extra); + } + else + { + return show(buf, commandName(code), Target(CHANNEL, dev, obj)); + } + + case K_CM_SEND_DTMF: /* ?? */ + return show(buf, commandName(code), Target(CHANNEL, dev, obj)); + + /****/ + + case K_CM_STOP_AUDIO: + extra = "stop='"; + switch ((params ? (int)(*params) : -1)) + { + case 1: extra += "tx"; + case 2: extra += "rx"; + case 3: extra += "tx+rx"; + default: extra += ""; + } + extra = "'"; + + return show(buf, commandName(code), Target(CHANNEL, dev, obj), extra); + + /****/ + +#if K3L_AT_LEAST(1,5,2) && !K3L_AT_LEAST(2,0,0) + case K_CM_ISDN_DEBUG: + extra = "flags='"; + extra += isdnDebug((unsigned long)params); + extra += "'"; + + return show(buf, commandName(code), Target(NONE), extra); +#endif + + /****/ + +#if K3L_AT_LEAST(1,5,1) + case K_CM_USER_INFORMATION: +#endif + if (params != NULL) + { + KUserInformation * userinfo = (KUserInformation *)params; + + std::string tmp((const char*) userinfo->UserInfo, userinfo->UserInfoLength); + + extra = STG(FMT("proto='%d',length='%d',data='%s'") + % userinfo->ProtocolDescriptor % userinfo->UserInfoLength % tmp); + + return show(buf, commandName(code), Target(CHANNEL, dev, obj), extra); + } + else + { + return show(buf, commandName(code), Target(CHANNEL, dev, obj)); + } + + /****/ + + + + case K_CM_CAS_CHANGE_LINE_STT: + { + const char status = (params ? *params : 0x00); + + extra += "status='"; + extra += (status & 0x01 ? "1" : "0"); + extra += (status & 0x02 ? "1" : "0"); + extra += (status & 0x04 ? "1" : "0"); + extra += (status & 0x08 ? "1" : "0"); + extra += "'"; + + return show(buf, commandName(code), Target(CHANNEL, dev, obj), extra); + } + + case K_CM_CAS_SEND_MFC: + { + char mfc = (params ? *params : 0xff); + + extra = STG(FMT("mfc='%d'") % (int) mfc); + + return show(buf, commandName(code), Target(CHANNEL, dev, obj), extra); + } + + case K_CM_CAS_SET_MFC_DETECT_MODE: + { + int mode = (params ? *((int *)params) : -1); + + extra = STG(FMT("mode='%d'") % mode); + + return show(buf, commandName(code), Target(CHANNEL, dev, obj), extra); + } + + case K_CM_SET_FORWARD_CHANNEL: + { + int channel = (params ? *((int*) params) : -1); + + extra = STG(FMT("forward='%03d'") % channel); + + return show(buf, commandName(code), Target(CHANNEL, dev, obj), extra); + } + +#if K3L_AT_LEAST(1,5,0) + case K_CM_MAKE_CALL: + extra = "options='"; + extra += (params ? params : ""); + extra += "'"; + + return show(buf, commandName(code), Target(CHANNEL, dev, obj), extra); +#endif + + case K_CM_MIXER: + case K_CM_MIXER_CTBUS: + { + if (params) + { + KMixerCommand *m = (KMixerCommand*)params; + + std::string src = mixerSource((KMixerSource)m->Source); + std::string idx(""); + + switch (m->Source) + { + case kmsChannel: + case kmsPlay: + case kmsCTbus: +#if (K3L_AT_LEAST(1,4,0) && !K3L_AT_LEAST(1,6,0)) + case kmsVoIP: +#endif +#if K3L_AT_LEAST(1,6,0) + case kmsNoDelayChannel: +#endif + idx = STG(FMT("%02d") % (int)m->SourceIndex); + break; + + case kmsGenerator: + idx = mixerTone((KMixerTone)m->SourceIndex); + break; + }; + + extra = STG(FMT("track='%d',src='%s',index='%s'") % (int)m->Track % src % idx); + } + else + { + extra = ""; + } + + return show(buf, commandName(code), Target(MIXER, dev, obj), extra); + }; + + case K_CM_PLAY_FROM_FILE: + extra = "file='"; + extra += (params ? params : ""); + extra += "'"; + + return show(buf, commandName(code), Target(PLAYER, dev, obj), extra); + + case K_CM_RECORD_TO_FILE: + extra = "file='"; + extra += (params ? params : ""); + extra += "'"; + + return show(buf, commandName(code), Target(PLAYER, dev, obj), extra); + + case K_CM_RECORD_TO_FILE_EX: + extra = "params='"; + extra += (params ? params : ""); + extra += "'"; + + return show(buf, commandName(code), Target(PLAYER, dev, obj), extra); + + case K_CM_PLAY_FROM_STREAM: + case K_CM_ADD_STREAM_BUFFER: + { + struct buffer_param + { + const void * ptr; + const int size; + } + *p = (buffer_param *) params; + + std::stringstream stream; + + extra = STG(FMT("buffer='%p',size='%d'") + % (const void *) p->ptr % (const int) p->size); + + return show(buf, commandName(code), Target(PLAYER, dev, obj), extra); + } + + case K_CM_PLAY_FROM_STREAM_EX: + { + struct buffer_param + { + const void * ptr; + const int size; + const char codec; + } + *p = (buffer_param *) params; + + std::string codec; + + switch (p->codec) + { + case 0: codec = "A-Law"; + case 1: codec = "PCM-08khz"; + case 2: codec = "PCM-11khz"; + default: codec = ""; + } + + std::stringstream stream; + + extra = STG(FMT("buffer='%p',size='%d',codec='%s'") + % (const void *) p->ptr % (const int) p->size % codec); + + return show(buf, commandName(code), Target(PLAYER, dev, obj), extra); + } + + case K_CM_STOP_PLAY: + case K_CM_PAUSE_PLAY: + case K_CM_RESUME_PLAY: + + case K_CM_START_STREAM_BUFFER: + case K_CM_STOP_STREAM_BUFFER: + + case K_CM_ENABLE_PLAYER_AGC: + case K_CM_DISABLE_PLAYER_AGC: + + case K_CM_SEND_BEEP: + case K_CM_SEND_BEEP_CONF: + + case K_CM_INTERNAL_PLAY: + case K_CM_INTERNAL_PLAY_EX: + return show(buf, commandName(code), Target(PLAYER, dev, obj)); + + case K_CM_ADD_TO_CONF: + extra += "conference='"; + extra += (params ? (int) (*params) : -1); + extra += "'"; + + return show(buf, commandName(code), Target(MIXER, dev, obj), extra); + + case CM_REMOVE_FROM_CONF: + return show(buf, commandName(code), Target(MIXER, dev, obj)); + + case K_CM_LISTEN: + case K_CM_PREPARE_FOR_LISTEN: + { + int msecs = (params ? *((int*)params) : -1); + + extra = STG(FMT("msecs='%d'") % msecs); + + return show(buf, commandName(code), Target(PLAYER, dev, obj), extra); + } + + case K_CM_SEND_TO_CTBUS: + case K_CM_RECV_FROM_CTBUS: + { + KCtbusCommand *p = (KCtbusCommand*)(params); + + extra = STG(FMT("stream='%02d',timeslot='%02d',enable='%d'") + % (int)p->Stream % (int)p->TimeSlot % (int)p->Enable); + + return show(buf, commandName(code), Target(CHANNEL, dev, obj), extra); + } + + case K_CM_SET_LINE_CONDITION: + case K_CM_SEND_LINE_CONDITION: + extra = "condition='"; +#if K3L_AT_LEAST(2,0,0) + extra += signGroupB((KSignGroupB) *((int *) params), r2_country); +#else + extra += signGroupB((KSignGroupB) *((int *) params)); +#endif + extra += "'"; + + return show(buf, commandName(code), Target(CHANNEL, dev, obj), extra); + + case K_CM_SET_CALLER_CATEGORY: + extra = "category='"; +#if K3L_AT_LEAST(2,0,0) + extra += signGroupII((KSignGroupII) *((int *) params), r2_country); +#else + extra += signGroupII((KSignGroupII) *((int *) params)); +#endif + extra += "'"; + + return show(buf, commandName(code), Target(CHANNEL, dev, obj), extra); + +#if K3L_AT_LEAST(1,6,0) + case K_CM_CLEAR_LINK_ERROR_COUNTER: + return show(buf, commandName(code), Target(LINK, dev, obj)); + + case K_CM_SIP_REGISTER: + if (params != NULL) + { + extra += "param='"; + extra += (params ? params : ""); + extra += "'"; + + return show(buf, commandName(code), Target(DEVICE, dev), extra); + } + else + { + return show(buf, commandName(code), Target(DEVICE, dev)); + } +#endif + + case K_CM_SETUP_H100: + extra += "option='"; + extra += h100configIndex((KH100ConfigIndex)obj_idx); + extra += "'value='"; + extra += (params ? STG(FMT("%02d") % (int)(*params)) : ""); + extra += "'"; + + return show(buf, commandName(code), Target(DEVICE, dev), extra); + + case K_CM_HARD_RESET: + return show(buf, commandName(code), Target(LINK, dev, obj)); + +#if !K3L_AT_LEAST(2,0,0) + /* como funciona? */ + case K_CM_LOG_REQUEST: + case K_CM_LOG_CREATE_DISPATCHER: + case K_CM_LOG_DESTROY_DISPATCHER: + + case K_CM_PING: +#endif + return show(buf, commandName(code), Target(NONE)); +#if K3L_AT_LEAST(2,1,0) + case K_CM_START_FAX_TX: + case K_CM_START_FAX_RX: + case K_CM_ADD_FAX_FILE: + extra = "params='"; + extra += (params ? params : ""); + extra += "'"; + return show(buf, commandName(code), Target(CHANNEL, dev, obj), extra); + case K_CM_STOP_FAX_TX: + case K_CM_STOP_FAX_RX: + case K_CM_ADD_FAX_PAGE_BREAK: + return show(buf, commandName(code), Target(CHANNEL, dev, obj)); +#endif + +#if K3L_AT_LEAST(2,1,0) + case K_CM_NOTIFY_WATCHDOG: + case K_CM_STOP_WATCHDOG: + case K_CM_START_WATCHDOG: + return show(buf, commandName(code) , Target(DEVICE, obj)); + case K_CM_WATCHDOG_COUNT: + return show(buf, commandName(code) , Target(NONE)); +#endif + + } + + /* default command handler */ + return show(buf, commandName(code), Target(CHANNEL, dev, obj)); +} + +#if K3L_AT_LEAST(2,0,0) +std::string Verbose::event(KSignaling sig, int32 obj_idx, K3L_EVENT *ev, R2CountryType r2_country, Verbose::Presentation fmt) +#else +std::string Verbose::event(KSignaling sig, int32 obj_idx, K3L_EVENT *ev, Verbose::Presentation fmt) +#endif +{ + unsigned short int dev = (unsigned short int) ev->DeviceId; + unsigned short int obj = (unsigned short int) obj_idx; + + kevent code = (kevent) ev->Code; + + std::string buf, extra; + + switch (code) + { + case K_EV_CHANNEL_FREE: + case K_EV_SEIZE_SUCCESS: + case K_EV_CALL_SUCCESS: + case K_EV_NO_ANSWER: + case K_EV_CONNECT: + case K_EV_DTMF_SEND_FINISH: + case K_EV_SEIZURE_START: + case K_EV_BILLING_PULSE: + case K_EV_REFERENCE_FAIL: + +#if K3L_AT_LEAST(1,4,0) + case K_EV_CALL_HOLD_START: + case K_EV_CALL_HOLD_STOP: +#endif + +#if K3L_AT_LEAST(1,5,0) + case K_EV_NEW_CALL: +#endif + +#if K3L_AT_LEAST(1,6,0) + case K_EV_FLASH: + case K_EV_POLARITY_REVERSAL: + case K_EV_COLLECT_CALL: + case K_EV_SS_TRANSFER_FAIL: + case K_EV_RING_DETECTED: +#endif +#if K3L_HAS_MPTY_SUPPORT + case K_EV_CALL_MPTY_START: + case K_EV_CALL_MPTY_STOP: +#endif + break; + +#if K3L_AT_LEAST(1,6,0) + case K_EV_RECV_FROM_MODEM: + case K_EV_SMS_INFO: + case K_EV_SMS_DATA: + extra = "data='"; + extra += (ev->Params ? (const char *)(ev->Params) : ""); + extra += "'"; + + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); +#endif + +#if K3L_AT_LEAST(1,6,0) + case K_EV_SMS_SEND_RESULT: + extra = "result='"; +#if K3L_AT_LEAST(2,0,0) + extra += gsmSmsCause((KGsmSmsCause)ev->AddInfo); +#else + extra += gsmCallCause((KGsmCallCause)ev->AddInfo); +#endif + extra += "'"; + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + +#if K3L_HAS_MPTY_SUPPORT + case K_EV_GSM_COMMAND_STATUS: + extra = "result='"; + extra += gsmMobileCause((KGsmMobileCause)ev->AddInfo); + extra += "'"; + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); +#endif + + case K_EV_CALL_ANSWER_INFO: + extra = "info='"; + extra += callStartInfo((KCallStartInfo)ev->AddInfo); + extra += "'"; + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + + case K_EV_NEW_SMS: + if (ev->AddInfo != 0) + { + extra = "messages='"; + extra += STG(FMT("%d") % ev->AddInfo); + extra += "'"; + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + } + else + { + return show(buf, eventName(code), Target(CHANNEL, dev, obj)); + } + + case K_EV_ISDN_PROGRESS_INDICATOR: + if (ev->AddInfo != 0) + { + extra = "indication='"; + extra += q931ProgressIndication((KQ931ProgressIndication)ev->AddInfo); + extra += "'"; + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + } + else + { + return show(buf, eventName(code), Target(CHANNEL, dev, obj)); + } +#endif + + case K_EV_CAS_LINE_STT_CHANGED: + extra = STG(FMT("[a=%d,b=%d,c=%d,d=%d]") + % ((ev->AddInfo & 0x8) >> 3) % ((ev->AddInfo & 0x4) >> 2) + % ((ev->AddInfo & 0x2) >> 1) % (ev->AddInfo & 0x1)); + + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + + case K_EV_CAS_MFC_RECV: + extra = STG(FMT("digit='%d'") % ev->AddInfo); + + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + + case K_EV_CALL_FAIL: + extra = "cause='"; +#if K3L_AT_LEAST(2,0,0) + extra += callFail(sig, r2_country, ev->AddInfo); +#else + extra += callFail(sig, ev->AddInfo); +#endif + extra += "'"; + + if (ev->Params != NULL && ev->ParamSize != 0) + { + if (!extra.empty()) + extra += ","; + + extra += "params='"; + extra += (const char *) ev->Params; + extra += "'"; + } + + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + + case K_EV_DISCONNECT: + switch (sig) + { +#if K3L_AT_LEAST(1,5,1) + case ksigOpenCCS: + case ksigPRI_EndPoint: + case ksigPRI_Network: + case ksigPRI_Passive: + extra = "cause='"; + extra += isdnCause((KQ931Cause) ev->AddInfo); + extra += "'"; +#endif + default: + break; + } + + if (ev->Params != NULL && ev->ParamSize != 0) + { + if (!extra.empty()) + extra += ","; + + extra += "params='"; + extra += (const char *) ev->Params; + extra += "'"; + } + + if (!extra.empty()) + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + else + return show(buf, eventName(code), Target(CHANNEL, dev, obj)); + + break; + +#if K3L_AT_LEAST(1,6,0) + case K_EV_SIP_DTMF_DETECTED: +#endif + case K_EV_DTMF_DETECTED: + case K_EV_PULSE_DETECTED: + case K_EV_DIALED_DIGIT: + extra = STG(FMT("digit='%c'") % (char)ev->AddInfo); + + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + + case K_EV_SEIZURE: + { + KIncomingSeizeParams *n = (KIncomingSeizeParams *) + ( ((char*)ev) + sizeof(K3L_EVENT) ); + + extra += "orig_addr='"; + extra += n->NumberA; + extra += "',dest_addr='"; + extra += n->NumberB; + extra += "'"; + + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + } + +#if K3L_AT_LEAST(1,4,0) + case K_EV_VOIP_SEIZURE: + { + char *numB = ((char*)ev) + sizeof(K3L_EVENT); + char *numA = numB + 61; + + extra = "numberA='"; + extra += numA; + extra += "',numberB='"; + extra += numB; + extra += "'"; + + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + } +#endif + + + case K_EV_END_OF_STREAM: + return show(buf, eventName(code), Target(PLAYER, dev, obj)); + + case K_EV_AUDIO_STATUS: + extra = "tone='"; + extra += mixerTone((KMixerTone)ev->AddInfo); + extra += "'"; + + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + + case K_EV_CADENCE_RECOGNIZED: + extra = STG(FMT("cadence='%c'") % (char)(ev->AddInfo)); + + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + + case K_EV_CHANNEL_FAIL: + extra = "reason='"; + extra += channelFail(sig, ev->AddInfo); + extra += "'"; + + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + + case K_EV_SEIZE_FAIL: + extra = "reason='"; + extra += seizeFail((KSeizeFail) ev->AddInfo); + extra += "'"; + + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + + case K_EV_INTERNAL_FAIL: + extra = "reason='"; + extra += internalFail((KInternalFail) ev->AddInfo); + extra += "'"; + + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + + case K_EV_HARDWARE_FAIL: + extra = "component='"; + extra += systemObject((KSystemObject) ev->AddInfo); + extra += "'"; + + switch (ev->AddInfo) + { + case ksoChannel: + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + case ksoLink: + return show(buf, eventName(code), Target(LINK, dev, obj), extra); + case ksoLinkMon: + case ksoH100: + case ksoFirmware: + case ksoDevice: + return show(buf, eventName(code), Target(DEVICE, dev), extra); + case ksoAPI: + return show(buf, eventName(code), Target(NONE), extra); + } + + + case K_EV_LINK_STATUS: + // EV_LINK_STATUS has always zero in ObjectInfo (and AddInfo!) + /* fall throught... */ + +#if K3L_AT_LEAST(1,6,0) + case K_EV_PHYSICAL_LINK_UP: + case K_EV_PHYSICAL_LINK_DOWN: + return show(buf, eventName(code), Target(LINK, dev, obj)); +#endif + +#if K3L_AT_LEAST(1,5,1) + case K_EV_USER_INFORMATION: + { + KUserInformation *info = (KUserInformation *)(ev->Params); + + std::string data((const char *)info->UserInfo, + std::min(info->UserInfoLength, KMAX_USER_USER_LEN)); + + extra = STG(FMT("proto='%d',length='%d',data='%s'") + % info->ProtocolDescriptor % info->UserInfoLength % data); + + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + } +#endif + +#if K3L_AT_LEAST(1,6,0) + case K_EV_SIP_REGISTER_INFO: + extra = "params='"; + extra += (ev->Params ? (const char *) (ev->Params) : ""); + extra += "',status='"; + extra += sipFailures((KSIP_Failures)(ev->AddInfo)); + extra += "'"; + + return show(buf, eventName(code), Target(DEVICE, dev), extra); +#endif + +#if !K3L_AT_LEAST(2,0,0) + case K_EV_PONG: +#endif + +#if K3L_AT_LEAST(1,4,0) + case K_EV_CLIENT_RECONNECT: +#endif + return show(buf, eventName(code), Target(NONE)); + +#if K3L_AT_LEAST(2,1,0) + case K_EV_FAX_CHANNEL_FREE: + extra = "status='"; + extra += faxResult((KFaxResult)ev->AddInfo); + extra += "'"; + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + + case K_EV_FAX_FILE_SENT: + extra = "filename='"; + extra += (ev->Params ? (const char *) (ev->Params) : ""); + extra += "'"; + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + + case K_EV_FAX_FILE_FAIL: + extra = "cause='"; + extra += faxFileErrorCause((KFaxFileErrorCause)ev->AddInfo); + extra += "',filename='"; + extra += (ev->Params ? (const char *) (ev->Params) : ""); + extra += "'"; + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + + case K_EV_FAX_REMOTE_INFO: + extra = ((ev->Params && ev->ParamSize != 0) ? (const char *) ev->Params : ""); + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + + /*case K_EV_FAX_MESSAGE_CONFIRMATION:*/ + case K_EV_FAX_PAGE_CONFIRMATION: + case K_EV_FAX_TX_TIMEOUT: + return show(buf, eventName(code), Target(CHANNEL, dev, obj)); +#endif + +#if K3L_AT_LEAST(2,1,0) + case K_EV_WATCHDOG_COUNT: + extra = STG(FMT("count='%d'") % (char)ev->AddInfo); + return show(buf , eventName(code), Target(NONE), extra); +#endif + + } + + // default handler... + if (ev->Params != NULL && ev->ParamSize != 0) + { + extra += "params='"; + extra.append((const char *) ev->Params, (unsigned int) std::max(ev->ParamSize - 1, 0)); + extra += "'"; + + return show(buf, eventName(code), Target(CHANNEL, dev, obj), extra); + } + else + return show(buf, eventName(code), Target(CHANNEL, dev, obj)); +} + +/********************************************/ + +std::string Verbose::show(std::string & buf, std::string name, Target tgt, std::string & extra) +{ + if (tgt.type == NONE) + { + generate(buf, name, tgt, extra); + } + else + { + std::string tmp(","); + tmp += extra; + + generate(buf, name, tgt, tmp); + } + + return buf; +} + +std::string Verbose::show(std::string & buf, std::string name, Target tgt) +{ + std::string tmp(""); + + generate(buf, name, tgt, tmp); + return buf; +} + +void Verbose::generate(std::string &buf, std::string &name, Target tgt, std::string &extra) +{ + switch (tgt.type) + { + case NONE: + if (extra.empty()) + buf += STG(FMT("<%s>") % name); + else + buf += STG(FMT("<%s> (%s)") % name % extra); + break; + + case DEVICE: + buf += STG(FMT("<%s> (d=%02d%s)") + % name % tgt.device % extra); + break; + + default: + { + const char *kind = "o"; + + switch (tgt.type) + { + case CHANNEL: + kind = "c"; + break; + case PLAYER: + kind = "p"; + break; + case MIXER: + kind = "m"; + break; + case LINK: + kind = "l"; + default: + break; + } + + buf += STG(FMT("<%s> (d=%02d,%s=%03d%s)") + % name % tgt.device % kind % tgt.object % extra); + break; + } + } +} + diff --git a/src/mod/endpoints/mod_khomp/commons/verbose.hpp b/src/mod/endpoints/mod_khomp/commons/verbose.hpp new file mode 100644 index 0000000000..4668ea6a9f --- /dev/null +++ b/src/mod/endpoints/mod_khomp/commons/verbose.hpp @@ -0,0 +1,505 @@ +/* + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2009 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License Version 1.1 + (the "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file under + the MPL, indicate your decision by deleting the provisions above and replace them + with the notice and other provisions required by the LGPL License. If you do not + delete the provisions above, a recipient may use your version of this file under + either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#include +#include +#include + +#include + +// k3lApiMajorVersion +#ifndef CM_PING +# include +# include +#endif + +#include +#include +#include + +#ifndef _VERBOSE_HPP_ +#define _VERBOSE_HPP_ + +struct Verbose +{ + typedef enum + { + K_CM_SEIZE = CM_SEIZE, + K_CM_SYNC_SEIZE = CM_SYNC_SEIZE, +#if K3L_AT_LEAST(1,6,0) + K_CM_SIP_REGISTER = CM_SIP_REGISTER, +#endif + K_CM_DIAL_DTMF = CM_DIAL_DTMF, + K_CM_DISCONNECT = CM_DISCONNECT, + K_CM_CONNECT = CM_CONNECT, + K_CM_PRE_CONNECT = CM_PRE_CONNECT, + K_CM_CAS_CHANGE_LINE_STT = CM_CAS_CHANGE_LINE_STT, + K_CM_CAS_SEND_MFC = CM_CAS_SEND_MFC, + K_CM_SET_FORWARD_CHANNEL = CM_SET_FORWARD_CHANNEL, + K_CM_CAS_SET_MFC_DETECT_MODE = CM_CAS_SET_MFC_DETECT_MODE, + K_CM_DROP_COLLECT_CALL = CM_DROP_COLLECT_CALL, + K_CM_MAKE_CALL = CM_MAKE_CALL, + K_CM_RINGBACK = CM_RINGBACK, + K_CM_USER_INFORMATION = CM_USER_INFORMATION, +#if !K3L_AT_LEAST(2,2,0) + K_CM_VOIP_SEIZE = CM_VOIP_SEIZE, //deprecated +#endif + K_CM_LOCK_INCOMING = CM_LOCK_INCOMING, + K_CM_UNLOCK_INCOMING = CM_UNLOCK_INCOMING, + K_CM_LOCK_OUTGOING = CM_LOCK_OUTGOING, + K_CM_UNLOCK_OUTGOING = CM_UNLOCK_OUTGOING, + K_CM_START_SEND_FAIL = CM_START_SEND_FAIL, + K_CM_STOP_SEND_FAIL = CM_STOP_SEND_FAIL, + K_CM_END_OF_NUMBER = CM_END_OF_NUMBER, +#if K3L_AT_LEAST(1,6,0) + K_CM_SS_TRANSFER = CM_SS_TRANSFER, + K_CM_GET_SMS = CM_GET_SMS, + K_CM_PREPARE_SMS = CM_PREPARE_SMS, + K_CM_SEND_SMS = CM_SEND_SMS, +#endif +#if K3L_HAS_MPTY_SUPPORT + K_CM_HOLD_SWITCH = CM_HOLD_SWITCH, + K_CM_MPTY_CONF = CM_MPTY_CONF, + K_CM_MPTY_SPLIT = CM_MPTY_SPLIT, +#endif + K_CM_ENABLE_DTMF_SUPPRESSION = CM_ENABLE_DTMF_SUPPRESSION, + K_CM_DISABLE_DTMF_SUPPRESSION = CM_DISABLE_DTMF_SUPPRESSION, + K_CM_ENABLE_AUDIO_EVENTS = CM_ENABLE_AUDIO_EVENTS, + K_CM_DISABLE_AUDIO_EVENTS = CM_DISABLE_AUDIO_EVENTS, + K_CM_ENABLE_CALL_PROGRESS = CM_ENABLE_CALL_PROGRESS, + K_CM_DISABLE_CALL_PROGRESS = CM_DISABLE_CALL_PROGRESS, + K_CM_FLASH = CM_FLASH, + K_CM_ENABLE_PULSE_DETECTION = CM_ENABLE_PULSE_DETECTION, + K_CM_DISABLE_PULSE_DETECTION = CM_DISABLE_PULSE_DETECTION, + K_CM_ENABLE_ECHO_CANCELLER = CM_ENABLE_ECHO_CANCELLER, + K_CM_DISABLE_ECHO_CANCELLER = CM_DISABLE_ECHO_CANCELLER, + K_CM_ENABLE_AGC = CM_ENABLE_AGC, + K_CM_DISABLE_AGC = CM_DISABLE_AGC, + K_CM_ENABLE_HIGH_IMP_EVENTS = CM_ENABLE_HIGH_IMP_EVENTS, + K_CM_DISABLE_HIGH_IMP_EVENTS = CM_DISABLE_HIGH_IMP_EVENTS, +#if K3L_AT_LEAST(1,6,0) + K_CM_ENABLE_CALL_ANSWER_INFO = CM_ENABLE_CALL_ANSWER_INFO, + K_CM_DISABLE_CALL_ANSWER_INFO = CM_DISABLE_CALL_ANSWER_INFO, +#endif + K_CM_RESET_LINK = CM_RESET_LINK, +#if K3L_AT_LEAST(1,6,0) + K_CM_CLEAR_LINK_ERROR_COUNTER = CM_CLEAR_LINK_ERROR_COUNTER, +#endif + K_CM_SEND_DTMF = CM_SEND_DTMF, + K_CM_STOP_AUDIO = CM_STOP_AUDIO, + K_CM_HARD_RESET = CM_HARD_RESET, + K_CM_SEND_TO_CTBUS = CM_SEND_TO_CTBUS, + K_CM_RECV_FROM_CTBUS = CM_RECV_FROM_CTBUS, + K_CM_SETUP_H100 = CM_SETUP_H100, + K_CM_MIXER = CM_MIXER, + K_CM_CLEAR_MIXER = CM_CLEAR_MIXER, + K_CM_PLAY_FROM_FILE = CM_PLAY_FROM_FILE, + K_CM_RECORD_TO_FILE = CM_RECORD_TO_FILE, + K_CM_PLAY_FROM_STREAM = CM_PLAY_FROM_STREAM, + K_CM_INTERNAL_PLAY = CM_INTERNAL_PLAY, + K_CM_STOP_PLAY = CM_STOP_PLAY, + K_CM_STOP_RECORD = CM_STOP_RECORD, + K_CM_PAUSE_PLAY = CM_PAUSE_PLAY, + K_CM_PAUSE_RECORD = CM_PAUSE_RECORD, + K_CM_RESUME_PLAY = CM_RESUME_PLAY, + K_CM_RESUME_RECORD = CM_RESUME_RECORD, + K_CM_INCREASE_VOLUME = CM_INCREASE_VOLUME, + K_CM_DECREASE_VOLUME = CM_DECREASE_VOLUME, + K_CM_LISTEN = CM_LISTEN, + K_CM_STOP_LISTEN = CM_STOP_LISTEN, + K_CM_PREPARE_FOR_LISTEN = CM_PREPARE_FOR_LISTEN, + K_CM_PLAY_SOUND_CARD = CM_PLAY_SOUND_CARD, + K_CM_STOP_SOUND_CARD = CM_STOP_SOUND_CARD, + K_CM_MIXER_CTBUS = CM_MIXER_CTBUS, + K_CM_PLAY_FROM_STREAM_EX = CM_PLAY_FROM_STREAM_EX, + K_CM_INTERNAL_PLAY_EX = CM_INTERNAL_PLAY_EX, + K_CM_ENABLE_PLAYER_AGC = CM_ENABLE_PLAYER_AGC, + K_CM_DISABLE_PLAYER_AGC = CM_DISABLE_PLAYER_AGC, + K_CM_START_STREAM_BUFFER = CM_START_STREAM_BUFFER, + K_CM_ADD_STREAM_BUFFER = CM_ADD_STREAM_BUFFER, + K_CM_STOP_STREAM_BUFFER = CM_STOP_STREAM_BUFFER, + K_CM_SEND_BEEP = CM_SEND_BEEP, + K_CM_SEND_BEEP_CONF = CM_SEND_BEEP_CONF, + K_CM_ADD_TO_CONF = CM_ADD_TO_CONF, + K_CM_REMOVE_FROM_CONF = CM_REMOVE_FROM_CONF, + K_CM_RECORD_TO_FILE_EX = CM_RECORD_TO_FILE_EX, + K_CM_SET_VOLUME = CM_SET_VOLUME, + K_CM_SET_LINE_CONDITION = CM_SET_LINE_CONDITION, + K_CM_SEND_LINE_CONDITION = CM_SEND_LINE_CONDITION, + K_CM_SET_CALLER_CATEGORY = CM_SET_CALLER_CATEGORY, + K_CM_DIAL_MFC = CM_DIAL_MFC, +#if !K3L_AT_LEAST(2,0,0) + K_CM_VOIP_START_DEBUG = CM_VOIP_START_DEBUG, + K_CM_VOIP_STOP_DEBUG = CM_VOIP_STOP_DEBUG, + K_CM_VOIP_DUMP_STAT = CM_VOIP_DUMP_STAT, + K_CM_ISDN_DEBUG = CM_ISDN_DEBUG, + K_CM_PING = CM_PING, + K_CM_LOG_REQUEST = CM_LOG_REQUEST, + K_CM_LOG_CREATE_DISPATCHER = CM_LOG_CREATE_DISPATCHER, + K_CM_LOG_DESTROY_DISPATCHER = CM_LOG_DESTROY_DISPATCHER, +#endif +#if K3L_AT_LEAST(1,6,0) + K_CM_START_CADENCE = CM_START_CADENCE, + K_CM_STOP_CADENCE = CM_STOP_CADENCE, + K_CM_CHECK_NEW_SMS = CM_CHECK_NEW_SMS, + K_CM_SEND_TO_MODEM = CM_SEND_TO_MODEM, +#endif +#if K3L_AT_LEAST(2,1,0) + K_CM_START_FAX_TX = CM_START_FAX_TX, + K_CM_STOP_FAX_TX = CM_STOP_FAX_TX, + K_CM_ADD_FAX_FILE = CM_ADD_FAX_FILE, + K_CM_ADD_FAX_PAGE_BREAK = CM_ADD_FAX_PAGE_BREAK, + K_CM_START_FAX_RX = CM_START_FAX_RX, + K_CM_STOP_FAX_RX = CM_STOP_FAX_RX, + K_CM_SIM_CARD_SELECT = CM_SIM_CARD_SELECT, +#endif + +#if K3L_AT_LEAST(2,1,0) + K_CM_NOTIFY_WATCHDOG = CM_NOTIFY_WATCHDOG, + K_CM_STOP_WATCHDOG = CM_STOP_WATCHDOG, + K_CM_WATCHDOG_COUNT = CM_WATCHDOG_COUNT, + K_CM_START_WATCHDOG = CM_START_WATCHDOG, +#endif + + } + kcommand; + + typedef enum + { + K_EV_CHANNEL_FREE = EV_CHANNEL_FREE, + K_EV_CONNECT = EV_CONNECT, + K_EV_DISCONNECT = EV_DISCONNECT, + K_EV_CALL_SUCCESS = EV_CALL_SUCCESS, + K_EV_CALL_FAIL = EV_CALL_FAIL, + K_EV_NO_ANSWER = EV_NO_ANSWER, + K_EV_BILLING_PULSE = EV_BILLING_PULSE, + K_EV_SEIZE_SUCCESS = EV_SEIZE_SUCCESS, + K_EV_SEIZE_FAIL = EV_SEIZE_FAIL, + K_EV_SEIZURE_START = EV_SEIZURE_START, + K_EV_CAS_LINE_STT_CHANGED = EV_CAS_LINE_STT_CHANGED, + K_EV_CAS_MFC_RECV = EV_CAS_MFC_RECV, + K_EV_NEW_CALL = EV_NEW_CALL, + K_EV_USER_INFORMATION = EV_USER_INFORMATION, + K_EV_DIALED_DIGIT = EV_DIALED_DIGIT, +#if K3L_AT_LEAST(1,6,0) + K_EV_SIP_REGISTER_INFO = EV_SIP_REGISTER_INFO, + K_EV_RING_DETECTED = EV_RING_DETECTED, +#endif + K_EV_CALL_HOLD_START = EV_CALL_HOLD_START, + K_EV_CALL_HOLD_STOP = EV_CALL_HOLD_STOP, +#if K3L_AT_LEAST(1,6,0) + K_EV_SS_TRANSFER_FAIL = EV_SS_TRANSFER_FAIL, + K_EV_FLASH = EV_FLASH, +#endif + K_EV_DTMF_DETECTED = EV_DTMF_DETECTED, + K_EV_DTMF_SEND_FINISH = EV_DTMF_SEND_FINISH, + K_EV_AUDIO_STATUS = EV_AUDIO_STATUS, + K_EV_CADENCE_RECOGNIZED = EV_CADENCE_RECOGNIZED, + K_EV_END_OF_STREAM = EV_END_OF_STREAM, + K_EV_PULSE_DETECTED = EV_PULSE_DETECTED, + K_EV_POLARITY_REVERSAL = EV_POLARITY_REVERSAL, +#if K3L_AT_LEAST(1,6,0) + K_EV_ISDN_PROGRESS_INDICATOR = EV_ISDN_PROGRESS_INDICATOR, + K_EV_CALL_ANSWER_INFO = EV_CALL_ANSWER_INFO, + K_EV_COLLECT_CALL = EV_COLLECT_CALL, + K_EV_SIP_DTMF_DETECTED = EV_SIP_DTMF_DETECTED, + K_EV_RECV_FROM_MODEM = EV_RECV_FROM_MODEM, + K_EV_NEW_SMS = EV_NEW_SMS, + K_EV_SMS_INFO = EV_SMS_INFO, + K_EV_SMS_DATA = EV_SMS_DATA, + K_EV_SMS_SEND_RESULT = EV_SMS_SEND_RESULT, +#endif +#if K3L_HAS_MPTY_SUPPORT + K_EV_CALL_MPTY_START = EV_CALL_MPTY_START, + K_EV_CALL_MPTY_STOP = EV_CALL_MPTY_STOP, + K_EV_GSM_COMMAND_STATUS = EV_GSM_COMMAND_STATUS, +#endif + K_EV_CHANNEL_FAIL = EV_CHANNEL_FAIL, + K_EV_REFERENCE_FAIL = EV_REFERENCE_FAIL, + K_EV_INTERNAL_FAIL = EV_INTERNAL_FAIL, + K_EV_HARDWARE_FAIL = EV_HARDWARE_FAIL, + K_EV_LINK_STATUS = EV_LINK_STATUS, +#if K3L_AT_LEAST(1,6,0) + K_EV_PHYSICAL_LINK_UP = EV_PHYSICAL_LINK_UP, + K_EV_PHYSICAL_LINK_DOWN = EV_PHYSICAL_LINK_DOWN, +#endif + K_EV_CLIENT_RECONNECT = EV_CLIENT_RECONNECT, + K_EV_VOIP_SEIZURE = EV_VOIP_SEIZURE, + K_EV_SEIZURE = EV_SEIZURE, + +#if K3L_AT_LEAST(2,1,0) + K_EV_FAX_CHANNEL_FREE = EV_FAX_CHANNEL_FREE, + K_EV_FAX_FILE_SENT = EV_FAX_FILE_SENT, + K_EV_FAX_FILE_FAIL = EV_FAX_FILE_FAIL, + K_EV_FAX_MESSAGE_CONFIRMATION = EV_FAX_MESSAGE_CONFIRMATION, + K_EV_FAX_TX_TIMEOUT = EV_FAX_TX_TIMEOUT, + K_EV_FAX_PAGE_CONFIRMATION = EV_FAX_PAGE_CONFIRMATION, + K_EV_FAX_REMOTE_INFO = EV_FAX_REMOTE_INFO, +#endif + +#if K3L_AT_LEAST(2,1,0) + K_EV_WATCHDOG_COUNT = EV_WATCHDOG_COUNT, +#endif + +#if !K3L_AT_LEAST(2,0,0) + K_EV_PONG = EV_PONG, +#endif + } + kevent; + + typedef enum + { + R2_COUNTRY_ARG = 1, + R2_COUNTRY_BRA = 2, + R2_COUNTRY_CHI = 3, + R2_COUNTRY_MEX = 4, + R2_COUNTRY_URY = 5, + R2_COUNTRY_VEN = 6 + } + R2CountryType; + + typedef enum + { + HUMAN, + EXACT + } + Presentation; + + /* dynamic (object) stuff */ + + Verbose(K3LAPI & api): _api(api) {}; + +#if K3L_AT_LEAST(2,0,0) + std::string event(int32, K3L_EVENT*, R2CountryType r2_country = R2_COUNTRY_BRA, + Presentation fmt = HUMAN); +#else + std::string event(int32, K3L_EVENT*, Presentation fmt = HUMAN); +#endif + + std::string channelStatus(int32, int32, int32, Presentation fmt = HUMAN); + + /* end of dynamic (object) stuff */ + + protected: + K3LAPI & _api; + + /* used internally */ + struct internal_not_found {}; + + public: + + /* static (class) stuff */ + + static std::string echoLocation(KEchoLocation, Presentation fmt = HUMAN); + static std::string echoCancellerConfig(KEchoCancellerConfig, Presentation fmt = HUMAN); + +#if K3L_AT_LEAST(2,0,0) + static std::string event(KSignaling, int32, K3L_EVENT*, R2CountryType = R2_COUNTRY_BRA, + Presentation fmt = HUMAN); +#else + static std::string event(KSignaling, int32, K3L_EVENT*, Presentation fmt = HUMAN); +#endif + +#if K3L_AT_LEAST(2,0,0) + static std::string command(int32, K3L_COMMAND*, R2CountryType = R2_COUNTRY_BRA, + Presentation fmt = HUMAN); + static std::string command(int32, int32, int32, const char *, R2CountryType = R2_COUNTRY_BRA, + Presentation fmt = HUMAN); +#else + static std::string command(int32, K3L_COMMAND*, Presentation fmt = HUMAN); + static std::string command(int32, int32, int32, const char *, Presentation fmt = HUMAN); +#endif + + + static std::string deviceName(KDeviceType, int32, Presentation fmt = HUMAN); + + static std::string deviceType(KDeviceType, Presentation fmt = HUMAN); + static std::string deviceModel(KDeviceType, int32, Presentation fmt = HUMAN); + + static std::string channelFeatures(int32, Presentation fmt = HUMAN); + static std::string signaling(KSignaling, Presentation fmt = HUMAN); + static std::string systemObject(KSystemObject, Presentation fmt = HUMAN); + static std::string mixerTone(KMixerTone, Presentation fmt = HUMAN); + static std::string mixerSource(KMixerSource, Presentation fmt = HUMAN); + + static std::string seizeFail(KSeizeFail, Presentation fmt = HUMAN); + +#if K3L_AT_LEAST(2,0,0) + static std::string callFail(KSignaling, R2CountryType, int32, Presentation fmt = HUMAN); +#else + static std::string callFail(KSignaling, int32, Presentation fmt = HUMAN); +#endif + + static std::string channelFail(KSignaling, int32, Presentation fmt = HUMAN); + static std::string internalFail(KInternalFail, Presentation fmt = HUMAN); + + static std::string linkErrorCounter(KLinkErrorCounter, Presentation fmt = HUMAN); + + static std::string linkStatus(KSignaling, int32, Presentation fmt = HUMAN); + static std::string channelStatus(KSignaling, int32, Presentation fmt = HUMAN); + static std::string callStatus(KCallStatus, Presentation fmt = HUMAN); + static std::string status(KLibraryStatus, Presentation fmt = HUMAN); + +#if K3L_AT_LEAST(2,0,0) + static std::string signGroupB(KSignGroupB, R2CountryType contry = R2_COUNTRY_BRA, + Presentation fmt = HUMAN); +#else + static std::string signGroupB(KSignGroupB, Presentation fmt = HUMAN); +#endif + +#if K3L_AT_LEAST(2,0,0) + static std::string signGroupII(KSignGroupII, R2CountryType contry = R2_COUNTRY_BRA, + Presentation fmt = HUMAN); +#else + static std::string signGroupII(KSignGroupII, Presentation fmt = HUMAN); +#endif + + static std::string h100configIndex(KH100ConfigIndex, Presentation fmt = HUMAN); + + static std::string eventName(int32); + static std::string commandName(int32); + +#if K3L_AT_LEAST(1,5,0) + static std::string sipFailures(KSIP_Failures, Presentation fmt = HUMAN); +#endif + +#if K3L_AT_LEAST(1,5,1) + static std::string isdnCause(KQ931Cause, Presentation fmt = HUMAN); +#endif + +#if K3L_AT_LEAST(1,5,2) + static std::string isdnDebug(int32, Presentation fmt = HUMAN); +#endif + +#if K3L_AT_LEAST(1,6,0) + static std::string callStartInfo(KCallStartInfo, Presentation fmt = HUMAN); + + static std::string gsmCallCause(KGsmCallCause, Presentation fmt = HUMAN); + static std::string gsmMobileCause(KGsmMobileCause, Presentation fmt = HUMAN); + static std::string gsmSmsCause(KGsmSmsCause, Presentation fmt = HUMAN); + + static std::string q931ProgressIndication(KQ931ProgressIndication, + Presentation fmt = HUMAN); +#endif + +#if K3L_AT_LEAST(2,1,0) + static std::string faxResult(KFaxResult code, Presentation fmt = HUMAN); + static std::string faxFileErrorCause(KFaxFileErrorCause code, Presentation fmt = HUMAN); +#endif + + /* end of static (class) stuff */ + + private: + static std::string internal_deviceType(KDeviceType); + static std::string internal_deviceModel(KDeviceType, int32); + +#if K3L_AT_LEAST(1,5,0) + static std::string internal_sipFailures(KSIP_Failures, Presentation fmt = HUMAN); +#endif +#if K3L_AT_LEAST(1,5,1) + static std::string internal_isdnCause(KQ931Cause, Presentation fmt = HUMAN); +#endif + +#if K3L_AT_LEAST(2,0,0) + static std::string internal_signGroupB(KSignGroupB, R2CountryType contry, Presentation fmt = HUMAN); + static std::string internal_signGroupII(KSignGroupII, R2CountryType contry, Presentation fmt = HUMAN); +#else + static std::string internal_signGroupB(KSignGroupB, Presentation fmt = HUMAN); + static std::string internal_signGroupII(KSignGroupII, Presentation fmt = HUMAN); +#endif + +#if K3L_AT_LEAST(1,6,0) + static std::string internal_gsmCallCause(KGsmCallCause, Presentation fmt = HUMAN); + static std::string internal_gsmMobileCause(KGsmMobileCause, Presentation fmt = HUMAN); + static std::string internal_gsmSmsCause(KGsmSmsCause, Presentation fmt = HUMAN); + + static std::string internal_q931ProgressIndication(KQ931ProgressIndication, Presentation fmt = HUMAN); +#endif + + private: + enum Type + { + DEVICE, + CHANNEL, + PLAYER, + MIXER, + LINK, + NONE + }; + + struct Target + { + Target(Type _type) + : type(_type), device(-1), object(-1) + {}; + + Target(Type _type, int32 _device) + : type(_type), device(_device), object(-1) + {}; + + Target(Type _type, int32 _device, int32 _object) + : type(_type), device(_device), object(_object) + {}; + + Type type; + int32 device; + int32 object; + }; + + static void generate(std::string &, std::string &, Target, std::string &); + + static std::string show(std::string &, std::string, Target, std::string &); + static std::string show(std::string &, std::string, Target); + + template < typename ReturnType > + static ReturnType presentation(Presentation fmt, ReturnType str_exact, ReturnType str_human) + { + switch (fmt) + { + case HUMAN: return str_human; + case EXACT: return str_exact; + }; + + return str_exact; + } +}; + +#endif /* _VERBOSE_HPP_ */ diff --git a/src/mod/endpoints/mod_khomp/docs/Manual.html b/src/mod/endpoints/mod_khomp/docs/Manual.html new file mode 100644 index 0000000000..fc63f0d8f1 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/docs/Manual.html @@ -0,0 +1,1093 @@ +Mod Khomp: Manual +

Considerações iniciais

+

Este documento aborda informações sobre o Endpoint da Khomp como um todo, desde opções disponíveis de configuração, os applications disponibilizados, os possíveis comandos de CLI, entre outros. +

Para procedimentos sobre a instalação, favor consultar o README do Endpoint. +
+

+

Configuração

+

Configurar o Endpoint da Khomp é uma tarefa que consiste de três etapas: +

+
  • Configuração das placas, através da K3L; +
  • Configuração do Endpoint; +
  • Configuração do FreeSWITCH. +
+

Estas etapas são descritas mais detalhadamente abaixo. +
+

+

Configuração da API K3L

+

Esta etapa é realizada de maneira semi-automatizada através do programa khompwizard, um assistente que configura os parâmetros básicos das placas do sistema. Esse assistente inicializa os arquivos de configuração através de informações obtidas do usuário, quando estas forem necessárias, inicializando as configurações menos utilizadas com os valores padrões. +

Normalmente, este programa é executado automaticamente após a instalação do sistema. Entretanto, pode ser necessário executá-lo manualmente caso uma atualização esteja sendo realizada, ou se novas placas foram adicionadas no sistema após a instalação dos drivers da placa. +

Caso seja necessária a configuração de parâmetros avançados da placa e/ou da sinalização, o programa k3lconfig permite acessar todas as configurações disponíveis de cada placa instalada. Para maiores informações sobre este programa, consulte a documentação do mesmo. Para soluções de problemas de sincronismo, consulte a seção Solução de problemas sobre o procedimento de configuração manual das placas. +
+

+

Configuração do Endpoint

+

A configuração padrão do sistema costuma atender à maior parte das necessidades. Entretanto, as configurações do Endpoint da Khomp podem ser modificadas através do arquivo de configuração '/usr/local/freeswitch/conf/autoload_configs/khomp.conf.xml'. +

A lista de opções é a seguinte: +

+

<channels>

+

Define as configurações gerais de todos os canais da Khomp. +

+
Sintaxe: <param name="..." value="..."/>
+
+
  • auto-fax-adjustment: Ativa ("yes") ou desativa ("no") o ajuste automático do canal (desabilitar o cancelador de eco e a supressão DTMF) ao detectar tom de FAX; +
  • auto-gain-control: Ativa ("yes") ou desativa ("no") a ativação do controle automático de ganho (AGC) pelo Endpoint; +
  • context-digital: Contexto de entrada para ligações em placas digitais (o padrão é "khomp-DD-LL", onde "DD" será substituído, no momento da ligação, pelo número do dispositivo, "LL" pelo número do link, "CCC" pelo número do canal e "SSSS" pelo número serial do dispositivo); +
  • context-fxo: Contexto de entrada para placas FXO (o padrão é "khomp-DD-CC", onde "DD" será substituído, no momento da ligação, pelo número do dispositivo, "CC" pelo número do canal, e "SSSS" pelo número serial do dispositivo); +
  • context-fxo-alt: Contexto de entrada alternativo para placas FXO (o padrão é vazio, no entanto quando definido, segue a mesma regra de substituição da opção context-fxo); +
  • context-fxs: Contexto de entrada para placas FXS (o padrão é "khomp-DD-CC", onde "DD" será substituído, no momento da ligação, pelo número do dispositivo, "CC" pelo número do canal, e "SSSS" pelo número serial do dispositivo); +
  • context-fxs-alt: Contexto de entrada alternativo para placas FXS (o padrão é vazio, no entanto quando definido, segue a mesma regra de substituição da opção context-fxs); +
  • context-gsm-call (ou "context-gsm"): Contexto de entrada para ligações GSM (o padrão é "khomp-DD-CC", onde "DD" será substituído no momento da ligação pelo número do dispositivo, "CC" pelo número do canal, e "SSSS" pelo número serial do dispositivo); +
  • context-gsm-call-alt (ou "context-gsm-alt"): Contexto de entrada alternativo para ligações GSM (o padrão é vazio, no entanto quando definido, segue a mesma regra de substituição da opção context-gsm-call); +
  • context-gsm-sms: Contexto de entrada para SMSs (o padrão é "khomp-sms-DD-CC", onde "DD" será substituído pelo número de dispositivo, "CC" pelo número do canal, e "SSSS" pelo número serial do dispositivo); +
  • context-pr: Contexto de entrada para ligações em placas KPR (o padrão é "khomp-DD-CC", onde "DD" será substituído, no momento da ligação, pelo número do dispositivo, "CC" pelo número do canal); +
  • disconnect-delay: Define o tempo em milissegundos para realizar o processamento de um evento de desconexão, para ignorar situações onde outros equipamentos realizam o duplo atendimento para derrubar chamadas a cobrar; +
  • echo-canceller: Ativa ("yes") ou desativa ("no") o cancelamento de eco automático pelo Endpoint; +
  • fxo-send-pre-audio: Quando ativada ("yes") libera canal de áudio sainte antes da conexão da chamada em placas KFXO (o valor padrão é "yes"); +
  • fxs-global-orig: Número inicial para numeração seqüencial de ramais das placas KFXS que não estiverem listadas na seção <fxs-branches> (a numeração segue ordem crescente por número da placa e número do canal físico) (o padrão é "0"); +
  • fxs-co-dialtone: Seqüências de números, separados por vírgula, que disparam um tom contínuo (de central pública) em ramais FXS (ex: "0,99" faz com que, ao discar "0" ou "99", o usuário receba o tom de linha contínuo) (o padrão é vazio); +
  • fxs-bina: Quando ativada ("yes"), ligações para ramais FXS enviarão os dígitos correspondentes ao telefone de origem em sinalização BINA DTMF (o valor padrão é "no"); +
  • input-volume: Define o volume de entrada das ligações, varia de -10 a +10 ; +
  • kommuter-activation: Define se a ativação de dispositivos kommuter encontrados no sistema será feita de forma automática ("auto"), ou de forma manual ("manual") pelo usuário, através do comando "khomp kommuter on/off"; +
  • kommuter-timeout: Define o timeout (em segundos) com que os kommuters serão inicializados. Se chegarem a este timeout sem receberem notificação do channel, os dispositivos irão comutar para o estado "desligado". O valor mínimo é "0" , onde os links permanecerão sempre comutados no estado "ligado", e o valor máximo é "255"; +
  • language: Define idioma para ligações nas placas Khomp; +
  • log-to-console: Define mensagens de log que devem ser impressas na console; +
  • log-to-disk: Define mensagens de log que devem ser salvar em disco; +
  • out-of-band-dtmfs: Ativa ("yes") ou desativa ("no") a supressão DTMF e o envio destes out-of-band; +
  • output-volume: Define o volume de saída das ligações, varia de -10 a +10 ; +
  • pulse-forwarding: Ativa ("yes") ou desativa ("no") a detecção de pulsos e a conversão dos mesmos em DTMFs; +
  • r2-preconnect-wait: Define o tempo de espera do envio da sinalização de ringback, no protocolo R2/MFC, para iniciar o envio de áudio de silêncio. Apenas utilizado quando "r2-strict-behaviour" estiver ajustado para "no"; +
  • r2-strict-behaviour: Ativa ("yes") ou desativa ("no") o comportamento da sinalização R2/MFC conforme a norma define. O padrão é "no", e pode ser alterado para "yes" caso seja necessário receber/enviar dados precisos da sinalização do protocolo (condição de B, por exemplo); +
  • ringback-delay-co: Define o tempo de delay para ativar a geração de tom de controle de chamada (ringback) pelo Endpoint da Khomp quando há uma indicação de ringback, e não há áudio sendo enviado por quem indicou a situação de controle da chamada; +
  • ringback-delay-pbx: Define o tempo de delay para ativar a geração de controle de chamada (ringback) pelo Endpoint da Khomp quando há uma indicação de ringback, e o áudio de controle enviado não possui nenhum tom (ou seja, está em silêncio); +
  • suppression-delay: Ativa ("yes") ou desativa ("no") o delay necessário para supressão DTMF. Se desativado ("no"), também desativa supressão de DTMFs; +
  • trace: Define opções de depuração. Não deve ser utilizado em produção a não ser que estritamente necessário; +
  • user-transfer-digits: Define uma seqüência de dígitos DTMF para iniciar a transferencia entre o FreeSWITCH® e um outro PABX (utilizando sinalização de usuário, como QSig ou FXO FLASH); +
+


+

+

<groups>

+

Define os grupos para serem usados na alocação de canal. +

Neste caso, as opções são usadas para definir nomes para strings de alocação de canais. O formato segue o padrão <param name="nome grupo" value="string alocação"/>, onde as strings de alocação de canais são as mesmas utilizadas no application bridge, e nome do grupo é um nome arbitrário escolhido pelo usuário. +

+
Por exemplo, para definir o grupo pstn como os canais 0 e 5 da placa 0, deveria-se utilizar a linha: +
+
<param name="pstn" value="b0c0 + b0c5"/> 
+
+

Este grupo, por sua vez, poderia ser usado no application bridge como <action application="bridge" data="Khomp/Gpstn/..."/>. +

+
Pode-se também associar um determinado contexto de entrada a um grupo de canais, bastando especificar um nome de contexto após a string de alocação, separado por ':' da mesma. +
+

Por exemplo, para definir o mesmo grupo pstn acima como os canais 0 até 20 da placa 0, com contexto de entrada from-pstn, poderia-se utilizar a linha: +

+
<param name="pstn" value="b0c0-20:from-pstn"/>
+
+

Este grupo, por sua vez, poderia ser usado no application bridge como <action application="bridge" data="Khomp/Gpstn/..."/>, e todas as ligações vindas destes canais seriam tratadas no contexto from-pstn. +
+

+

<cadences>

+

Define configurações de cadências para o Endpoint. +

Neste caso, as opções são nomes de cadências e um ou dois pares de números, que definem os intervalos de tom e silêncio a ser utilizado nas cadências. Para maiores detalhes, favor consultar o arquivo de configuração. +
+

+

<fxs-branches>

+

Define números de origem para a placa KFXS. +

Neste caso, as opções são seqüências de prefixos de ramais e números seriais das placas, que definem os números base dos endereços de origem, e a ordem numérica das placas. O formato das opções é: +

+
<param name="prefixo" value="serial1, serial2, ...."/>
+
+

Por exemplo, para definir que as placas K0374 e K2352 devem ser numeradas seqüencialmente, partido do ramal 200, basta escrever: +

+
<param name="200" value="374, 2352"/>
+
+

Para maiores detalhes, favor consultar o arquivo de configuração. +
+

+

<fxs-hotlines>

+

Define hotlines para a placa KFXS. +

Neste caso, as opções são seqüências de ramais e números de destino, definindo os ramais listados nesta seção para serem tratados como "hotlines". Para cada ramal listado, o número de destino especificado será discado quando o ramal for retirado do gancho. Exemplo: +

+
<param name="100" value="1234"/>
+<param name="200" value="4321"/> 
+
+

No primeiro exemplo, o ramal de número 100 irá telefonar para número 1234 ao ser retirado do gancho; no segundo, o ramal de número 200 irá telefonar para o número 4321 ao ser retirado do gancho. +

+

<fxs-options>

+

Permite definir configurações específicas por ramal FXS. +

Neste caso, as configurações são números de ramais (baseado nos definidos na seção <fxs-branches>), e as opções e seus valores. As opções disponíveis são: +

+
  • context; +
  • input-volume; +
  • output-volume; +
  • accountcode; +
  • calleridnum; +
  • calleridname; +
  • mailbox. +
+

Cada opção é separada uma da outra por um pipe "|" ou uma barra "/" e definidas após dois pontos ":", exemplo: +

+
 <param name="200" value="language:en|context:master-branch" />
+
+

Para maiores informações sobre a sintaxe e exemplos, favor consultar o arquivo de configuração. +


+

Para maiores informações, consultar o arquivo de configuração 'khomp.conf.xml'. +
+

+

Configuração do FreeSWITCH

+

Quando as ligações são recebidas nas placas e dispositivos Khomp, estas são encaminhadas pelo Endpoint da Khomp para contextos específicos dentro do plano de discagem do FreeSWITCH®. Estes contextos podem ser alterados através do arquivo de configurações khomp.conf.xml, disponível no diretório de configuração do FreeSWITCH (por padrão, "/usr/local/freeswitch/conf/autoload_configs"). +

Para maiores detalhes sobre os contextos específicos, consultar a seção de Configuração do Endpoint. +

Abaixo, encontram-se informações de como configurar os contextos de entrada de chamadas: +
+


+

+

Contextos de entrada em canais E1

+

Para placas E1, as ligações de entrada por padrão chegam em um contexto pré-definido conforme a opção context-digital: +

+
<param name="context-digital" value="khomp-DD-LL"/>
+
+

Este contexto padrão define que as ligações serão redirecionadas de acordo com o número da placa e número do link: DD é o número dispositivo (com dois dígitos), e LL é o número do link (também com dois dígitos). +

Entretanto, é possível configurar outros contextos de entrada, com formatos diferenciados. Pode-se utilizar a opção CCC, que significa o número do canal na placa (com três dígitos), e SSSS, que representa o número serial da placa (com quatro dígitos). +

Exemplos de configuração no arquivo khomp.conf.xml: +

+
<!-- número seqüencial da placa e do link (ex: khomp-01-00) -->
+<param name="context-digital" value="khomp-DD-LL"/>
+
+
<!-- número serial da placa e seqüencial do link (ex: khomp-3049-00) -->
+<param name="context-digital" value="khomp-SSSS-LL"/>
+
+
<!-- número seqüencial da placa e do canal (ex: khomp-00-001) -->
+<param name="context-digital" value="khomp-DD-CCC"/>
+
+
<!-- recebe todas as chamadas em um só contexto (khomp-digital) -->
+<param name="context-digital" value="khomp-digital"/>
+
+

Abaixo um exemplo de contexto no plano de discagem: + +

+
<!-- 
+Este contexto presente em seu arquivo de dialplan, irá manipular chamadas
+de entrada no link 0 (primeiro link) da placa 0.
+-->
+<context name="khomp-00-00">
+             .
+             .
+             .
+</context>
+
+

Outro exemplo, utilizando o mesmo formato: + +

+
<!-- 
+Este contexto presente em seu arquivo de dialplan, irá manipular chamadas
+de entrada no link 1 (segundo link) da placa 0.
+-->
+<context name="khomp-00-01>
+             .
+             .
+             .
+</context>
+
+

Um exemplo completo, com algumas ações simples: + +

+
<context name="khomp-00-00">
+    <extension name="exemplo_1">
+        <condition field="destination_number" expression="^1234$">
+            <action application="bridge" data="Khomp/b0L1/2345"/>
+        </condition>
+    </extension>
+    <extension name="exemplo_2">
+        <condition field="destination_number" expression="^23(\d{2})$">
+            <action application="bridge" data="sofia/${use_profile}/11$1@${sip_from_host}"/>
+        </condition>
+    </extension>
+</context>
+
+
<context name="khomp-00-01">
+    <extension name="exemplo_3">
+        <condition field="destination_number" expression="^1111$">
+            <action application="bridge" data="Khomp/b0L0/2345"/>
+        </condition>
+    </extension>
+</context>
+
+

Este plano de discagem define o recebimento de chamadas na placa 0 e no link 0, redirecionando chamadas para o número 1234 feitas para o link 1 da placa 0, pro ramal/telefone 2345, e redirecionando qualquer número de quatro dígitos começado com 23 para telefones SIP de quatro dígitos começados com 11 mais os dois últimos dígitos recebidos. +

Também há mais uma extensão definida, onde as ligações recebidas no link 1 da placa 0 para o número 1111, são redirecionadas para o link 0 da placa 0, para o telefone/ramal 2345. +
+

+

Contextos de entrada em canais FXS/FXO/GSM

+

Da mesma forma que no contexto de placas E1, as ligações de entrada são encaminhadas pelo Endpoint para o FreeSWITCH. Entretanto, estas sinalizações possuem dois contextos pré-definidos, buscados com uma ordem de preferência. +

O primeiro contexto é pré-definido da seguinte forma, conforme o arquivo khomp.conf.xml: +

+
<param name="context-gsm" value="khomp-DD-CC"/> ;placas GSM
+
+
<param name="context-fxs" value="khomp-DD-CC"/> ; placas FXS
+
+
<param name="context-fxo" value="khomp-DD-CC"/> ; placas FXO
+
+

Enquanto o segundo contexto possui o seguinte formato padrão: +

+
<param name="context-gsm-alt" value="khomp-DD"/> ; placas GSM
+
+
<param name="context-fxs-alt" value="khomp-DD"/> ; placas FXS
+
+
<param name="context-fxo-alt" value="khomp-DD"/> ; placas FXO
+
+

Nestes casos, DD é o número dispositivo (com dois dígitos), e CC é o número do canal da placa. Pode-se utilizar também SSSS, que representa o número serial da placa. +

+
  • IMPORTANTE: No caso da placa KGSM, as ligações entrantes são sempre encaminhadas para o extension "s" por padrão, visto que o protocolo GSM não identifica o número de destino nas ligações entrantes, apenas o número de origem - quando não omitido. +
+

Prioridade de contextos na placa FXS

+

Em ligações originadas a partir de um ramal FXS, o Endpoint driver procura uma extensão válida dos dígitos discados em três contextos diferentes. A prioridade dos contextos é a seguinte: +

+
  1. Contexto específico do ramal, definido na seção <fxs-options> do arquivo de configuração do khomp.conf.xml; +
  2. Contexto definido na opção context-fxs; +
  3. Contexto definido na opção context-fxs-alt. +
+

Caso durante a discagem, nenhuma extensão válida puder ser encontrada, a extensão i é procurada nos contextos em ordem de prioridade, e por fim no contexto default. Caso ocorra um timeout durante a discagem (configurável pela opção fxs-digit-timeout, no arquivo khomp.conf.xml) durante a discagem, o mesmo comportamento será aplicado - no entanto, a busca se dará inicialmente pelo número já discado até o timeout e, se não encontrado, a busca nos contextos será repetida para a extensão "t". +
+

+

Contextos de mensagens SMS (apenas GSM)

+

Mensagens SMS são recebidas pelo Endpoint da Khomp e encaminhadas para o FreeSWITCH como uma ligação normal, mas sem áudio, que possui algumas variáveis ajustadas com informações recebidas na mensagem - para maiores informações sobre estas variáveis, consulte a documentação das variáveis do Endpoint. Este contexto também pode ser alterado, de mesma forma que o contextos acima. +

Esta ligação entra no seguinte contexto, conforme o arquivo khomp.conf.xml: +

+
<param name="context-gsm-sms" value="khomp-sms-DD-CC"/> 
+
+

Onde DD é o número dispositivo (com dois dígitos), e CC é o número do canal (também com dois dígitos). Por exemplo: +

+
<context name="khomp-sms-00-01">
+    <extension name="sms">
+        <condition field="destination_number" expression="^s$">
+            <action application="log" data="DEBUG KSmsType=${KSmsType}"/>
+            <action application="log" data="DEBUG KSmsBody=${KSmsBody}"/>
+        </condition>
+    </extension>
+</context>
+
+

Contexto de entrada em canais Khomp_PR (KPR)

+

Para estas placas, as ligações de entrada possuem um contexto pré-definido, conforme exemplo abaixo: +

+
<param name="context-pr" value="khomp-DD-CC"/> 
+
+

Neste caso, DD é o número do dispositivo (com dois dígitos), e CC é o número do canal da placa. +
+


+
+

+

Utilização do application bridge

+

O aplicativo (ou application) bridge é responsável por gerar chamadas no FreeSWITCH a partir de um dialplan. Este aplicativo pode ser utilizado para gerar chamadas a partir de diversos tipos de Endpoints, sendo que cada Endpoint segue um formato específico para definir tanto as opções quanto os canais de comunicações a serem utilizados. +

+

Campos relativos ao Endpoint

+

Quando utilizado para canais da Khomp, a string de bridge pode ter dois, três ou quatro campos separados por uma barra (/). Algumas strings de exemplo: + +

+
<action application="bridge" data="Khomp/B2L0/32625644"/>
+<action application="bridge" data="Khomp/*B2L0/32625644"/>
+<action application="bridge" data="Khomp/S0411/99991234"/>
+<action application="bridge" data="Khomp/Gpstn/99991234"/>
+<action application="bridge" data="Khomp/*Gpstn/99991234"/>
+<action application="bridge" data="Khomp/B2C58/32625644/category=4:orig=4855553232"/>
+<action application="bridge" data="Khomp/b0c9"/>
+<action application="bridge" data="Khomp/b0c1+b0c14"/>
+<action application="bridge" data="Khomp/r304"/>
+
+

Nos cinco primeiros exemplos, temos três campos sendo especificados; no sexto, quatros campos são utilizados; e por fim, nos três últimos exemplos, apenas dois são utilizados. +

Sobre os campos utilizados, segue a descrição: +

+
  • 1° campo, 'Khomp': identifica o tipo do Endpoint em questão; +
  • 2° campo, 'B2L0', 'S0411', 'Gpstn', etc: representa a Política de Alocação de Canais; +
  • 3° campo, '32625644' e '99991234': são os números de destino, para onde será efetuada a ligação (ausente em placas KFXS); +
  • 4° campo, 'category=4:orig=4855553232': opções adicionais não-obrigatórias, detalhadas mais à frente. +
+

OBS: A string de bridge com somente dois campos é específica à ligações para uma placa KFXS, onde o destino está atrelado automaticamente ao canal alocado, ou ao ramal especificado. +

+

Política de alocação de canais

+

A política de alocação de canais, no módulo da Khomp, pode ser especificado na própria string de bridge ou através de grupos, no arquivo de configuração khomp.conf.xml. Para especificar placas, canais e links a serem alocados existe a seguinte sintaxe disponível (considerando X, Y e Z como números quaisquer): +

+
  • bX -- busca os canais na placa 'X', de maneira crescente. +
  • bXLY -- busca canais no link 'Y' da placa 'X', fazendo uma procura crescente (com relação ao número dos canais). +
  • bXcY -- utiliza apenas o canal 'Y' da placa 'X'. +
  • bXcY-Z -- busca por canais, iniciando do canal 'Y' e indo até o canal 'Z' (inclusive), da placa 'X', de maneira crescente. +
  • BXcY-Z -- idem ao anterior, de maneira decrescente. +
  • sX -- busca os canais na placa de serial 'X', de maneira crescente. +
  • sXLY -- busca canais no link 'Y' da placa de serial 'X', fazendo uma procura crescente (com relação ao número dos canais). +
  • sXcY -- utiliza apenas o canal 'Y' da placa de serial 'X'. +
  • sXcY-Z -- busca por canais, iniciando do canal 'Y' e indo até o canal 'Z' (inclusive), da placa de serial 'X', de maneira crescente. +
  • SXcY-Z -- idem ao anterior, de maneira decrescente. +
+

Para buscar por ramais de placas KFXS de acordo com o número do ramal, pode ser utilizada a seguinte sintaxe (considerando X e Y números de ramais válidos): +

+
  • rX -- busca ramal 'X'. +
  • RX -- equivalente ao anterior. +
  • rX-Y -- busca de ramal 'X' a 'Y', ordem crescente. +
  • RX-Y -- busca de ramal 'X' a 'Y', ordem decrescente. +
+

É interessante notar que apenas a capitalização da letra 'B', 'S' ou 'R' define a ordem de busca dos canais; se minúscula, crescente, e se maiúscula, decrescente. +

Já para a alocação de canais através de grupos, existe a seguinte sintaxe disponível: +

+
  • Ggroupname -- utiliza a string de bridge definida ao grupo "groupname" no arquivo de configuração; já detalhado na seção de configuração do Endpoint. +
  • ggroupname -- equivalente ao anterior. +
+

Agrupando alocações de canais

+

Existem casos onde é necessário buscar canais mais de um determinado dispositivo, ou determinado grupo de ramais. Para isto, existe uma extensão disponível na string de alocação, que diz respeito ao uso do símbolo de soma (+) para concatenar várias strings de ligação, da seguinte forma: +

+
<action application="bridge" data="Khomp/B1L0+B2L0/32332933"/>
+<action application="bridge" data="Khomp/*B2+B3+B4/99887766"/>
+<action application="bridge" data="Khomp/S0411+B1L0/99887766"/>
+<action application="bridge" data="Khomp/Gpstn1+Gpstn2/99991234"/>
+<action application="bridge" data="Khomp/*gOperadora1+gOperadora2/98891234"/>
+
+

Esta extensão está disponível tanto no application bridge quanto na especificação de grupos, e pode ser utilizada para agrupar qualquer string de alocação válida à outra. O processamento das strings de alocação se dá da esquerda para a direita - exceto quanto utilizando a alocação cíclica, onde todos os canais especificados são verificados simultaneamente. +

+

Escolha cíclica e/ou justa

+

Uma variação da alocação de canais é através de uma escolha cíclica e/ou justa, que consiste em escolher o canal que completou - até o momento - o menor número de ligações saintes. Essa forma é caracterizada por um asterisco (*) antes da string de alocação de canais (conforme pode ser verificado acima, no segundo e quinto exemplos). +

Quando iniciada com um asterisco (*), as outras formas de alocação subseqüentes (crescente, decrescente, etc) são utilizadas para decidir, entre os canais com menor número de ligações saintes, qual será verificado primeiro para realizar a chamada. +

+
  • AVISO: O uso da alocação justa e/ou cíclica é recomendável somente em placas analógicas (KFXO), de ramais (KFXS) e de interface celular (KGSM). Conexões E1 tendem a alocar os canais de maneira crescente ou decrescente de um lado (na operadora, por exemplo), e o inverso do outro (no PABX, por exemplo), para evitar problemas de dupla ocupação (o que pode ocorrer na sinalização R2/MFC). A alocação cíclica/justa também consome mais recursos de memória e processamento que a alocação tradicional, o que é agravado ainda mais pelo fato de placas E1 terem um número muito maior de canais (30 por link).

    Por estes motivos, alocações justas e/ou cíclicas devem ser utilizadas apenas em sinalizações onde isso pode representar alguma diferença real, como equalizar a tarifação das linhas, o uso das mesmas, ou o número de ligações recebidas por cada ponto de atendimento (PA). +
+

Opções disponíves

+
  • orig: Define o número de origem a ser utilizado na chamada, sem alterar a variável ${origination_caller_id_number}. Ou seja, a opção orig serve apenas para repassar um número de origem diferente do ${origination_caller_id_number}. Caso o FreeSWITCH já tenha ajustado a variável ${origination_caller_id_number}, o que é o comportamento padrão, o Endpoint utiliza este valor automaticamente como referência do número de origem, sem ser necessário repassar nenhuma opção adicional.

    Nas placas KGSM, se ajustado para restricted, omite o número de origem. Exemplo:
    +
+
+ <action application="bridge" data="Khomp/b0/99887766/orig=restricted"/>
+
+
  • category: Quando ajustado para um valor numérico, define a categoria do número de A. Disponível apenas em sinalização R2/MFC; +
  • uui: Quando ajustado para um número e uma string de texto, separados por cerquilha ("#"), envia uma mensagem "User-to-User" para a outra ponta, antes de realizar a chamada, utilizando o descritor como o número e a mensagem como o texto. Disponível apenas em sinalização RDSI (ISDN); +
  • ring_cadence: Quando ajustado para um identificador, utiliza cadência definida com este nome na seção "cadences" do arquivo de configuração do Endpoint da Khomp para chamar o canal desejado. Disponível apenas em sinalização FXS; +
  • ring: Quando ajustado para dois números, separados por ponto ("."), define as cadências de chamada de um ramal FXS para estes valores, sendo o primeiro relativo ao tempo de chamando, e o segundo, ao tempo de silêncio; +
  • ring_ext: Quando ajustado para dois números, separados por ponto ("."), define as cadências de chamada extendidas (a serem executadas depois da cadência principal) de um ramal FXS para estes valores, sendo o primeiro relativo ao tempo de chamando, e o segundo, ao tempo de silêncio; +
  • usr_xfer: Quando ajustado para uma seqüência de dígitos DTMF, define estes como dígitos a serem utilizados para iniciar uma transferência entre PABXes (utilizando sinalizações de usuário); +
  • drop_on: Quando ajustado para "message_box", "human_answer", "answering_machine", "carrier_message", "unknown" ou uma lista destes (separados por mais ("+") ou ponto (".")), faz com que a chamada seja derrubada ao detectar tons de caixa postal, atendimento humano, secretária eletrônica, mensagens da operadora, ou algum atendimento desconhecido - respectivamente. Disponível em sinalizações digitais (links E1 e placas KGSM). Adicionalmente, a informação de atendimento é reportada para o usuário na variável KCallAnswerInfo; +
  • answer_info: Opção booleana (não necessita de valor). Quando especificada, reporta informações de atendimento para o usuário através da variável KCallAnswerInfo; +
  • pre: Quando ajustado para uma seqüência de dígitos DTMF, utiliza estes para pre-alocar um canal de saída em um PABX analógico, discando o número de B desejado a seguir. Somente disponível para sinalização analógica (FXO); +
  • pre_answer: Opção booleana (não necessita de valor). Quando especificada, "antende" o canal antes de a ligação ser completada permitindo, por exemplo, que DTMFs possam ser enviados - útil para utilizar em um DISA; +
  • output_volume: Define o volume de saída da ligação. Varia de -10 a +10; +
  • input_volume: Define o volume de entrada da ligação. Varia de -10 a +10; +
+


+

+

Lista das variáveis

+

Segue lista de variáveis disponíveis no Endpoint: +

+
  • KDropCollectCall: Quando definida antes do atendimento (ao receber uma chamada), ativa ("yes") ou desativa ("no", padrão) o derrubamento de chamadas à cobrar baseado na sinalização recebida da central pública; através do duplo atendimento; ou através do reconhecimento por áudio de uma chamada à cobrar (pode ser definido de maneira global); +
  • KR2SendCondition: Quando definida antes do envio de ringback pelo FreeSWITCH (ao receber uma chamada), ajusta a condição de B para o valor numérico que foi ajustada. Apenas disponível para sinalização R2; +
  • KR2GotCategory: Ajustada pelo Endpoint ao receber uma chamada entrante, e possui a categoria do número de A. Apenas disponível para sinalização R2; +
  • KR2GotCondition: Ajustada pelo Endpoint, e disponível após o retorno de uma chamada realizada pelo FreeSWITCH. Contém a condição de B recebida ao realizar a chamada. Apenas disponível para sinalização R2; +
  • KISDNGotCause: Ajustada pelo Endpoint, e disponível após o retorno de uma chamada realizada pelo FreeSWITCH. Contém o código de cause do ISDN recebido ao realizar a chamada. Apenas disponível para sinalização ISDN; +
  • KCallAnswerInfo: Ajustada pelo Endpoint, e disponível após o retorno de uma chamada realizada pelo FreeSWITCH. Contém as informações de atendimento detectadas ao realizar a chamada e está disponível apenas para sinalizações digitais (E1, GSM); +
  • KSmsDelivered: Ajustada pelo Endpoint ao enviar uma mensagem SMS com o application KSendSMS, e define se a mensagem foi entregue com sucesso ("yes") ou não ("no"); +
  • KSmsErrorCode: Ajustada pelo Endpoint ao enviar uma mensagem SMS com o application KSendSMS, e define o código de erro ao enviar a mensagem; +
  • KSmsErrorName: Ajustada pelo Endpoint ao enviar uma mensagem SMS com o application KSendSMS, contém o nome do erro em forma textual, ou "None" caso não tenha ocorrido nenhum erro. +
  • KSmsType: Ajustada pelo Endpoint no contexto de entrada das mensagens SMS, define o tipo da mensagem recebida (pode conter os valores "message", "confirm" ou "broadcast"; +
  • KSmsFrom: Ajustada pelo Endpoint no contexto de entrada das mensagens SMS, define o número de origem da mensagem recebida (disponível em tipos "message" e "confirm"); +
  • KSmsDate: Ajustada pelo Endpoint no contexto de entrada das mensagens SMS, define a data de envio da mensagem (disponível em tipos "message" e "confirm"); +
  • KSmsSize: Ajustada pelo Endpoint no contexto de entrada das mensagens SMS, contém o tamanho (em bytes) da mensagem recebida (disponível em tipos "message" e "broadcast"); +
  • KSmsMode: Ajustada pelo Endpoint no contexto de entrada das mensagens SMS, contém o tipo codificação da mensagem recebida (disponível em tipos "message" e "broadcast"); +
  • KSmsBody: Ajustada pelo Endpoint no contexto de entrada das mensagens SMS, contém o texto da mensagem recebida (disponível em tipos "message" e "broadcast"); +
  • KSmsDelivery: Ajustada pelo Endpoint no contexto de entrada das mensagens SMS, contém a data de entrega de mensagem enviada anteriormente cuja confirmação foi requisitada (disponível no tipo "confirm"); +
  • KSmsStatus: Ajustada pelo Endpoint no contexto de entrada das mensagens SMS, contém o status de envio de mensagem anteriormente cuja confirmação foi requisitada (disponível no tipo "confirm"); +
  • KSmsSerial: Ajustada pelo Endpoint no contexto de entrada das mensagens SMS, contém o número de série da mensagem recebida (disponível no tipo "broadcast"); +
  • KSmsPage: Ajustada pelo Endpoint no contexto de entrada das mensagens SMS, contém o número da página relativo à mensagem recebida (disponível no tipo "broadcast"); +
  • KSmsPages: Ajustada pelo Endpoint no contexto de entrada das mensagens SMS, contém o número total de páginas a serem recebidas (disponível no tipo "broadcast"); +
  • KUserInfoDescriptor: Define/informa descritor do protoloco utilizado na mensagem User-to-User Information (RDSI). +
  • KUserInfoData: Define/informa os dados na mensagem User-to-User Information (RDSI). +
  • KFaxSent: Ajustada pelo Endpoint ao enviar FAX com o application KSendFax, e define se o FAX foi enviado com sucesso ("yes") ou não ("no"); +
  • KFaxReceived: Ajustada pelo Endpoint ao receber FAX com o application KReceiveFax, e define se o FAX foi recebido com sucesso ("yes") ou não ("no"); +
  • KFaxResult: Ajustada pelo Endpoint ao enviar ou receber FAX com o application KSendFax ou KReceiveFax, respectivamente, e define o seu resultado. +
+


+

+

Descrição das variáveis

+

Abaixo, segue uma explanação sobre como utilizar as variáveis do Endpoint da Khomp disponíveis no dialplan, tanto para comunicar quanto para receber informações: +


+

+

KDropCollectCall

+

Quando ativada, faz com que o Endpoint da Khomp derrube chamadas a cobrar através de duplo atendimento (disponível para sinalizações 'R2 Digital' e FXO), através da informação disponível no protocolo RDSI e R2/MFC, ou através da detecção do áudio de chamada a cobrar (disponível para qualquer sinalização digital por link E1, e para sinalização GSM). +

Esta variável é útil para derrubar chamadas a cobrar para determinados ramais, e deve ser ajustado obrigatoriamente antes de realizar qualquer tipo de atendimento - aplicações como playback e bridge devem ser executadas sempre após ajustar esta variável, por exemplo. +

Para melhor funcionalidade, é recomendado também que nenhum estado de chamada (ringback) seja enviado antes desta variável ser ajustada, então aplicações devem ser executadas apenas após o ajuste correto desta variável. +

Esta variável pode ser ajustada localmente e globalmente, tanto para yes quanto para no. O ajuste da variável global para yes fará com que todas as chamadas a cobrar sejam derrubadas, a não ser que a chamada específica seja ajustada para no - isto permite a criação de um filtro global de chamadas a cobrar, com algumas poucas exceções. +

Ativando a variável dentro do contexto default: + +

<context name="default"> +

+
<extension name="exemplo">
+ .
+ .
+ .
+ <action aplication="set" data="KDropCollectCall=yes"/>
+ .
+ .
+ .
+</extension>
+
+

</context> +

Ativando a variável no contexto global, lembrando que a mesma deve ser configurada no arquivo vars.xml: + +

+
<X-PRE-PROCESS cmd="set" data="KDropCollectCall=yes"/>
+
+

KR2SendCondition

+

Ao receber uma chamada, pode ser definida antes do envio de ringback pelo FreeSWITCH (ou seja, antes do FreeSWITCH executar as aplicações answer, ou bridge). Quando utilizada em sinalização R2/MFC, esta variável ajusta a condição de B para o valor numérico desejado. +

Exemplo: + +

+
<!-- Condição "NUMBER CHANGED", avisa ao chamador que o número de B mudou. -->
+<action application="KR2SendCondition" data="3"/>
+
+

KR2GotCategory

+

Ao receber uma chamada, é ajustada pelo Endpoint com a categoria recebida do número que originou a chamada. É ajustada na sinalização R2/MFC, e pode ser consultada em qualquer local do dialplan. +

Exemplo: + +

+
<action application="log" data="DEBUG KR2GotCategory [${KR2GotCategory}]"/> 
+
+

KR2GotCondition

+

Variável ajustada pelo Endpoint, e disponível após o retorno de uma chamada realizada pelo FreeSWITCH. Contém a condição de B recebida ao realizar a chamada. Disponível apenas para sinalização R2/MFC. +

Exemplo: + +

+
<action application="log" data="DEBUG KR2GotCondition [${KR2GotCondition}]"/>
+
+

KUserInfoDescriptor

+

Variável ajustada pelo Endpoint no contexto de entrada, a partir de informações recebidas pela rede RDSI através da funcionalidade User-to-User Information. Contém o número do descritor do protocolo utilizado pela outra ponta, e normalmente contém valor '0', mas este valor é dependente da aplicação utilizada. +

Maiores informações, consultar a especificação ITU-T Q931 (mais precisamente, a tabela 4-26 da especificação). +

Exemplo (trabalhando com o número do descritor do protocolo): +

+
<action application="log" data="DEBUG KUserInfoDescriptor [${KUserInfoDescriptor}]"/>
+
+

KUserInfoData

+

Variável ajustada pelo Endpoint no contexto de entrada, a partir de informações recebidas pela rede RDSI através da funcionalidade User-to-User Information. Contém os dados propriamente ditos, que foram recebidos, em forma de uma 'string' de texto. +

Maiores informações sobre este recurso, consultar a especificação ITU-T Q931. +

Exemplo (trabalhando com os dados recebidos): +

+
<action application="log" data="DEBUG KUserInfoData [${KUserInfoData}]"/>
+
+

É importante salientar que as variáveis são sensíveis à capitalização das letras (case sensitive). +

+

KCallAnswerInfo

+

Variável ajustada pelo Endpoint em ligações de saída, representando o tipo de atendimento realizado pela outra ponta. Pode conter os seguintes valores: +

+
  • "MessageBox" (*): detectada caixa postal de um telefone celular; +
  • "CarrierMessage": mensagem de operadora enviada antes do atendimento; +
  • "AnsweringMachine" (**): atendimento por secretária eletrônica; +
  • "HumanAnswer" (**): atendimento humano; +
  • "Unknown": tipo de atendimento desconhecido; +
  • "Fax": reportado quando um tom de fax for detectado. +
+
+


+(*) Este tipo de atendimento é detectado por sinais em determinadas freqüências que são enviados antes da chamada entrar em uma caixa postal, e variam conforme a operadora. O algoritmo captura a maior parte das caixas postais, mas pode falhar se não existir um sinal claro, ou se o mesmo não estiver dentro dos padrões mais utilizados; +

(**) A diferenciação entre estes dois tipos de atendimento depende de configuração específica utilizando o programa k3lanswerinfoconfig, sendo a detecção apenas baseada em heurísticas e nunca com precisão de 100%. +
+

+

Comandos de console

+

Lista de comandos disponíveis no console do FreeSWITCH para o Endpoint da Khomp: +


+

+
  • khomp channels disconnect : Desconecta um ou vários canais. Este comando envia uma mensagem diretamente para o canal físico da placa em questão, requisitando a desconexão. Use com cautela; +
  • khomp channels unblock : Desbloqueia canais bloqueados para entrada ou para saída. Somente disponível em sinalização digital via link E1; +
  • khomp clear links: Limpa os contadores de erros nos links; +
  • khomp clear statistics: Limpa as estatísticas de ligações dos canais, ou as estatísticas de um canal específico; +
  • khomp get : Obtém as opções diversas do Endpoint da Khomp; +
  • khomp kommuter : Ativa ou desativa os kommuters ligados via USB nesta máquina. Somente acessível quando a configuração "kommuter-activation" estiver setada como "manual"; +
  • khomp kommuter count: Obtém a quantidade de kommuters ligados via USB nesta máquina; +
  • khomp log console: Ajusta opções de logs no console. +
  • khomp log disk: : Ajusta opções de log em disco. +
    • khomp log console e khomp log disk dispõem de opções auxiliares no, que inverte a escolha de mensagens, e just, que generaliza a escolha. Exemplos: +
      • khomp log disk just commands events (Habilita somente o registro de comandos e eventos da API em disco). +
      • khomp log disk no commands (Desabilita o registro em disco de comandos enviados à API). +
      • khomp log disk warnings (Habilita também o registro em disco dos avisos do Endpoint). +
      +
    • Mais informações sobre as opções de log nos comando "help khomp log disk" ou "help khomp log console". +
    +
  • khomp log rotate: Rotaciona arquivos de log do Endpoint; +
  • khomp log status: Mostra mensagens de log atualmente sendo escritas em disco e mostradas no console; +
  • khomp log trace isdn: Ativa a depuração da sinalização RDSI (ISDN); +
  • khomp log trace k3l : Ativa a depuração de baixo nível da API K3L; +
  • khomp log trace r2 : Ativa a depuração de baixo nível da sinalização R2/MFC; +
  • khomp reset links: Envia um comando de reset para um determinado link E1 de uma determinada placa; +
  • khomp revision: Mostra número da versão e revisão do Endpoint; +
  • khomp select sim: Seleciona o SIM card, disponível nas placas KGSM; +
  • khomp send command : Envia comando da API K3L diretamente para a placa. Apenas para depuração de problemas, pode compromenter a estabilidade do sistema se utilizado de maneira incorreta; +
  • khomp send raw command : Envia um comando diretamente para o DSP da placa. Apenas para depuração de problemas, pode compromenter a estabilidade do sistema se utilizado de maneira incorreta; +
  • khomp set : Ajusta opções diversas do Endpoint da Khomp; +
  • khomp show calls : Mostra estados das chamadas Khomp, podendo listar também por placa ou canal específico; +
  • khomp show channels : Mostra o estado dos canais Khomp, podendo listar também por placa específica; +
  • khomp show links: Mostra estados dos links E1 disponíveis. +
  • khomp show statistics : Mostra as estatísticas de ligações dos canais, ou as estatísticas de um canal específico; +
  • khomp sms : Envia uma mensagem SMS utilizando canais da placa KGSM para um determinado número; +
  • khomp summary :Imprime um sumário das placas do sistema e de suas características; +
+


+

+

Recursos adicionais

+

Este capítulo trata de recursos adicionais do Endpoint, relacionados às funcionalidades especiais presentes em algumas sinalizações. +
+

+

Aplicações (applications) e canais

+

O Endpoint da Khomp, além de registrar um tipo de canal de comunicação "Khomp", registra também os seguintes itens: +
+

+

Aplicação "KUserTransfer"

+

Realiza o processo de transferência do canal atual para o ramal número' utilizando o protocolo de sinalização QSig (Single Step Call Transfer) para placas E1 configuradas com sinalização RDSI (ISDN), ou utiliza comando de FLASH para linhas FXO, LineSide, CAS_EL7 e E1LC. +

A sintaxe segue: +

+
<action application="KUserTransfer" data="número[,opções])"/>
+
+

Exemplo: +

+
<action application="answer"/>
+<action application="KUserTransfer" data="2345"/>
+
+

Os campos têm o seguinte significado: +

+
  • número: Número para onde a ligação deve ser transferida. +
  • opções: Define as opções de transferência a utilizar, que são: +
    • n: Aguarda até o canal ser desconectado. +
    +
+


+


+

+

Aplicação "KSendSMS"

+

Esta aplicação tem a função de enviar mensagens SMS através das placas KGSM da Khomp, utilizando os módulos e SIM cards presentes na placa para tal. A sintaxe da aplicação é a seguinte: +

+
<action application="KSendSMS" data="recurso|destino|mensagem" />
+
+

Podendo cada campo ser resumido em: +

+
  • recurso: Segue uma sintaxe idêntica à alocação de canais do application Bridge, e define qual modem utilizar; +
  • destino: Número para onde enviar a mensagem, podendo ser precedido ou sucedido por ! para requisitar uma mensagem de confirmação de envio; +
  • mensagem: Texto (sem aspas) que deve ser enviado para destino. +
+

Após o envio da mensagem, as variáveis KSmsDelivered e KSmsErrorCode conterão o resultado do envio da mensagem. Para maiores informações sobre estas, favor consultar a seção sobre as variáveis utilizadas no Endpoint. +

Exemplos de uso desta aplicação seguem abaixo: +

+
  • Envia "Mensagem de teste." para telefone "99887766" utilizando o modem "1" (segundo modem) da placa "0": +
+
<action application="log" data="DEBUG Enviando SMS..." />
+<action application="KSendSMS" data="b0c1|99887766|Mensagem de teste" />
+
+
  • Envia "Mensagem de teste." para telefone "99887766" utilizando o primeiro modem livre da placa "0", e verifica retorno do envio: +
+
<action application="log" data="DEBUG Enviando SMS..." />
+<action application="KSendSMS" data="b0|99887766|Mensagem de teste" />
+<action application="log" data="DEBUG Enviou? ${KSmsDelivered}" />
+<action application="log" data="DEBUG Codigo: ${KSmsErrorCode}" />
+<action application="log" data="DEBUG Descr.: ${KSmsErrorName}" />
+
+
  • Envia "Mensagem de teste." para telefone "99887766" utilizando o primeiro modem livre da placa "0", ou para o primeiro canal livre da placa "1" (se não houver canal livre na primeira placa): +
+
<action application="log" data="DEBUG Enviando SMS..." />
+<action application="KSendSMS" data="b0+b1|99887766|Mensagem de teste" />
+
+
  • Envia "Mensagem de teste." para telefone "99887766" utilizando o primeiro modem livre da placa "0", requisitando confirmação: +
+
<action application="log" data="DEBUG Enviando SMS..." />
+<action application="KSendSMS" data="b0|99887766!|Mensagem de teste" />
+
+


+

+

Aplicação "KEchoCanceller"

+

Esta aplicação tem a função de habilitar ou desabilitar o cancelador de eco do canal. +

+
<action application="KEchoCanceller" data="ação[,opções])"/>
+
+

Onde: +

+
  • ação: Pode ser on para habilitar o cancelador de eco, e off para desabilitar; +
+

Exemplo de uso desta aplicação: +

+
<action application="KEchoCanceller" data="off"/>
+
+


+

+

Aplicação "KAutoGainControl"

+

Esta aplicação tem a função de habilitar ou desabilitar o controle automático de ganho no canal. +

+
<action application="KAutoGainControl" data="ação[,opções])"/>
+
+

Onde: +

+
  • ação: Pode ser on para habilitar o controle automático de ganho, e off para desabilitar; +
+

Exemplo de uso desta aplicação: +

+
<action application="KAutoGainControl" data="on"/>
+
+


+

+

Aplicação "KDTMFSuppression"

+

Esta aplicação tem a função de habilitar ou desabilitar a supressão de DTMF do canal. A sintaxe da aplicação é a seguinte: +

+
<action applicatin="KDTMFSuppression" value="ação[,opções])"/>
+
+

Onde: +

+
  • ação: Pode ser on para habilitar a supressão DTMF, e off para desabilitar; +
+

É importante notar que quando desabilitada a supressão de DTMF, os DTMFs serão passados inband e não serão mais reportados ao FreeSWITCH. Dessa forma o FreeSWITCH não reconhecerá os DTMFs, o que pode ocasionar em mau funcionamento de aplicações como por exemplo, URAs. +

Exemplo de uso desta aplicação: +

+
<action applicatin="KDTMFSuppression" value="off"/>
+
+


+

+

Aplicação "KSetVolume"

+

Esta aplicação tem a função de ajustar o volume de entrade e saída de canais da Khomp, sendo a sua sintaxe a seguinte: +

+
<action application="KSetVolume" data="<volume>"/>
+<action application="KSetVolume" data="<output-volume>|<input-volume>"/>
+
+

Onde os campos possuem o seguinte significado: +

+
  • volume: Ajusta o volume de entrada e saída (-10 a +10); +
  • output-volume: Ajusta o volume de saída (-10 a +10, "none" para não alterar); +
  • input-volume: Ajusta o volume de entrada (-10 a +10, "none" para não alterar). +
+


+

+

Aplicação "KAdjustForFax"

+

Esta aplicação tem a função de ajustar um canal da Khomp para o recebimento de sinal de FAX/modem, otimizando o canal de comunicação para o tráfego de dados. Sintaxe: +

+
<action application="KAdjustForFax" data=""/>
+
+

Esta aplicação não recebe parâmetros. Exemplo de utilização: +

+
<action application="KAdjustForFax" data=""/>
+
+


+

+

Aplicação "KSendFax"

+

Esta aplicação tem a função de enviar fax utilizando canais digitais ou FXO da Khomp em ligações pré-estabelecidas, sendo a sua sintaxe a seguinte: +

+
<action application="KSendFax" data="<arquivo>[:<arquivo2>[:...]][|<faxid>]"/>
+
+

Esta aplicação necessita de uma licença adquirida à parte para ser utilizada em canais digitais. Os campos possuem os seguintes significados: +

+
  • arquivos: Arquivos a serem enviados para o fax devem estar encapsulados no formato TIFF e possuírem resolução de 98, 196 ou 392 dpi; +
  • faxid: Número do fax. Caso não seja especificado, o valor será obtido pela id da ligação, e caso esta, também não seja válida, o número do fax será o configurado como padrão na K3L. +
+

Exemplo de uso desta aplicação: +

+
<action application="KSendFax" data="/tmp/fax.tif:/home/root/fax2.tif,1234"/>
+
+


+

+

Aplicação "KReceiveFax"

+

Esta aplicação tem a função de receber fax utilizando canais digitais ou FXO da Khomp, sendo a sua sintaxe a seguinte: +

+
<action application="KReceiveFax" data="<arquivo>[|<faxid>]/>
+
+

Esta aplicação necessita de uma licença adquirida à parte para ser utilizada em canais digitais. Os campos possuem os seguintes significados: +

+
  • arquivo: Nome que será atribuído ao arquivo de fax recebido. +
  • faxid: Número do fax. Caso não seja especificado, o valor será obtido pela id da ligação, e caso esta, também não seja válida, o número do fax será o configurado como padrão na K3L. +
+

Exemplo de uso desta aplicação: +

+
<action application="answer" />
+<action application="KReceiveFax" data="/tmp/fax.tif"/>
+
+


+

+

Canal "Khomp_SMS"

+

Este canal de comunicação é utilizado para receber mensagens SMS e criar ligações entrantes no FreeSWITCH para cada mensagem recebida. Este canal não possui qualquer tipo de tratamento ou processamento de áudio, e é chamado com cinco variáveis ajustadas: +

+
  • KSmsFrom, contendo o número de origem de quem enviou a mensagem; +
  • KSmsDate, que define a data/hora do recebimento da mensagem; +
  • KSmsSize, representando o tamanho da mensagem (em bytes); +
  • KSmsMode, contendo a codificação utilizada para transmitir a mensagem; +
  • KSmsBody, que é a mensagem em si. +
+

O processamento do dialplan do FreeSWITCH pode ser utilizado para guardar esta mensagem em um banco de dados, executar alguma aplicação, entre outros. Entretanto, a única ação aceita por este channel é desligamento (hangup) - ou seja, esta ligação entrante não pode ser considerada uma ligação comum. +
+

+

Canal "Khomp_PR"

+

Este canal de comunicação é utilizado para receber ligações em placas de gravação passiva (família KPR e KFXO-HI), criando ligações entrantes no FreeSWITCH para cada chamada recebida. Este canal permite apenas o recebimento de áudio capturado do link, não permitindo tanto o envio de mensagens de áudio quanto o de sinalizações de controle. +

O processamento do dialplan do FreeSWITCH pode ser utilizado para gravar dados sobre esta ligação em um banco de dados, executar alguma aplicação especial e/ou algum application de gravação (como o record), entre outros. Entretanto, a única ação aceita por este channel é desligamento (hangup) - ou seja, esta ligação entrante não pode ser considerada uma ligação comum. +
+


+

+

Códigos e significados

+

Este capítulo apresenta os códigos presentes no Endpoint da Khomp e seus significados, utilizados nos comandos de console: +
+

+

Estados de canais

+

Refletem o estado do canal relativo à placa. No caso de links E1, o estado pode ter uma ou mais das seguintes opções: +

+
  • Free: o canal está livre; +
  • Busy: o canal não está livre (ou ocupado, ou em falha); +
  • Outgoing: o canal possui uma ligação de saída; +
  • Incoming: o canal possui uma ligação de entrada; +
  • Locked: o canal está bloqueado; +
  • Outgoing Lock: o canal está bloqueado para chamadas saintes; +
  • Local Fail: o canal possui uma falha local (nesta ponta); +
  • Incoming Lock: o canal está bloqueado para chamadas entrantes; +
  • Remote Lock: há um bloqueio remoto (na outra ponta) neste canal. +
+

No caso de um canal FXS, o estado é definido por um destes valores: +

+
  • On Hook: o telefone conectado neste canal está no gancho ou desconectado; +
  • Off Hook: o telefone conectado neste canal está fora do gancho; +
  • Ringing: o canal está sendo chamado; +
  • Failure: o canal está em falha devido a problemas de comunicação entre a central e a placa. +
+

No caso de um canal GSM, o estado também é definido por um dos valores a seguir: +

+
  • Idle: o canal está livre e disponível para realizar chamadas; +
  • Call In Progress: o canal está ocupado em uma ligação; +
  • Modem Error: ocorreu um erro na comunicação com o modem do canal; +
  • SIM Card Error: o SIM card não está presente ou não foi inserido/detectado corretamente; +
  • Network Error: ocorreu um erro ao comunicar-se com a rede; +
  • Not Ready: o modem está sendo inicializado no canal. +
+

E no caso de um canal FXO, os estados serão os seguintes: +

+
  • Disabled: o canal está desabilitado; +
  • Enabled: o canal está habilitado. +
+


+

+

Estados de chamada

+

Define o estado de cada canal relativo ao software, que pode ser:: +

+
  • Free: o canal está livre; +
  • Incoming: o canal está recebendo uma chamada; +
  • Outgoing: o canal está realizando uma chamada; +
  • Failure: o canal está em falha. +
+


+

+

Estados da chamada FreeSWITCH

+

Reflete diretamente o estado de chamada controlado pelo FreeSWITCH, que pode se +

+
  • new: Canal é recém criado; +
  • init: Canal foi inicializado; +
  • routing: Canal está procurando uma extensão para executar; +
  • execute: Canal está executando seu dialplan; +
  • ex_media: Canal está trocando media com outro canal; +
  • cs_media: Canal está consumindo toda media; +
  • hangup: O canal está marcada para hangup e pronto para terminar. +
+


+

+

Códigos GSM

+

Os seguintes códigos numéricos são reportados: +

+

Códigos de SMS (SMS cause)

+
1	Unassigned number
+8	Operator determined barring
+10	Call barred
+21	SMS transfer rejected
+27	Destination out of service
+28	Unidentified subscriber
+29	Facility rejected
+30	Unknown subscriber
+38	Network out of order
+41	Temporary failure
+42	Congestion
+47	Resources unavailable
+50	Facility not subscribed
+69	Facility not implemented
+81	Invalid SMS transfer reference value
+95	Invalid message
+96	Invalid mandatory information
+97	Message type non existent
+98	Message not compatible with SMS protection state
+99	Information element non existent
+111	Protocol error
+127	Interworking
+128	Telematic interworking not supported
+129	SMS type zero not supported
+130	Cannot replace SMS
+143	Unspecified TPPID error
+144	Alphabet not supported
+145	Message class not supported
+159	Unspecified TPDCS error
+160	Command cannot be actioned
+161	Command unsupported
+175	Unspecified TP command error
+176	TPDU not supported
+192	SC busy
+193	No SC subscription
+194	SC system failure
+195	Invalid SME address
+196	Destination SME barred
+197	SM rejected duplicate SM
+198	TPVPF not supported
+199	TPVP not supported
+208	SIM SMS storage full
+209	No SMS storage capability in SIM
+210	Error in SMS
+211	Memory capatity exceeded
+213	SIM data download error
+255	Unspecified error
+300	Phone failure
+301	SMS service reserved
+302	Operation not allowed
+303	Operation not supported
+304	Invalid PDU mode parameter
+305	Invalid text mode parameter
+310	SIM not inserted
+311	SIM PIN necessary
+312	Phone SIM PIN necessary
+313	SIM failure
+314	SIM busy
+315	SIM wrong
+320	Memory failure
+321	Invalid memory index
+322	Memory full
+330	SMSC address unknown
+331	No network service
+332	Network timeout
+500	Unknown error
+512	Network busy
+513	Invalid destination address
+514	Invalid message body length
+515	Phone is not in service
+516	Invalid preferred memory storage
+517	User terminated
+
+

Códigos de chamada (call cause)

+
1	Unallocated number
+3	No route to destination
+6	Channel unacceptable
+8	Operator determined barring
+16	Normal call clear
+17	User busy
+18	No user responding
+19	No answer from user
+21	Call rejected
+22	Number changed
+26	Non Selected user clear
+27	Destination out of order
+28	Invalid number format
+29	Facility rejected
+30	Response status enquiry
+31	Normal, unspecified
+34	No circuit channel available
+38	Network out of order
+41	Temporary failure
+42	Switch congestion
+43	Access information discarded
+44	Requested channel unavailable
+47	Resource unavailable
+49	QoS unavailable
+50	Request facility not subscribed
+55	Call barred with UG
+57	Bearer capability not authorized
+58	Bearer capability not available
+63	Service not available
+65	Bearer capability not implemented
+69	Request facility not implemented
+70	Only restricted bearer capability available
+79	Service not implemented
+81	Invalid call reference value
+82	User not member of UG
+88	Incompatible destination
+91	Invalid transit network selected
+95	Invalid message
+96	Missing mandatory information element
+97	Message type not implemented
+98	Message incompatible with state
+99	Information element not implemented
+100	Invalid information element
+101	Message incompatible with state (2)
+102	Recovery on timer expiry
+111	Protocol error
+127	Interworking
+
+

Códigos gerais (mobile cause)

+
0	Phone failure
+1	No connection to phone
+2	Phone adaptor link reserved
+3	Operation not allowed
+4	Operation not supported
+5	Phone SIM PIN required
+6	Phone FSIM PIN required
+7	Phone FSIM PUK required
+10	SIM not inserted
+11	SIM PIN required
+12	SIM PUK required
+13	SIM failure
+14	SIM busy
+15	SIM wrong
+16	Incorrect password
+17	SIM PIN2 required
+18	SIM PUK2 required
+20	Memory full
+21	Invalid index
+22	Not found
+23	Memory failure
+24	Text string too long
+25	Invalid character in text string
+26	Dial string too long
+27	Invalid character in dial string
+30	No network service
+31	Network timeout
+32	Network not allowed
+33	Command aborted
+34	Number parameter instead of text parameter
+35	Text parameter instead of number parameter
+36	Numeric parameter out of bounds
+37	Text string too short
+40	Network PIN required
+41	Network PUK required
+42	Network subset PIN required
+43	Network subset PUK required
+44	Network service provider PIN required
+45	Network service provider PUK required
+46	Corporate PIN required
+47	Corporate PUK required
+60	SIM Service option not supported
+100	Unknown
+103	Illegal MS #3
+106	Illegal MS #6
+107	GPRS service not allowed #7
+111	PLMN not allowed #11
+112	Location area not allowed #12
+113	Roaming not allowed #13
+132	Service option not supported #32
+133	Registration service option not subscribed #33
+134	Service option temporary out of order #34
+147	Long context activation
+148	Unspecified GPRS error
+149	PDP authentication failure
+150	Invalid mobile class
+151	GPRS disconnection TMR active
+256	Too many active calls
+257	Call rejected
+258	Unanswered call pending
+259	Unknown calling error
+260	No phone number recognized
+261	Call state not idle
+262	Call in progress
+263	Dial state error
+264	Unlock code required
+265	Network busy
+266	Invalid phone number
+267	Number entry already started
+268	Cancelled by user
+269	Number entry could not be started
+280	Data lost
+281	Invalid message body length
+282	Inactive socket
+283	Socket already open
+
+


+

+

Solução de problemas

+

Nesta seção, erros e suas soluções mais comuns são apresentados. +

+

Erro durante a instalação do módulo de kernel

+

Durante a instalação do Endpoint da Khomp, podem ocorrer as seguintes mensagens: + +

+
K3L: WARNING: Unable to find a module for [...]
+
+

ou + +

+
install: ******  THE KERNEL MODULE HAS NOT BEEN INSTALLED: *******
+install: 
+install: ** Please, untar the file kpdriver*.tar.gz located in: **
+install: **                 '/usr/src/khomp/'                   **
+install: **             then check the README.txt               **
+install: **  for knowing how to proceed with the installation.  **
+
+

Neste caso, será necessário compilar os drivers manualmente para o seu sistema. Prossiga para o item abaixo para maiores informações. +
+

+

Compilandos os drivers e iniciando os serviços

+

Basta seguir ao diretório /usr/src/khomp, descompactar o arquivo "kpdriver_2.0.0XX.tar.gz", e acompanhar procedimentos descritos no arquivo README.txt. +

Após realizar a compilação e a instalação do módulo, basta carregá-lo no sistema, configurar as placas, e iniciar o servidor de processos da Khomp. +

Para carregar o driver de kernel, é necessário executar o seguinte comando: + +

+
# /etc/init.d/khompdrv start
+
+

Para configurar as placas, por sua vez, necessário executar o comando: + +

+
# khompwizard
+
+

Isto executará um assistente de configuração, que irá perguntar a sinalização utilizada no sistema, bem como outros parâmetros de utilização das placas. +

Caso seja necessário configurar outros parâmetros adicionais, pode-se utilizar o seguinte comando: + +

+
# k3lconfig
+
+

Este configurador, por sua vez, mostra todas as opções possíveis de configuração da placa. Os parâmetros que não forem configurados assumem os valores padrão automaticamente, e são compatíveis com a maior parte dos sistemas. Maiores detalhes sobre este programa podem ser obtidos na seção de número '2'. +


+

+
  • IMPORTANTE: Para o FreeSWITCH iniciar, é preciso que a placa da khomp esteja configurada e todos módulos estejam rodando (conforme mostrado acima). Caso a placa não esteja configurada, o FreeSWITCH não iniciará.

    Se você deseja rodar o sistema sem a placa da Khomp, é preciso configurar o FreeSWITCH para ele não carregar o módulo da Khomp. Para isso, abra o arquivo "/usr/local/freeswitch/conf/autoload_configs/modules.conf.xml", e comente a linha que carrega o módulo:
    +
+
+  <!-- <load module="mod_khomp" /> -->
+

+

Quando a placa da Khomp estiver devidamente configurada e os módulos da khomp carregados (explicado acima), lembre-se de descomentar esta linha no arquivo. +


+Por fim, para carregar o servidor de processos, basta executar o seguinte comando: + +

+
# kserver start
+
+

Após realizar estes procedimentos, o Endpoint já estará operacional, e o FreeSWITCH já pode ser carregado. +
+

+

Configurando parâmetros especiais de sinalização ou áudio

+

Para configurar parâmetros especiais de sincronismo e/ou sinalização, é possível utilizar o programa "k3lconfig": basta selecionar a placa desejada, e as opções das placas serão apresentadas, divididas em seções e subseções para facilitar o acesso. Não é necessário efetuar a configuração de todos os parâmetros: os valores padrão são assumidos, caso não sejam configurados. +

Para ajustar a sinalização do link, basta - depois de selecionar a placa - entrar na seção "Opções de sinalização", e em seguida, em "Sinalização da linha". Para escolher uma sinalização específica, basta utilizar as teclas de direcionamento (setas) até selecioná-la, pressionar 'espaço', e confirmar a opção pressionando 'Enter' sobre o botão "Confirmar". +

Por fim, para salvar as configurações modificadas, basta sair do programa: ele irá mostrar uma janela, com opções para salvar ou não as alterações realizadas. +

É importante notar que não é necessário alterar/ativar as seguintes opções: +

+
  • Cancelamento de eco automático; +
  • Supressão de DTMFs automática; +
  • Controle de ganho (AGC) automático. +
+

Estas opções são controladas pelo Endpoint, e devem estar desabilitadas no 'k3lconfig'. +
+

+

Inicialização automática dos serviços e módulos de kernel

+

Se a carga dos módulos de kernel ou a inicialização dos serviços da Khomp não for realizada automaticamente na inicialização do sistema, é possível realizar esta instalação manualmente, criando um link para os scripts /etc/init.d/khompdrv e /etc/init.d/kserver no diretório de inicialização do sistema. +

Na caso da distribuição Debian, o script de carga dos módulos de kernel seria linkado dentro do diretório /etc/rcS.d/, enquanto o script de inicialização dos serviços seria linkado dentro dos diretórios /etc/rc2.d, /etc/rc3.d, /etc/rc4.d, /etc/rc5.d, da seguinte forma: +

+

+
# ln -s /etc/init.d/khompdrv  /etc/rcS.d/S19khompdrv
+# ln -s /etc/init.d/kserver   /etc/rc2.d/S20kserver
+# ln -s /etc/init.d/kserver   /etc/rc3.d/S20kserver
+# ln -s /etc/init.d/kserver   /etc/rc4.d/S20kserver
+# ln -s /etc/init.d/kserver   /etc/rc5.d/S20kserver
+
+

É interessante verificar as normas da sua distribuição para inicializar os serviços de acordo com o que é esperado pela inicialização da mesma. +
+

+

Apêndice

+

Nesta seção, encontram-se informações úteis sobre o Endpoint e componentes relacionados. +

+

Disposição dos arquivos

+

Os diretórios criados/modificados nesta instalação são: + +

+
/etc/init.d/                -- Scripts de inicialização;
+
+/etc/khomp/                 -- Arquivos de firmware e configurações;
+
+/usr/local/freeswitch/conf/ -- Configurações do FreeSWITCH e Endpoint;
+
+/usr/doc/khomp/             -- Documentação das placas, do mod_khomp e dos utilitários;
+
+/usr/sbin/                  -- Utilitários e servidor de processos;
+
+/usr/lib/                   -- Bibliotecas compartilhadas da K3L;
+
+/usr/local/freeswitch/mod/  -- Módulo 'mod_khomp.so';
+ 
+/var/log/khomp2.1/          -- Diretório de logs da K3L e Endpoint
+
+


+O script /etc/init.d/khompdrv é responsável por carregar os módulos kpci9030.ko e kpex8311.ko no kernel, que deve ser realizada automaticamente na inicialização do sistema. Em caso de problemas, verifique a seção Solução de problemas. +
+


+

\ No newline at end of file diff --git a/src/mod/endpoints/mod_khomp/docs/Manual.pdf b/src/mod/endpoints/mod_khomp/docs/Manual.pdf new file mode 100644 index 0000000000..ea29f716ec Binary files /dev/null and b/src/mod/endpoints/mod_khomp/docs/Manual.pdf differ diff --git a/src/mod/endpoints/mod_khomp/docs/README.html b/src/mod/endpoints/mod_khomp/docs/README.html new file mode 100644 index 0000000000..e4cae5ad3b --- /dev/null +++ b/src/mod/endpoints/mod_khomp/docs/README.html @@ -0,0 +1,39 @@ +Mod Khomp: README

Guia Rápido

+

Depois de instalar a placa no sistema, e executar o programa de instalação pela primeira vez, os drivers e serviços da Khomp serão adicionados na inicialização do sistema, e automaticamente carregados. +

Se o sistema possuir pelo menos uma placa de tronco E1 e/ou uma placa FXO, uma tela de configuração básica deverá ser apresentada ao final do processo, questionando parâmetros de sinalização - no caso de existirem placas E1 - e/ou realizando o ajuste de cadências - no caso de existirem placas FXO. +

Se todas estas etapas foram executadas com sucesso, prossiga para o item Utilizando o Endpoint da Khomp. Caso algum problema ocorra, consulte o Manual do Endpoint, seguindo para a seção de Solução de problemas. +

+

Utilizando o Endpoint da Khomp

+

Após a instalação e inicialização dos serviços necessários pela Khomp, o FreeSWITCH já pode ser carregado ou inicializado. +

+
  • AVISO: É imprescindível que o FreeSWITCH não seja executado utilizando a opção que desabilita o escalonamento em tempo real (-nort), especialmente se este estiver sendo executado lado-a-lado com servidores web ou servidores de banco de dados. Não realizar este procedimento pode resultar em perda de qualidade do áudio, gerando um sério comprometimento no andamento das ligações do sistema. +
+

Após a inicialização do FreeSWITCH, pode-se verificar se o módulo da Khomp foi carregado através do seguinte comando:
+

+
 freeswitch@hostname> module_exists mod_khomp
+
+

A próxima linha deverá responder algo tipo: +

+
 true
+
+

Para verificar se o FreeSWITCH reconheceu todas as placas, digite: +

+
 freeswitch@hostname> khomp summary
+
+

A saída desse comando mostrará detalhes de todas placas reconhecidas. +

No caso de uma placa de tronco E1, pode-se verificar o estado dos links com o seguinte comando: +

+
 freeswitch@hostname> khomp show links
+
+

O estado dos canais individuais, por sua vez, pode ser aferido com o comando: +

+
 freeswitch@hostname> khomp show channels
+
+

Para mais detalhes sobre os comandos do Endpoint da khomp digite no console do FreeSWITCH: +

+
 freeswitch@hostname> help khomp
+
+
  • IMPORTANTE: Para fazer completo uso da sua placa Khomp, será preciso configurar suas regras de discagem, seja através do arquivo default.xml ou de um aplicativo externo, definindo regras específicas para realizar ao receber ligações.

    No Manual do Endpoint, podem ser encontradas informações sobre o formato dos contextos de entrada (responsáveis por receber as ligações) e sobre as opções disponíveis no application Bridge (responsável por realizar ligações) que podem ser utilizadas com o Endpoint da Khomp, além de outras funcionalidades especiais providas pelo mesmo. +
+


+

\ No newline at end of file diff --git a/src/mod/endpoints/mod_khomp/docs/README.pdf b/src/mod/endpoints/mod_khomp/docs/README.pdf new file mode 100644 index 0000000000..698ab83dae Binary files /dev/null and b/src/mod/endpoints/mod_khomp/docs/README.pdf differ diff --git a/src/mod/endpoints/mod_khomp/docs/README_en.html b/src/mod/endpoints/mod_khomp/docs/README_en.html new file mode 100644 index 0000000000..5d44b8219f --- /dev/null +++ b/src/mod/endpoints/mod_khomp/docs/README_en.html @@ -0,0 +1,40 @@ +Mod Khomp: README: en

Quick guide

+

After installing the card in the system and run the installation program for the first time, the drivers and Khomp services will be added at system startup, and automatically loaded. +

If your system has at least one E1 trunk card and / or an FXO card, a basic setup screen will be presented at the end of the process, questioning signaling parameters - if there are signs E1 - and/or performing the adjustment cadences - where that FXO cards. +

If all these steps were performed successfully, proceed to the item Using Khomp Endpoint. If a problem occurs, see the User Guide, in the section Troubleshooting. +

+

Using the Khomp Endpoint

+

After installation and startup services required by Khomp, FreeSWITCH can now be loaded or initialized. +

+
  • WARNING: It is imperative that theFreeSWITCH is not executed using the option that disables the escalation in real time (-nort), especially if this is running side-by server-side with web servers or database. Failure to do so may result in loss of audio quality, causing a serious commitment on the progress of system connections. +
+

After initialization of FreeSWITCH, you can verify that the module was loaded Khomp through the following command:
+


+

+
 freeswitch@hostname> module_exists mod_khomp
+
+

The next line should answer something like: +

+
 true
+
+

To verify that the FreeSwitch recognize all the cards, type: +

+
 freeswitch@hostname> khomp summary
+
+

The output of this command will show details of all cards accepted. +

In the case of an E1 card, you can check the status of links with the following command: +

+
 freeswitch@hostname> khomp show links
+
+

The state of individual channels, in turn, can be measured with the command: +

+
 freeswitch@hostname> khomp show channels
+
+

For more details on the commands of the Endpoint khomp type in the console of FreeSWITCH: +

+
 freeswitch@hostname> help khomp
+
+
  • IMPORTANT: To make full use of your card Khomp, you must configure your dialing rules, either through the extension.conf or from an external application by setting specific rules for conduct by receiving connections.
    In the User Guide, information can be found on the format of input contexts (responsible for receiving calls) and on the options available on application Dial (responsible for make calls) that can be used with the Endpoint Khomp, and other special features provided by it. +
+


+

\ No newline at end of file diff --git a/src/mod/endpoints/mod_khomp/docs/README_en.pdf b/src/mod/endpoints/mod_khomp/docs/README_en.pdf new file mode 100644 index 0000000000..e36d6f1191 Binary files /dev/null and b/src/mod/endpoints/mod_khomp/docs/README_en.pdf differ diff --git a/src/mod/endpoints/mod_khomp/docs/User_Guide.html b/src/mod/endpoints/mod_khomp/docs/User_Guide.html new file mode 100644 index 0000000000..1a276b9e37 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/docs/User_Guide.html @@ -0,0 +1,1099 @@ +Mod Khomp: User Guide +

First considerations

+

This document covers information about the Endpoint of Khomp as a whole, include the options, applications, CLI commands, among others. +

For first installation procedures, please see the README. +
+

+

Configuration

+

Configuring the Khomp Endpoint is a task that consists of three steps: +

+
  • Configuration of the boards through the K3L; +
  • Setting up the Endpoint; +
  • Setting up the FreeSWITCH. +
+

These steps are described more fully below. +
+

+

K3L API Configuration

+

This step is carried out in a semi-automated way using the khompwizard program, a wizard that configures the basic parameters of the system boards. This wizard initializes the configuration files using information from the user when they are needed, initializing the standard settings to default values. +

Typically, this program runs automatically after installation of the system. However, you may need to run it manually if an update is being performed, or if new cards were added to the system after installing new drivers. +


+If you need to set advanced parameters of the board and/or signaling, the program k3lconfig allows you to access all the available settings for each installed card. For more information about this program, check the k3lconfig User's Guide. For solving synchronization issues, check the Troubleshooting section for manual configuration of the boards. +
+

+

Endpoint Configuration

+

The system's default configuration normally meet most user's needs. However, the configuration of the Endpoint Khomp can be modified through the configuration file '/usr/local/freeswitch/conf/autoload_configs/khomp.conf.xml'. +

The list of options is as follows: +

+

<channels>

+

Define general settings of all channels of Khomp: +

+
Sintaxe: <param name="..." value="..."/>
+
+
  • auto-fax-adjustment: Enable ("yes") or disables ("no") the automatic adjustment of the channel (disable the echo canceller and the suppression DTMF) tone to detect FAX (local option) ; +
  • auto-gain-control:Enable ("yes") or disables ("no") the activation of the automatic gain control (AGC) by the Endpoint (local option); +
  • context-digital: Context for incoming connections on digital boards (the default is "khomp-DD-LL", where "DD" will be replaced at the time of connection by the device number, "LL" by the number of the link, "CCC" by channel number and "SSSS" for the device serial number); +
  • context-fxo: Context for incoming connections on FXO cards (the default is "khomp-CC-DD", where "DD" will be replaced at the time of connection by the device number, "CC" by channel number, and "SSSS" by the device serial number); +
  • context-fxo-alt: Alternative input context for FXO cards (the default is empty - when set, follows the same substitution rules for context-fxo); +
  • context-fxs: Context for incoming connections on FXS cards (the default is "khomp-CC-DD", where "DD" will be replaced at the time of connection by the device number, "CC" by channel number, and "SSSS" by the device serial number); +
  • context-fxs-alt: Alternative input context for FXS cards (the default is empty - when set, follows the same substitution rules for context-fxs); number); +
  • context-gsm-call (or context-gsm): Context of entry for GSM boards (the default is "khomp-CC-DD", where "DD" will be replaced at the time of connection by the device number, "CC" by channel number, and "SSSS" by the device serial number); +
  • context-gsm-alt-call (or context-gsm-alt): Alternative input context for GSM (the default is zero - when set, follows the same substitution rules for context-gsm-call); +
  • context-gsm-sms: Context for incoming SMSs (the default is "khomp-sms-CC-DD", where "DD" will be replaced by the number of device, "CC" by channel number and "SSSS" by the device's serial number); +
  • context-gsm-wait: Context used for pre-processing of incoming GSM calls that are on waiting state - to disable this feature, use none (the default is "khomp-wait-CC-DD", where "DD" will be replaced by the number of device, "CC" by channel number and "SSSS" by the device's serial number); +
  • context-pr: Context for incoming connections on boards KPR (default is "khomp-CC-DD", where "DD" will be replaced at the time of connection by the device number, "CC "by channel number); +
  • disconnect-delay: Sets the time in milliseconds to perform processing a disconnect event, to ignore situations where other equipment performing the double service to overthrow collect calls (local option); +
  • echo-canceller (former 'echocanceller): Active ("yes") or disables ("no") echo cancellation automatic Endpoint (local option); +
  • fxo-send-pre-audio: When enabled ("yes") releases audio channel before the outgoing call connection boards KFXO (the default value is "yes"); +
  • fxs-global-orig: Start number for sequencial branch numbering in FXS cards that are not listed in the [fxs-branches] section (the numbering follows ascending order from board number and physical channel number) (default is "0"); +
  • fxs-co-dialtone: Sequences of numbers, separated by commas, which fires a continuous tone (of central office) in FXS branches (eg: "0,99" means that, when you dial "0" or "99", the user will hear a continuous dial tone) (default is empty); +
  • fxs-bina: When enabled ("yes"), calls to FXS lines will send digits corresponding to the source phone identification using BINA DTMF signaling (the default value is "no") (local option); +
  • input-volume: Sets the volume gain for incoming audio (entering the board), from -10 to +10 (local option); +
  • kommuter-activation: Sets whether to activate devices kommuter found in the system will be done automatically ("auto") by the channel, or manually ("manual") by the user through the command "khomp kommuter on/off" +
  • kommuter-timeout: Sets the timeout (in seconds) for initializing the kommuter devices. If this timeout is reached without receiving notification of the channel, the devices will switch back to "off" condition. The minimum value is "0", where the links will always remain switched "on", and the maximum is "255"; +
  • language: Set language to Khomp channel calls (local option); +
  • log-to-console: Set log messages to be printed on the console; +
  • log-to-disk (old "log"): Set log messages to be saved to disk; +
  • out-of-band-DTMF (former dtmfsuppression): Activate ("yes") or disables ("no") the removal and DTMF sending these out-of-band (local option); +
  • output-volume: Define o volume de saída das ligações, varia de -10 a +10 ; +
  • pulse-forwarding (former 'pulsedetection): Active ("yes") or disables ("no") for the detection of pulses and converting them into DTMF (local option); +
  • r2-preconnect-wait (former 'r2preconnectwait): Sets the timeout sending the ringback signaling, protocol R2/MFC to start sending audio silence. Only used when "r2-strict-Behavior" is set to "no" (local option); +
  • r2-strict-Behaviour: Enable ("yes") or disables ("no") the behavior of signaling R2/MFC as the standard sets. The default is "no", and can be changed to "yes" if needed to receive / send data precise signaling protocol (condition B, for example) (local option); +
  • ringback-delay-co: Sets the delay to enable the generation of call control tone (ringback) by the Endpoint Khomp when there is an ringback indication from signaling and there is no audio being sent by the channel which indicated the situation (local option); +
  • ringback-delay-pbx: Sets the delay to enable the generation of call control tone (ringback) by the Endpoint Khomp when there is an ringback indication, and the audio has no tone (silence) (local option); +
  • suppression-delay (former suppressiondelay): Activate ("yes") or disables ("no") the delay necessary to suppress DTMF. If disabled ("no"), also disables suppression of DTMF (local option); +
  • trace: Set debugging options. Should not be used in production unless absolutely necessary; +
  • user-transfer-digits: Defines a sequence of DTMF digits to initiate the transfer between FreeSWITCH® and another PBX (using user signaling, like QSig or FXO FLASH). +
+


+

+

<groups>

+

Defines the groups to be used in channel allocation. +

In this case, the options are used to define names for strings allocation of channels. The format follows the standard <group name> = <allocation string>, where the allocation string is the same string used in the bridge application, and group name is an arbitrary name chosen by the user. +

+
For example, to define the group pstn as the channels 0 and 5 of the board 0, the following line could be used: +
+
<param name="pstn" value="b0c0 + b0c5"/> 
+
+

This group, in turn, could be used in the bridge application as <action application="bridge" data="Khomp/Gpstn/..."/>. +

+
You can associate a given input context to a channel group, simply specify a name of context string after the allocation, separated by ':'. +
+

For example, to define the same group pstn as channels 0 to 20 of card 0, and defining the incoming context to for channels in this groups to from-pstn, one could use the line: +

+
<param name="pstn" value="b0c0-20:from-pstn"/>
+
+

This group would be used the same way as before in the bridge application, and all the calls coming from these channels would be treated in context from-pstn. +
+

+

<cadences>

+

Defines settings for the Endpoint cadences. +

In this case, the options are names cadences, followed by one or two pairs of numbers - that define the ranges of tone and silence to be used in cadences. +For details, please refer to the configuration file for examples. +
+

+

<fxs-branches>

+

Defines source numbers for the board KFXS. +

In this case, the options are sequences of prefixes of branches and serial numbers of the boards, which define the basic numbers of source addresses, and the numerical order of the boards. The format of the options is: +

+
<param name="prefixo" value="serial1, serial2, ...."/>
+
+

For example, if two KFXS-300 SPX boards with serial numbers K0374 and K2352 must be numbered sequentially, starting from branch 200, you may write: +

+
<param name="200" value="374, 2352"/>
+
+

This will define the first branch of board 'K0374 as number 200, the second as 201, and so one. The first branch from board K2352 will have number 230 (as K0374 has 30 channels), the second will be numbered 231, and so on - until the last channel, numbered 259. +

For more details, please refer to the configuration file for other exemples. +
+

+

<fxs-hotlines>

+

Sets hotlines for the KFXS based boards +

In this case, the options are sequences of branches and sequences of destination numbers, which define branches to be treated as "hotlines" and numbers to be dialed when they are take off hook. For instance: +

+
<param name="100" value="1234"/>
+<param name="200" value="4321"/> 
+
+

In the first line, the branch numbered 100 will call extension 1234 when taken off hook, while in the second one, branch 200 will call number 4321 when taken off hook. +
+

+

<fxs-options>

+

Allows you to set specific settings for FXS extension. +

In this case, the settings are extension numbers (based on those defined in the <fxs-branches>), and the options and their values. +

+
  • context; +
  • input-volume; +
  • output-volume; +
  • accountcode; +
  • calleridnum; +
  • calleridname; +
  • mailbox. +
+

Each option is separated from each other by a pipe "|" or a slash "/" and defined after the colon ":". Example: +

+
<param name="200" value="language:en|context:master-branch" />
+
+

For more information on the syntax and examples, please refer to the configuration file. +

For more information visit the configuration file 'khomp.conf.xml'. +
+

+

FreeSWITCH Configuration

+

When connections are received on the boards and devices Khomp, they are forwarded by the Endpoint to specific contexts within the dialplan of FreeSWITCH®. These settings can be changed via the configuration file khomp.conf.xml, available on the FreeSWITCH configuration directory (by default, "/usr/local/freeswitch/conf/autoload_configs"). +

For details about the specific contexts, see section Endpoint configuration. +

Below are details of how to configure the settings for incoming calls +
+


+

+

Contexts for E1 channels

+

For E1 boards, inbound contexts are predefined as option context-digital with default value as following: +

+
<param name="context-digital" value="khomp-DD-LL"/>
+
+

This standard defines the context that links will be redirected in accordance with the number of the board and number of the link: DD is the device number (two digits), and LL is the number of the link (also with two digits). +

However, it is possible to configure other inbound contexts, with different formats. There is format CCC, which means the channel number on the card (three digits), and SSSS, which represents the serial board number (with four digits). +

Examples for configuration entries (khomp.conf.xml): +

+
<!-- Serial board number and sequential link (ex: khomp-01-00) -->
+<param name="context-digital" value="khomp-DD-LL"/>
+
+
<!-- Serial board number and sequential link (ex: khomp-3049-00) -->
+<param name="context-digital" value="khomp-SSSS-LL"/>
+
+
<!-- Sequential board number and the channel (ex: khomp-00-001) -->
+<param name="context-digital" value="khomp-DD-CCC"/>
+
+
<!-- Receive all calls in one context (khomp-digital) -->
+<param name="context-digital" value="khomp-digital"/>
+
+

Follows an example the context usage inside the dialplan: + +

+
<!--
+The present context in 'extensions.conf' will handle calls
+that come from the link 0 (first link) of the board 0.
+-->
+<context name="khomp-00-00">
+             .
+             .
+             .
+</context>
+
+

Another example, using the same format: + +

+
<!-- 
+The present context in 'extensions.conf' will handle calls
+that come from the link 1 (second link) of the board 0.
+-->
+<context name="khomp-00-01>
+             .
+             .
+             .
+</context>
+
+

A complete example, with a few simple actions: + +

+
<context name="khomp-00-00">
+    <extension name="exemplo_1">
+        <condition field="destination_number" expression="^1234$">
+            <action application="bridge" data="Khomp/b0L1/2345"/>
+        </condition>
+    </extension>
+    <extension name="exemplo_2">
+        <condition field="destination_number" expression="^23(\d{2})$">
+            <action application="bridge" data="sofia/${use_profile}/11$1@${sip_from_host}"/>
+        </condition>
+    </extension>
+</context>
+
+
<context name="khomp-00-01">
+    <extension name="exemplo_3">
+        <condition field="destination_number" expression="^1111$">
+            <action application="bridge" data="Khomp/b0L0/2345"/>
+        </condition>
+    </extension>
+</context>
+
+

This dialplan defines that: +

+
  1. The incoming calls on the link 0 of the board 0 will have the following handling: +
    • Calls to the extension 1234 for will be redirected to the second link on the first board (b0L1), calling number 2345; +
    • Calls to any four digit number starting with23 will be redirected to SIP phones numbered 11 plus the last two digits of the number dialed. +
    +
  2. The incoming calls on the link 1 of the board 0 for the number 1111 will be redirected to the first link of the first board (b0L0) calling number 2345. +
+

Contexts of FXS/FXO/GSM channels

+

Just as in the context of E1 cards, inbound links are forwarded to the Endpoint FreeSwitch. However, these signals have two pre-defined contexts, sought with a preference order. +

The first context is pre-defined as follows, according to the file khomp.conf.xml: +

+
<param name="context-gsm" value="khomp-DD-CC"/> ;placas GSM
+
+
<param name="context-fxs" value="khomp-DD-CC"/> ; placas FXS
+
+
<param name="context-fxo" value="khomp-DD-CC"/> ; placas FXO
+
+

There is also an alternative context, which has the following default value: +

+
<param name="context-gsm-alt" value="khomp-DD"/> ; placas GSM
+
+
<param name="context-fxs-alt" value="khomp-DD"/> ; placas FXS
+
+
<param name="context-fxo-alt" value="khomp-DD"/> ; placas FXO
+
+

For these options, DD is the device number (two digits), and CC is the channel number (also two digits). There is also the SSSS format, which represents the serial number board. +

+
  • NOTE: In the KGSM board, incoming calls are always redirected to the "s" extension, since the GSM protocol does not identify the target number, only the originator - if not omitted. +
+

Priority settings on the FXS branches

+

On calls originated from an FXS branch, the Endpoint searches for a valid extension in three different contexts. The priority of contexts is as follows: +

+
  1. Branch-specific extension, defined in section <fxs-options> of file khomp.conf.xml; +
  2. Context defined in context-fxs; +
  3. Context defined in context-fxs-alt. +
+

If no valid extension can be found, the extension i is searched in the contexts above, and also in the default context. If the dialing timeout is reached (option fxs-digit-timeout), the search will consider all digits dialed until the timeout; if no extension is found, it will search extension "t"; if nothing is found again, then extension "i" will be searched; if no extension is found, "fast-busy" cadence will be played. +
+

+

Contexts for SMS messages (GSM only)

+

SMS messages are received by the Khomp Endpoint and forwarded to FreeSWITCH as a normal connection but no audio, which has some variables set with information received in the message - for more information on these variables, see the documentation of the variables of the Endpoint. This context can also be modified in the same way as the above contexts. +

The default value for this option follows (khomp.conf.xml): +

+
<param name="context-gsm-sms" value="khomp-sms-DD-CC"/> 
+
+

Where DD is the device number (two digits), and CC is the channel number (also with two digits). For example: +

+
<context name="khomp-sms-00-01">
+    <extension name="sms">
+        <condition field="destination_number" expression="^s$">
+            <action application="log" data="DEBUG KSmsType=${KSmsType}"/>
+            <action application="log" data="DEBUG KSmsBody=${KSmsBody}"/>
+        </condition>
+    </extension>
+</context>
+
+

Contexts for Khomp_PR channels (KPR)

+

For these cards, inbound links have a pre-defined context, as shown below: +

+
<param name="context-pr" value="khomp-DD-CC"/> 
+
+

In this case, DD is the device number (two digits), andCC is the channel number (also two digits). The name and format of this context can also be changed through the "context-pr" in the configuration file. +
+
+

+

Using the bridge application

+

The bridge application is responsible for generating calls from the FreeSWITCH from a dialplan. This application can be used to generate calls from different Endpoints technologies, following a specific format to define destination, dialing options and define the communication Endpoint to be used. +

+

Fields relating to the Khomp Endpoint

+

When used for Khomp channels, the bridge string can have two, three or four fields separated by slash (/). Some example strings: + +

+
<action application="bridge" data="Khomp/B2L0/32625644"/>
+<action application="bridge" data="Khomp/*B2L0/32625644"/>
+<action application="bridge" data="Khomp/S0411/99991234"/>
+<action application="bridge" data="Khomp/Gpstn/99991234"/>
+<action application="bridge" data="Khomp/*Gpstn/99991234"/>
+<action application="bridge" data="Khomp/B2C58/32625644/category=4:orig=4855553232"/>
+<action application="bridge" data="Khomp/b0c9"/>
+<action application="bridge" data="Khomp/b0c1+b0c14"/>
+<action application="bridge" data="Khomp/r304"/>
+
+

In the first five examples, three fields have been specified; in the sixth, four fields are used; in the last three examples, just two are used. +

The fields description for the Khomp Endpoint: +

+
  • 1st field: Khomp: identifying the type of Endpoint in question; +
  • 2nd field: B2L0, S0411, Gpstn, etc: represents the Policy for channel allocation (detailed below); +
  • 3rd field: 32625644 and 99991234: the destination numbers (missing for calls to KFXS channels); +
  • 4th field: category=4:orig=4855553232: additional options, detailed below. +
+

NOTE: The bridge allocation string with only two fields is specific to the KFXS boards, where the destination is the channel itself. +

+

Policy for channel allocation

+

The policy for allocation of channels on the Khomp Endpoint can be specified in the bridge string itself or in the groups section (inside the configuration file khomp.conx.conf). To specify boards, links and channels, the following syntax is available (considering X, Y and Z as any numbers): +

+
  • bX -- search the channels on the board X, ascending order; +
  • bXLY -- search channel on the link Y from X board, ascending order; +
  • bXcY -- try to allocate channel Y from board X; +
  • bXcY-Z -- search for channels starting from channel Y to channel Z (inclusive) of board X, ascending order; +
  • BXcY-Z -- same as above, but descending order; +
  • sX -- search the channels on the board of serial number X, ascending order; +
  • sXLY -- search channel on the link Y from board of serial number X, ascending order; +
  • sXcY -- try to allocate channel Y from board of serial number X; +
  • sXcY-Z -- search for channels starting from channel Y to channel Z (inclusive) from board of serial number X, ascending order; +
  • SXcY-Z-- same as above, but descending order. +
+

To search for extensions of cardsKFXS according to the extension number, can be used the following syntax (whereas X and Y valid extension numbers): +

+
  • rX- search branch numbered X; +
  • RX- equivalent to the above; +
  • rX-Y- search from branch X to Y, ascending order; +
  • RX-Y- search from branch X to Y, descending order. +
+

The capitalization of the letter 'B', 'S' or 'R' defines the search order of the channels: if capitalized, order is descending; otherwise, ascending. +

As for the allocation of channels across groups, the following syntax is available: +

+
  • ggroupname - uses the string defined the group "groupname" in the configuration file (detailed in the configuration section of the Endpoint). +
  • Ggroupname - equivalent to the above. +
+

Grouping channel allocations

+

There are cases where you need to get more channels for a particular device or particular group of extensions. For this, there is an extension available in string allocation, with respect to the use of token sum (+) to concatenate multiple stringsbinding, as follows: + +

+
<action application="bridge" data="Khomp/B1L0+B2L0/32332933"/>
+<action application="bridge" data="Khomp/*B2+B3+B4/99887766"/>
+<action application="bridge" data="Khomp/S0411+B1L0/99887766"/>
+<action application="bridge" data="Khomp/Gpstn1+Gpstn2/99991234"/>
+<action application="bridge" data="Khomp/*gOperadora1+gOperadora2/98891234"/>
+
+

This grouping is available for the application bridge and on the specification of groups. The processing of allocation takes place from left to right - except when using cyclic channel allocation, whereall the specified channels are scanned simultaneously. +

+

Cyclical and/or fair allocation

+

Another way for allocation of channels is the cyclic and/or fair allocation, which chooses the channel that has completed the the lowest number of outgoing calls. This mode of allocation may be used by passing an asterisk (*) before the allocation string of channels (as can be seen in the section above, in the second and fifth examples). +

When started with an asterisk (*), other forms of allocation (increasing, decreasing, etc) are used to decide what channel will be allocated when there are two or more channels with less number of outgoing calls. +

+
  • WARNING: The use of fair and/or cyclic is recommended only for analog (KFXO), branches (KFXS) and cellular interface (KGSM) boards. E1 connections should allocate channels in one way (ascending/descending) from one side and the opposite on the other to avoid problems of double seizure (which may occur in R2/MFC signaling). Fair/cyclic allocation also costs more in memory and processor footprint, which tends to be a higher cost in E1 due to the higher number of channels (30 in each link).

    For these reasons, fair/cyclic allocations should only be used on signalizations where it can represent any real difference, like equalizing the charge costs of the lines, the total usage, or the number of connections received by each branch. +
+

Available options

+
  • orig: Sets the originator number, without changing the variable ${CALLERID(num)}. That is, the option orig serves only to pass a number of different source of${origination_caller_id_number}. If FreeSWITCH has already set the variable ${origination_caller_id_number}, which is the default behavior, Endpoint automatically uses this value as a reference to the number of origin, without having to pass any additional options.

    On the boards KGSM, is set to restricted, omits the number of origin. Example:
    +
+
+ <action application="bridge" data="Khomp/b0/99887766/orig=restricted"/>
+
+
  • category: When set to a numeric value, sets the category of outgoing call to this value (available only in R2/MFC signaling); +
  • uui: When adjusted for a number and a string of text, separated by hash ("#"), sends a "UserToUser" to the other end before making the call - the first value will be the descriptor and the second one will be the message as the text (available only in ISDN signaling); +
  • ring_cadence: When set to a cadence name (listed in the [cadences] section), uses this for ringing FXS channels; +
  • ring: When set to two numbers separated by a dot ("."), defines the cadences to be used while ringing a FXS channel - the first time is the ringing time, and the second one, the silence time; +
  • ring_ext: When set to two numbers separated by a dot ("."), defines the extended cadences to be used while ringing a FXS channel, executed after the ring specification - the first time +
  • usr_xfer: Defines a group of DTMF digits to initiate a transfer between PBXes (using QSig or FXO FLASH, for instance); +
  • drop_on: When set to "message_box", "human_answer", "answering_machine", "carrier_message", "unknown" or a list them - separated by plus sign ("+") or dot ("." ) - drops the call when detect voice mail box, human answer, answering machine messages, operator messages, or unknown answer pattern - respectively. Available in digital signals (E1 links and boards KGSM). Additionally, the information service is reported to the user in the variableKCallAnswerInfo; +
  • answer_info: When specified (take no parameters), report answer information to the user through the variableKCallAnswerInfo +
  • pre: When set to a string of DTMF digits, uses these to pre-allocate an output channel in an analog PABX, dial the desired number of B below. Only available for signaling analog (FXO); +
  • pre_answer: When set (need no value), answers the channel before the connection is completed - allowing, for instance, DTMF tones to sent (useful for use in a DISA); +
  • output_volume: Sets the output volume of the link (ranges from -10 to +10); +
  • input_volume: Sets the volume of inbound link (ranges from -10 to +10); +
+


+

+

List of variables

+

Here's a list of variables available in the Endpoint: +

+
  • KDropCollectCall: When set before ringing or answer an incoming call, enables ("yes") or disables ("no", default) the drop of collect calls based on signaling received from the central public, double answer, audio tone recognition (can be defined globally); +
  • KR2SendCondition: When set to a numeric value, before the ringing an incoming call, adjusts the condition for this Endpoint to this value (available only on R2 signaling); +
  • KR2GotCategory: Adjusted by the Endpoint when an incoming call is received, with the category number of the caller (only available on R2 signaling); +
  • KR2GotCondition *: Adjusted by the Endpoint, available after returning from a call made by FreeSWITCH (bridge application). Has the condition of the remote end received when making the call (available only for R2 signaling); +
  • KISDNGotCause *: Adjusted by the Endpoint, available after returning from a call made by FreeSWITCH (bridge application). Has the ISDN "cause" code received when making the call (available only for ISDN signaling); +
  • KCallAnswerInfo *: Adjusted by the Endpoint, available after returning from a call made by FreeSWITCH (bridge application). Contains the service information identified to make the call (available only for digital signaling - E1 and GSM); +
  • KSmsDelivered: Adjusted by the Endpoint when sending a SMS message with the application KSendSMS, saying whether the message was delivered successfully ("yes") or not ("no"); +
  • KSmsErrorCode: Adjusted by the Endpoint when sending a SMS message with the application KSendSMS, containing the error code that happened when sending the message; +
  • KSmsErrorName: Adjusted by the Endpoint when sending a SMS message with the application KSendSMS, contains the name of the error or "None" if there has been no error; +
  • KSmsType: Adjusted for the input Endpoint in the context of SMS messages, defines the type of message received (can contain the values "message", "confirm" or "broadcast"; +
  • KSmsFrom: Adjusted for the input Endpoint in the context of SMS messages, sets the number of origin of the received message (available on types" message "and" confirm "); +
  • KSmsDate: Adjusted for the input Endpoint in the context of SMS messages, sets the date of sending the message (available on types "message" and "confirm"); +
  • KSmsSize: Adjusted for the input Endpoint in the context of SMS messages, contains the size (in bytes) of the received message (available on types "message" and "broadcast"); +
  • KSmsMode: Adjusted for the input Endpoint in the context of SMS messages, contains the encoding type of the received message (available on types "message" and "broadcast"); +
  • KSmsBody: Adjusted for the input Endpoint in the context of SMS messages, contains the text of the received message (available in types "message" and "broadcast"); +
  • KSmsDelivery: Adjusted for the input Endpoint in the context of SMS messages, containing the date of delivery of the message sent earlier (available in type "confirm"); +
  • KSmsStatus: Adjusted for the input Endpoint in the context of SMS messages, contains the status of the message sent earlier (available on the type "confirm"); +
  • KSmsSerial: Adjusted for the input Endpoint in the context of SMS messages, contains the serial number of the received message (available on the type "broadcast"); +
  • KSmsPage: Adjusted for the input Endpoint in the context of SMS messages, contains the page number of the received message (available on the type broadcast"); +
  • KSmsPages: Adjusted for the input Endpoint in the context of SMS messages, contains the total number of pages to be received (available in type "broadcast"); +
  • KUserInfoDescriptor: Sets/reports protocol descriptor of the User-to-User Information message (ISDN). +
  • KUserInfoData: Sets/reports data in the User-to-User Information message (ISDN). +
  • KFaxSent: Adjusted by the Endpoint when sending FAX with KSendFax application, and determines whether the fax was successfully sent ("yes") or not ("No"); +
  • KFaxReceived: Adjusted by channel when receiving FAX with KReceiveFax application, and determines whether the fax was successfully received ("yes") or not ("no"); +
  • KFaxResult: Adjusted by the channel when sending or receiving FAX with the application KSendFax or KReceiveFax (respectively), and defines the result of execution. +
+


+

+

Description of variables

+

Below, follows an explanation on how to use variables of Khomp Endpoint in the dialplan, to communicate and/or to receive information: +


+

+

KDropCollectCall

+

When activated, causes the Endpoint to drop Khomp collect calls through dual service (available for signaling 'R2 Digital' and FXO), through information available on the ISDN protocol and R2/MFC, or by detecting the audio call collect (available for any digital signage for E1, and GSM signaling). +

This variable is useful to filter collect calls to certain extensions, and must be set before making any type of answer - applications such as playback and bridge should always be executed after setting this variable, for example. +

For better functionality, is also recommended that no call status (ringback) is sent before this variable is set, so applications should be performed only after the correct setting of this variable. +

This variable can be set locally and globally, both to yes or no. The adjustment of global variable to yes will drop all the collect calls, unless the particular call is set to no - this allows the creation of a global filter of collect calls, with few exceptions. +

Enabling the variable in context default: +

+<context name="default"> +

+
<extension name="example">
+ .
+ .
+ .
+ <action aplication="set" data="KDropCollectCall=yes"/>
+ .
+ .
+ .
+</extension>
+
+

</context> +

Enabling the variable in the global context, remembering that it must be configured in the file vars.xml: + +

+
<X-PRE-PROCESS cmd="set" data="KDropCollectCall=yes"/>
+
+

KR2SendCondition

+

When you receive a call, can be set before sending ringback by FreeSWITCH (ie, before the run FreeSWITCH applications answer, bridge). When used in signaling R2/MFC, this variable sets the condition for B to the numeric value desired. +

Exemplo: + +

+
<!-- Condition "NUMBER CHANGED" warns the caller that the number of B has changed. -->
+<action application="KR2SendCondition" data="3"/>
+
+

KR2GotCategory

+

When you receive a call, is set by the Endpoint with the category received from the number that originated the call. It is set in signaling R2/MFC, and can be found anywhere in the dialplan. +

Example: + +

+
<action application="log" data="DEBUG KR2GotCategory [${KR2GotCategory}]"/>
+
+

KR2GotCondition

+

Variable adjusted by the Endpoint, and available after returning from a call made by FreeSWITCH. Has the condition of B received when making the call. Available only for signaling R2/MFC. +

Example: + +

+
<action application="log" data="DEBUG KR2GotCondition [${KR2GotCondition}]"/>
+
+

KUserInfoDescriptor

+

Variable adjusted by the Endpoint in the context of entry, from information received by the ISDN network functionality through user-to-User Information. Contains the descriptor number of the protocol used by the other end, and usually contains the value '0 ', but this is dependent on application. +

For further information, consult the specification ITU-T Q931 (more precisely, the specification table 4-26). +

Example (working with the descriptor number of the protocol): + +

+
<action application="log" data="DEBUG KUserInfoDescriptor [${KUserInfoDescriptor}]"/>
+
+

KUserInfoData

+

Variable adjusted by the channel in the context of entry, from information received by the ISDN network functionality through user-to-User Information. Contains the actual data, which were received in the form of a string of text. +

More information about this feature, see the specification ITU-T Q931. +

Example (working with the data received): + +

+
<action application="log" data="DEBUG KUserInfoData [${KUserInfoData}]"/>
+
+

It is important to note that the variables are sensitive to the capitalization of letters (case sensitive). +

+

KCallAnswerInfo

+

Variable adjusted by the Endpoint. It is set in outbound connections, representing the type of answer performed by the other end. May contain the following values: +

+
  • "MessageBox" (*): detected mailbox of a cell phone; +
  • "CarrierMessage": message sent before the service provider; +
  • "AnsweringMachine" (**): answering answering machine; +
  • "HumanAnswer" (**): human service; +
  • "Fax": reported when a fax tone is detected. +
  • "Unknown": unknown type of care; +
+
+

(*) This type of service is detected by signals at certain frequencies that are sent before the call comes into a mailbox, and vary by operator. The algorithm captures most of the mailboxes, but can fail if there is not a clear signal, or if it is not within the standards most commonly used; +

(**) The difference between these two types of care depends on the specific configuration using the program k3lanswerinfoconfig, with the detection only based on heuristics and never with an accuracy of 100%. +
+

+

Console commands

+

List of available commands in the console for the FreeSWITCH Endpoint of Khomp: +


+

+
  • khomp channels disconnect : Disconnect one or more channels. This command sends a message directly to the physical channel of the card in question, requesting a disconnection. Use with caution; +
  • khomp channels unblock : Unlock blocked channels for input or output. Only available in digital signage via E1; +
  • khomp clear links: Clears error counters on the links; +
  • khomp clear statistics: Clears the statistics of channel connections, or statistics for a particular channel; +
  • khomp get : Gets the number of options Endpoint Khomp; +
  • khomp kommuter : Enables or disables kommuters connected via USB on this machine. Only accessible when the configuration "kommuter-activation" is set to "manual". +
  • khomp kommuter count: Gets the amount of kommuters connected via USB on this machine; +
  • khomp log console: Sets options in the console logs; +
  • khomp log disk: Sets logging options to disk; +
    • khomp log console and khomp log disk have auxiliary options No, which reverses the selection of messages, and just, which generalizes the choice. Examples: +
      • khomp log disk just commands events (Enables only logging to the disk of commands and events); +
      • khomp log disk no commands (Disable logging to the disk of commands sent to board); +
      • khomp log disk warnings (Enables also logging to the disk of warnings from Endpoint). +
      +
    • More information on options for the log command, type: "help khomp log disk" or "help console log khomp". +
    +
  • khomp log rotate: Rotate log files from the Endpoint; +
  • khomp log status: Shows log messages currently being written to disk and displayed on the console; +
  • khomp log trace isdn: Enable Debugging ISDN signaling; +
  • khomp log trace k3l : Enables debugging low-level API K3L; +
  • khomp log trace r2 : Enables debugging low-level signaling R2/MFC; +
  • khomp reset links: Sends a reset command for a specific E1 of a particular card; +
  • khomp revision: Shows version number and revision of the Endpoint; +
  • khomp select sim: Select the SIM card, available on the boards KGSM; +
  • khomp send command : Sends command API K3L directly to the board (only for debugging, may compromise the stability of the system if used improperly); +
  • khomp send raw command : Sends a command directly to the DSP board (only for debugging, may compromise the stability of the system if used improperly); +
  • khomp set : Sets various options of the Endpoint Khomp; +
  • khomp show calls : Shows states for calls, may also listing specific channels or boards; +
  • khomp show channels : Shows the status of the channels Khomp and may also list specific adapter; +
  • khomp show links: Display states of E1 links available. +
  • khomp show statistics : Shows the statistics of channel connections, or statistics for a particular channel; +
  • khomp sms : Send an SMS message for a given number, using KGSM channels; +
  • khomp summary : Prints a summary of system boards and their features; +
+


+

+

Additional features

+

This chapter discusses additional features of the Endpoint, related to the special features present in certain signs. +
+

+

Aplicações (applications) e canais

+

The Endpoint Khomp, and to record a type of communication channel "Khomp" also records the following items: +
+

+

"KUserTransfer" application

+

Performs the transfer process from the current channel number for the extension using the signaling protocol QSig (Single Step Call Transfer) for boards configured with E1 ISDN signaling (ISDN), or use the FLASH command for FXO. +

The syntax follows: +

+
 <action application="KUserTransfer" data="number[,options])"/>
+
+

Example: +

+
<action application="answer"/>
+<action application="KUserTransfer" data="2345"/>
+
+

The fields have the following meanings: +

+
  • number: Number where the link should be transferred. +
  • options: Sets the transfer options to be used, which are: +
    • N: Wait until the channel is disconnected. +
    +
+


+

+

Application "KSendSMS"

+

This application has the function of sending SMS messages through the boards of KGSM Khomp using modules and SIM cards in the board to do so. The syntax of the application is as follows: +

+
<action application="KSendSMS" data="resource | destination | message" />
+
+

Each field can be summarized in: +

+
  • resource: The following is a syntax identical to the allocation of channels Dial application, and defines what modem use; +
  • destination: Number where to send the message, may be preceded or succeeded by! to request a confirmation of transmission; +
  • message: Text (without quotes) to be sent todestination. +
+

After sending the message, the variables KSmsDelivered and KSmsErrorCode will contain the result of the post. For more information about these, please consult the section on variables used in the Endpoint. +

Examples of use of this application are as follows: +

+
  • Sends "Test message." phone for "99887766" using the modem "1" (second modem) card "0": +
+
<action application="log" data="DEBUG Sending SMS ..." />
+<action application="KSendSMS" data="b0c1|99887766|Test message" />
+
+
  • Sends "Test message." phone for "99887766" using the first free modem card "0", and checks the return shipment: +
+
<action application="log" data="DEBUG  Sending SMS ..." />
+<action application="KSendSMS" data="b0|99887766|Test message" />
+<action application="log" data="DEBUG Sent? ${KSmsDelivered}" />
+<action application="log" data="DEBUG Code: ${KSmsErrorCode}" />
+<action application="log" data="DEBUG Desc: ${KSmsErrorName}" />
+
+
  • Sends "Test message." phone for "99887766" using the first free modem card "0", or the first free channel board "1" (if no free channel at the first sign): +
+
<action application="log" data="DEBUG Sending SMS ..." />
+<action application="KSendSMS" data="b0+b1|99887766|Test message" />
+
+
  • Sends "Test message." phone for "99887766" using the first free modem card "0", requesting confirmation: +
+
<action application="log" data="DEBUG Sending SMS ..." />
+<action application="KSendSMS" data="b0|99887766!|Test message" />
+
+


+

+

Application "KEchoCanceller"

+

This application has the function to enable or disable the echo canceller channel. +

+
<action application="KEchoCanceller" data="action[,options])"/>
+
+

Where: +

+
  • actions: It is on to enable the echo canceller, and off to disable; +
+

Example usage of this application: +

+
<action application="KEchoCanceller" data="off"/>
+
+


+

+

Application "KAutoGainControl"

+

This application has the function to enable or disable the automatic gain control in the channel. +

+
<action application="KAutoGainControl" data="action[,options])"/>
+
+

Where: +

+
  • actions: It is on to enable the automatic gain control, and off to disable; +
+

Example usage of this application: +

+
  <action application="KAutoGainControl" data="on"/>
+
+


+

+

Application "KDTMFSuppression"

+

This application has the function to enable or disable the suppression of DTMF channel. The syntax of the application is as follows: +

+
<action applicatin="KDTMFSuppression" value="action[,options])"/>
+
+

Where: +

+
  • actions: It ison to enable DTMF suppression, and off to disable; +
+

It is important to note that when disabled suppression of DTMF, DTMF tones are passed inband and will not be reported to FreeSWITCH. Thus FreeSWITCH does not recognize the DTMF tones, which may result in malfunction of applications such as IVR. +

Example usage of this application: +

+
<action applicatin="KDTMFSuppression" value="off"/>
+
+


+

+

Application "KSetVolume"

+

This application has the function to adjust the volume of incoming and outgoing channels Khomp, and its syntax as follows: +

+
<action application="KSetVolume" data="<volume>"/>
+<action application="KSetVolume" data="<output-volume>|<input-volume>"/>
+
+

Where the fields have the following meanings: +

+
  • volume: Sets the volume of input and output (-10 to +10); +
  • output-volume: Sets the output volume (-10 to +10, "none" for no change); +
  • input-volume: Sets the input level (-10 to +10, "none" for no change). +
+


+

+

Application "KAdjustForFax"

+

This application has the function of setting a channel for receiving Khomp signal FAX/modem, optimizing the communication channel for data traffic. Syntax: +

+
<action application="KAdjustForFax" data=""/>
+
+

This application does not receive parameters. Example of use: +

+
<action application="KAdjustForFax" data=""/>
+
+


+

+

Application "KSendFax"

+

This application has the function to send faxes using digital channels or FXO connections Khomp in pre-established, and its syntax as follows: +

+
<action application="KSendFax" data="<file>[:<file2>[:...]][|<faxid>]"/>
+
+

This application requires a license purchased separately to be used in digital (non-FXO) channels. Fields have the following meanings: +

+
  • file: Files to be sent to the fax should be encapsulated in TIFF format and have a resolution of 98, 196 or 392 dpi; +
  • faxid: the fax number. If not specified, the value is obtained by the id of the link, and if this also is not valid, the fax number will be set as default in K3L. +
+

Example usage of this application: +

+
<action application="KSendFax" data="/tmp/fax.tif:/home/root/fax2.tif,1234"/>
+
+


+

+

Application "KReceiveFax"

+

This application has the function of receiving digital channels or fax using the FXO Khomp, and its syntax as follows: +

+
<action application="KReceiveFax" data="<file>[|<faxid>]/>
+
+

This application requires a license purchased separately to be used in digital (non-FXO) channels. Fields have the following meanings: +

+
  • file: Name that file will be assigned to incoming fax. +
  • faxid: the fax number. If not specified, the value is obtained by the id of the link, and if this also is not valid, the fax number will be set as default in K3L. +
+

Example usage of this application: +

+
<action application="answer" />
+<action application="KReceiveFax" data="/tmp/fax.tif"/>
+
+


+

+

Channel "Khomp_SMS"

+

This communication channel is used to receive SMS and create incoming links in FreeSWITCH for each message received. This channel does not have any treatment or audio processing, and is called with five variables set: +

+
  • KSmsFrom, containing the number of source who sent the message; +
  • KSmsDate, which sets the date/time of receipt of the message; +
  • KSmsSize, representing the message size (in bytes); +
  • KSmsMode, containing the encoding used to transmit the message; +
  • KSmsBody, that is the message itself. +
+

The FreeSWITCH dialplan processing can be used to store this message in a database, run any application, among others. However, the only action accepted by this channel is shutdown (Hangup), so this incoming call should be considered a special dialplan execution without audio streams or channel allocation. +
+

+

Channel "Khomp_PR"

+

This communication channel is used to receive calls on boards passive recording (KPR family and KFXO-HI), creating incoming links on FreeSWITCH for each incoming call. This channel allows only receiving audio captured the linkby not allowing both the transmission of audio signalings as the control. +

The FreeSWITCH dialplan processing can be used to record data on this link in a database, perform some special application and/or some recording application (such as record), among others. However, the only action accepted by this channel is shutdown (Hangup), so this should not be considered a common call. +
+

+

Codes and meanings

+

This chapter presents the codes present in the channel Khomp and their meanings, used in both events as in the AMI console commands: +
+

+

Channel state

+

Reflect the state of the channel on the board. In the case of E1 links, the state may have one or more of the following: +

+
  • Free: the channel is free; +
  • Busy: the channel is not free (or occupied, or failure); +
  • Outgoing: the channel has an output connection; +
  • Incoming: the channel has an input connection; +
  • Locked: the channel is blocked; +
  • Outgoing Lock: The channel is blocked for outgoing calls; +
  • Local Fail: The channel has a fault (at this point); +
  • Incoming Lock: the channel is blocked for incoming calls; +
  • Remote Lock: there is a remote lock (at the other end) in this channel. +
+

In the case of a FXS channel, the state is defined by one of these values: +

+
  • On Hook: the phone connected to this channel is on-hook or disconnected; +
  • Off Hook: the phone connected to this channel is off the hook; +
  • Ringing: the channel is being called; +
  • Failure: the channel is in failure due to communication problems between the central and the plate. +
+

In the case of a GSM channel, the state is defined by one of the following values: +

+
  • Idle: the channel is free and available for calls; +
  • Call In Progress: the channel is busy on a call; +
  • SMS In Progress: the channel is busy sending / receiving SMS messages; +
  • Modem Error: an error occurred communicating with the modem channel; +
  • SIM Card Error: The SIM card is not present or is not inserted / detected correctly; +
  • Network Error: an error occurred while communicating with the network; +
  • Not Ready: The modem is initializing the channel. +
+

And in the case of an FXO channel, the states are as follows: +

+
  • Disabled: the channel is disabled; +
  • Enabled: the channel is enabled. +
+


+

+

Call state

+

Defines the logical state for each channel, which can be: +

+
  • Free: the channel is free; +
  • Incoming: the channel is receiving a call; +
  • Outgoing: the channel is making a call; +
  • Failure: the channel is in fault. +
+


+

+

FreeSWITCH call states

+

Directly reflects the call state controlled by FreeSWITCH, which can be: +


+

+
  • new: Channel is newly created; +
  • init: Channel has been initialized; +
  • routing: Channel is looking for an extension to execute; +
  • execute: Channel is executing its dialplan; +
  • ex_media: Channel is exchanging media with another channel; +
  • cs_media: Channel is consuming all media; +
  • hangup: Channel is flagged for hangup and ready to end. +
+


+

+

GSM Codes

+

The following numeric codes are reported: +

+

SMS codes (SMS causes)

+
1	Unassigned number
+8	Operator determined barring
+10	Call barred
+21	SMS transfer rejected
+27	Destination out of service
+28	Unidentified subscriber
+29	Facility rejected
+30	Unknown subscriber
+38	Network out of order
+41	Temporary failure
+42	Congestion
+47	Resources unavailable
+50	Facility not subscribed
+69	Facility not implemented
+81	Invalid SMS transfer reference value
+95	Invalid message
+96	Invalid mandatory information
+97	Message type non existent
+98	Message not compatible with SMS protection state
+99	Information element non existent
+111	Protocol error
+127	Interworking
+128	Telematic interworking not supported
+129	SMS type zero not supported
+130	Cannot replace SMS
+143	Unspecified TPPID error
+144	Alphabet not supported
+145	Message class not supported
+159	Unspecified TPDCS error
+160	Command cannot be actioned
+161	Command unsupported
+175	Unspecified TP command error
+176	TPDU not supported
+192	SC busy
+193	No SC subscription
+194	SC system failure
+195	Invalid SME address
+196	Destination SME barred
+197	SM rejected duplicate SM
+198	TPVPF not supported
+199	TPVP not supported
+208	SIM SMS storage full
+209	No SMS storage capability in SIM
+210	Error in SMS
+211	Memory capatity exceeded
+213	SIM data download error
+255	Unspecified error
+300	Phone failure
+301	SMS service reserved
+302	Operation not allowed
+303	Operation not supported
+304	Invalid PDU mode parameter
+305	Invalid text mode parameter
+310	SIM not inserted
+311	SIM PIN necessary
+312	Phone SIM PIN necessary
+313	SIM failure
+314	SIM busy
+315	SIM wrong
+320	Memory failure
+321	Invalid memory index
+322	Memory full
+330	SMSC address unknown
+331	No network service
+332	Network timeout
+500	Unknown error
+512	Network busy
+513	Invalid destination address
+514	Invalid message body length
+515	Phone is not in service
+516	Invalid preferred memory storage
+517	User terminated
+
+

Call codes (call causes)

+
1	Unallocated number
+3	No route to destination
+6	Channel unacceptable
+8	Operator determined barring
+16	Normal call clear
+17	User busy
+18	No user responding
+19	No answer from user
+21	Call rejected
+22	Number changed
+26	Non Selected user clear
+27	Destination out of order
+28	Invalid number format
+29	Facility rejected
+30	Response status enquiry
+31	Normal, unspecified
+34	No circuit channel available
+38	Network out of order
+41	Temporary failure
+42	Switch congestion
+43	Access information discarded
+44	Requested channel unavailable
+47	Resource unavailable
+49	QoS unavailable
+50	Request facility not subscribed
+55	Call barred with UG
+57	Bearer capability not authorized
+58	Bearer capability not available
+63	Service not available
+65	Bearer capability not implemented
+69	Request facility not implemented
+70	Only restricted bearer capability available
+79	Service not implemented
+81	Invalid call reference value
+82	User not member of UG
+88	Incompatible destination
+91	Invalid transit network selected
+95	Invalid message
+96	Missing mandatory information element
+97	Message type not implemented
+98	Message incompatible with state
+99	Information element not implemented
+100	Invalid information element
+101	Message incompatible with state (2)
+102	Recovery on timer expiry
+111	Protocol error
+127	Interworking
+
+

General codes (mobile causes)

+
0	Phone failure
+1	No connection to phone
+2	Phone adaptor link reserved
+3	Operation not allowed
+4	Operation not supported
+5	Phone SIM PIN required
+6	Phone FSIM PIN required
+7	Phone FSIM PUK required
+10	SIM not inserted
+11	SIM PIN required
+12	SIM PUK required
+13	SIM failure
+14	SIM busy
+15	SIM wrong
+16	Incorrect password
+17	SIM PIN2 required
+18	SIM PUK2 required
+20	Memory full
+21	Invalid index
+22	Not found
+23	Memory failure
+24	Text string too long
+25	Invalid character in text string
+26	Dial string too long
+27	Invalid character in dial string
+30	No network service
+31	Network timeout
+32	Network not allowed
+33	Command aborted
+34	Number parameter instead of text parameter
+35	Text parameter instead of number parameter
+36	Numeric parameter out of bounds
+37	Text string too short
+40	Network PIN required
+41	Network PUK required
+42	Network subset PIN required
+43	Network subset PUK required
+44	Network service provider PIN required
+45	Network service provider PUK required
+46	Corporate PIN required
+47	Corporate PUK required
+60	SIM Service option not supported
+100	Unknown
+103	Illegal MS #3
+106	Illegal MS #6
+107	GPRS service not allowed #7
+111	PLMN not allowed #11
+112	Location area not allowed #12
+113	Roaming not allowed #13
+132	Service option not supported #32
+133	Registration service option not subscribed #33
+134	Service option temporary out of order #34
+147	Long context activation
+148	Unspecified GPRS error
+149	PDP authentication failure
+150	Invalid mobile class
+151	GPRS disconnection TMR active
+256	Too many active calls
+257	Call rejected
+258	Unanswered call pending
+259	Unknown calling error
+260	No phone number recognized
+261	Call state not idle
+262	Call in progress
+263	Dial state error
+264	Unlock code required
+265	Network busy
+266	Invalid phone number
+267	Number entry already started
+268	Cancelled by user
+269	Number entry could not be started
+280	Data lost
+281	Invalid message body length
+282	Inactive socket
+283	Socket already open
+
+


+

+

Troubleshooting

+

In this section, errors and their most common solutions are presented. +

+

Error during installation of kernel module

+

During installation of the Endpointof Khomp may occur the following messages: + +

+
K3L: WARNING: Unable to find a module for [...]
+
+

or + +

+
install: ******  THE KERNEL MODULE HAS NOT BEEN INSTALLED: *******
+install: 
+install: ** Please, untar the file kpdriver*.tar.gz located in: **
+install: **                 '/usr/src/khomp/'                   **
+install: **             then check the README.txt               **
+install: **  for knowing how to proceed with the installation.  **
+
+

In this case, you must compile the drivers manually to your system. Proceed to the item below for more information. +
+

+

Compiling the drivers and starting the services

+

Just follow to the directory /usr/src/khomp, unpack the file "kpdriver_2.0.0XX.tar.gz", and follow procedures described in the file README_en.txt. +

After performing compilation and installation of the module, just load it into the system, configuring the boards and start the server processes Khomp. +

To load the kernel driver, you must run the following command: + +

+
# /etc/init.d/khompdrv start
+
+

To set up the boards, in turn, must run the command: + +

+
# khompwizard
+
+

This will run a setup wizard that will ask the signaling used in the system, as well as other parameters of use of the boards. +

If necessary configure other additional parameters you can use the following command: + +

+
# k3lconfig
+
+

This configurator, in turn, shows all possible options for card configuration. The parameters that are not configured automatically assume the default values, and are compatible with most systems. More details about this program can be obtained from the section number '2 '. +

+
  • ATTENTION': To start FreeSWITCH®, it is necessary that the board is configured Khomp and all modules are running (as shown above). If the card is not configured, FreeSWITCH will not start.

    If you want to run the system without the board Khomp, you need to configure FreeSWITCH for it does not load the module Khomp. To do this, open the "    /usr/local/freeswitch/conf/autoload_configs/modules.conf.xml and comment the line:
    +
+
 
+<!-- <load module="mod_khomp" /> -->
+

+

When the board Khomp is properly configured and loaded modules khomp (explained above), remember to uncomment this line in the file. +

Finally, to load the server process, simply run the following command: + +

+
# kserver start
+
+

After performing these procedures, the Endpoint is already operational, and FreeSWITCH can now be loaded. +
+

+

Setting up special parameters for audio or signaling

+

To set specific parameters of timing and/or signaling, you can use the program "k3lconfig": simply select the card you want, and options of the boards will be presented, divided into sections and subsections for easy access. It is not necessary to effect the configuration of all parameters: default values are assumed, if not configured. +

To adjust the signaling link, simply - after selecting the card - enter the "Options signaling, and then in" Signs of the line. " To choose a particular signaling, just use the direction keys (arrows) to select it, press 'space', and confirm the option by pressing 'Enter' on the "Confirm" button. +

Finally, to save the modified settings, just exit the program: it will display a window with options to save the changes made or not. +

Please not that the following options are required to be unchanged from the defaults: +

+
  • Automatic echo cancellation; +
  • DTMF suppression; +
  • Automatic Gain Control (AGC). +
+

These options are controlled by Endpoint and should be disabled in 'k3lconfig' (the default configuration). +
+

+

Automatic load of services and kernel modules

+

If the loading of kernel module or Khomp services startup is not performed automatically at startup, you can perform this installation manually, creating a link for the scripts /etc/init.d/khompdrv and /etc/init.d/kserver in the system startup directory. +

In the case of Debian-based distributions the script for loading kernel modules would be linked within the directory /etc/rcS.d, while the services loader would be linked within the directories /etc/rc2.d, /etc/rc3.d, /etc/rc4.d, /etc/rc5.d as follows: +

+

+
# ln -s /etc/init.d/khompdrv  /etc/rcS.d/S19khompdrv
+# ln -s /etc/init.d/kserver   /etc/rc2.d/S20kserver
+# ln -s /etc/init.d/kserver   /etc/rc3.d/S20kserver
+# ln -s /etc/init.d/kserver   /etc/rc4.d/S20kserver
+# ln -s /etc/init.d/kserver   /etc/rc5.d/S20kserver
+
+

Please check the rules of your distribution to initialize the services in accordance with what is expected by the start of it. +
+

+

Apêndice

+

Nesta seção, encontram-se informações úteis sobre o Endpoint e componentes relacionados. +

+

Arrangement of installed files

+

The directories created/modified in this facility are: + +

+
/etc/init.d/                -- Startup scripts;
+
+/etc/khomp/                 -- Firmware files and settings;
+
+/usr/local/freeswitch/conf/ -- Settings for FreeSWITCH and Endpoint;
+
+/usr/doc/khomp/             -- Docs for the boards, Channel, and utilities;
+
+/usr/sbin/                  -- Utilities and server processes;
+
+/usr/lib/                   -- Shared libraries;
+
+/usr/local/freeswitch/mod/  -- Endpoint module;
+ 
+/var/log/khomp2.1/          -- Log directory for K3L and Endpoint;
+
+

The script /etc/init.d/khompdrv is responsible for loading modules kpci9030.ko and kpex8311.ko in the kernel, which should be carried out automatically at system startup. In case of problems, check the Troubleshooting section. +


+


+

\ No newline at end of file diff --git a/src/mod/endpoints/mod_khomp/docs/User_Guide.pdf b/src/mod/endpoints/mod_khomp/docs/User_Guide.pdf new file mode 100644 index 0000000000..2f8c874a24 Binary files /dev/null and b/src/mod/endpoints/mod_khomp/docs/User_Guide.pdf differ diff --git a/src/mod/endpoints/mod_khomp/include/applications.h b/src/mod/endpoints/mod_khomp/include/applications.h new file mode 100644 index 0000000000..75f55ec5ca --- /dev/null +++ b/src/mod/endpoints/mod_khomp/include/applications.h @@ -0,0 +1,962 @@ +/******************************************************************************* + + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2010 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License + Version 1.1 (the "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file + under the MPL, indicate your decision by deleting the provisions above and + replace them with the notice and other provisions required by the LGPL + License. If you do not delete the provisions above, a recipient may use your + version of this file under either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*******************************************************************************/ + +#ifndef _APPLICATIONS_H_ +#define _APPLICATIONS_H_ + +#include "lock.h" +#include "khomp_pvt.h" + +struct Application +{ + Application(Board::KhompPvt * pvt) : _pvt(pvt) {} + ~Application() {} + + Statistics * statistics() { return _app_statistics; } + + template + T* statistics() { return static_cast(_app_statistics); } + + Board::KhompPvt *_pvt; + Statistics *_app_statistics; +}; + +/*************************** FAX **********************************************/ +struct Fax +{ + Fax(Board::KhompPvt * pvt) : _pvt(pvt) {} + + /* + bool clear(Board::KhompPvt * pvt) + { + _pvt = pvt; + return true; + } + */ + + bool adjustForFax(); + + bool sendFax(switch_core_session_t * session, const char *data); + bool receiveFax(switch_core_session_t * session, const char *data); + + bool onFaxChannelRelease(K3L_EVENT *e); + + bool startFaxTX(const char * orig_addr = NULL); + bool stopFaxTX(); + bool startFaxRX(const char * filename, const char * orig_addr = NULL); + bool stopFaxRX(); + bool addFaxFile(const char * filename, bool last = true); + + + Board::KhompPvt *_pvt; + + /* used by app FAX */ + SavedCondition _fax_cond; + KFaxResult _fax_result; + +}; + +/*************************** TRANSFER *****************************************/ +template +struct Transfer +{ + Transfer(Board::KhompPvt * pvt) : _pvt(pvt), _is_ok(false) {} + + bool clear() + { + if(!_is_ok) + { + _call = dynamic_cast(_pvt->call()); + + _is_ok = true; + + if(!_call) + { + DBG(FUNC, D("Error in cast")); + _is_ok = false; + } + } + + _call->_flags.clear(Kflags::XFER_DIALING); + + return true; + } + + bool userTransfer(switch_core_session_t * session, const char *data) + { + DBG(FUNC, PVT_FMT(_pvt->target(), "c")); + + std::string dest(""); + std::string opts(""); + + try + { + Strings::vector_type params; + + Strings::tokenize((const char *)data, params, "|,", 2); + + dest = params[0]; + + if (params.size() > 1) + { + // other options go here... + } + + ScopedPvtLock lock(_pvt); + + int timeout = 5; + + if(!_pvt->call()->_flags.check(Kflags::REALLY_CONNECTED) && !_pvt->loopWhileFlagTimed(Kflags::REALLY_CONNECTED, timeout, false)) + return false; + + DBG(FUNC, PVT_FMT(_pvt->target(), "flashing channel!")); + + _pvt->command(KHOMP_LOG, CM_FLASH); + + lock.unlock(); + + timeout = 15; // 15 * 200000 = 3s + + do + { + usleep(200000); + timeout--; + + ScopedPvtLock lock2(_pvt); + + if(!_pvt->call()->_flags.check(Kflags::IS_INCOMING) && !_pvt->call()->_flags.check(Kflags::IS_OUTGOING)) + { + DBG(FUNC, PVT_FMT(_pvt->target(), "unable to do a user transfer, channel disconnected")); + return false; + } + + } + while(timeout); + + ScopedPvtLock lock3(_pvt); + + _pvt->command(KHOMP_LOG, CM_DIAL_DTMF, dest.c_str()); + + _pvt->call()->_flags.set(Kflags::WAIT_SEND_DTMF); + + lock3.unlock(); + + timeout = 300; // 300 * 200000 = 60s + + do + { + usleep(200000); + timeout--; + + ScopedPvtLock lock4(_pvt); + + if(!_pvt->call()->_flags.check(Kflags::WAIT_SEND_DTMF)) + break; + } + while(timeout); + + } + catch (ScopedLockFailed & err) + { + LOG(ERROR, PVT_FMT(_pvt->target(),"r (unable to lock %s!)") % err._msg.c_str() ); + return false; + } + + + DBG(FUNC, PVT_FMT(_pvt->target(), "r")); + return true; + } + + /* User transfer functions */ + bool doUserXferUnlocked() + { + DBG(FUNC, PVT_FMT(_pvt->target(), "c (flashing channel!)")); + + bool ret = false; + + ret = _pvt->command(KHOMP_LOG, CM_FLASH); + + DBG(FUNC, PVT_FMT(_pvt->target(), "r (%s)") % (ret ? "true" : "false")); + return ret; + } + + bool checkUserXferUnlocked(std::string digit) + { + DBG(FUNC, PVT_FMT(_pvt->target(), "c (CM_FLASH)")); + + + if (_call->_user_xfer_digits.empty()) + { + _call->_digits_buffer += digit; + DBG(FUNC, PVT_FMT(_pvt->target(), "r (disabled)")); + return false; + } + + _call->_user_xfer_buffer += digit; + + /* temporary buffer */ + std::string tmp = _call->_user_xfer_buffer; + + unsigned int amount = tmp.size(); + + try + { + + if (amount == _call->_user_xfer_digits.size()) + { + if (tmp == _call->_user_xfer_digits) + { + bool ret = doUserXferUnlocked(); + + _call->_user_xfer_buffer.clear(); + _call->_digits_buffer.clear(); + + Board::board(_pvt->target().device)->_timers.del(_idx_xfer_dial); + + DBG(FUNC, PVT_FMT(_pvt->target(), "r (ret=%s, done xfer)") % (ret ? "true" : "false")); + return ret; + } + + _call->_digits_buffer += tmp[0]; + _call->_user_xfer_buffer.erase(0, 1); + DBG(FUNC, PVT_FMT(_pvt->target(), "r (false, no xfer)")); + return false; + } + + if (tmp == _call->_user_xfer_digits.substr(0,amount)) + { + if (!(_call->_flags.check(Kflags::XFER_DIALING))) + { + _call->_flags.set(Kflags::XFER_DIALING); + _idx_xfer_dial = Board::board(_pvt->target().device)->_timers.add(Opt::_transferdigittimeout, &userXferTimer, _pvt, TM_VAL_CALL); + } + else + { + Board::board(_pvt->target().device)->_timers.restart(_idx_xfer_dial); + } + + DBG(FUNC, PVT_FMT(_pvt->target(), "r (true, buffering)")); + return true; + } + + } + catch (K3LAPI::invalid_device & err) + { + LOG(ERROR, PVT_FMT(_pvt->target(), "Unable to get device: %d!") % err.device); + } + + _call->_digits_buffer += tmp[0]; + _call->_user_xfer_buffer.erase(0, 1); + DBG(FUNC, PVT_FMT(_pvt->target(), "r (false, buffering)")); + + return false; + + } + + static void userXferTimer(Board::KhompPvt * pvt) + { + DBG(FUNC, PVT_FMT(pvt->target(), "c")); + + T * call = static_cast(pvt->call()); + + try + { + ScopedPvtLock lock(pvt); + + if (!call->_user_xfer_buffer.empty()) + { + pvt->command(KHOMP_LOG, CM_DIAL_DTMF, call->_user_xfer_buffer.c_str()); + + /* clear the buffer that has been send */ + call->_user_xfer_buffer.clear(); + } + + call->_flags.clear(Kflags::XFER_DIALING); + } + catch (ScopedLockFailed & err) + { + LOG(ERROR, PVT_FMT(pvt->target(),"r (unable to lock %s!)") % err._msg.c_str() ); + return; + } + + DBG(FUNC, PVT_FMT(pvt->target(), "r")); + } + + bool _is_ok; + T * _call; + Board::KhompPvt * _pvt; + Board::ChanTimer::Index _idx_xfer_dial; +}; + +template +struct Transfer +{ + Transfer(Board::KhompPvt * pvt) : _pvt(pvt), _is_ok(false) {} + + bool clear() + { + if(!_is_ok) + { + _call = dynamic_cast(_pvt->call()); + + _is_ok = true; + + if(!_call) + { + DBG(FUNC, D("Error in cast")); + _is_ok = false; + } + } + + _call->_flags.clear(Kflags::XFER_DIALING); + _call->_flags.clear(Kflags::XFER_QSIG_DIALING); + + return true; + } + + bool userTransfer(switch_core_session_t * session, const char *data) + { + DBG(FUNC, PVT_FMT(_pvt->target(), "c")); + + std::string dest(""); + + bool opt_nowait = false; + + try + { + Strings::vector_type params; + + Strings::tokenize((const char *)data, params, "|,", 2); + + dest = params[0]; + + if (params.size() > 1) + { + opt_nowait = (params[1].find('n') != std::string::npos); + + // other options go here... + } + + ScopedPvtLock lock(_pvt); + + int timeout = 5; + + if(!_pvt->call()->_flags.check(Kflags::REALLY_CONNECTED) && !_pvt->loopWhileFlagTimed(Kflags::REALLY_CONNECTED, timeout, false)) + return false; + + DBG(FUNC, PVT_FMT(_pvt->target(), "ss_transfer on channel!")); + + _pvt->command(KHOMP_LOG, CM_SS_TRANSFER, + STG(FMT("transferred_to=\"%s\" await_connect=\"%d\"") + % dest % (opt_nowait ? 0 : 1)).c_str()); + + } + catch (ScopedLockFailed & err) + { + LOG(ERROR, PVT_FMT(_pvt->target(),"r (unable to lock %s!)") % err._msg.c_str() ); + return false; + } + + + DBG(FUNC, PVT_FMT(_pvt->target(), "r")); + return true; + } + + /* User transfer functions */ + bool doUserXferUnlocked(void) + { + DBG(FUNC, PVT_FMT(_pvt->target(), "c")); + + bool ret = false; + + if (_call->_flags.check(Kflags::XFER_QSIG_DIALING)) + { + DBG(FUNC, PVT_FMT(_pvt->target(), "ss_transfer on channel!")); + + _call->_flags.clear(Kflags::XFER_DIALING); + _call->_flags.clear(Kflags::XFER_QSIG_DIALING); + + ret = _pvt->command(KHOMP_LOG, CM_SS_TRANSFER, + STG(FMT("transferred_to=\"%s\" await_connect=\"1\"") % _call->_qsig_number).c_str()); + } + else + { + DBG(FUNC, PVT_FMT(_pvt->target(), "starting to store digits for ss_transfer...")); + _call->_flags.set(Kflags::XFER_QSIG_DIALING); + + _xfer_thread = threadCreate(Transfer::userXferPlayback,(void*) _pvt); + _xfer_thread->start(); + + ret = true; + } + + DBG(FUNC, PVT_FMT(_pvt->target(), "r (%s)") % (ret ? "true" : "false")); + return ret; + + } + + bool checkUserXferUnlocked(std::string digit) + { + DBG(FUNC, PVT_FMT(_pvt->target(), "c (CM_SS_TRANSFER)")); + + + if (_call->_user_xfer_digits.empty()) + { + _call->_digits_buffer += digit; + DBG(FUNC, PVT_FMT(_pvt->target(), "r (disabled)")); + return false; + } + + _call->_user_xfer_buffer += digit; + + DBG(FUNC, PVT_FMT(_pvt->target(), "c digits=[%s] buffer=[%s]") % _call->_user_xfer_digits % _call->_user_xfer_buffer ); + + /* temporary buffer */ + std::string tmp = _call->_user_xfer_buffer; + + unsigned int amount = tmp.size(); + + try + { + + if (amount == _call->_user_xfer_digits.size()) + { + if (tmp == _call->_user_xfer_digits) + { + bool ret = doUserXferUnlocked(); + + _call->_user_xfer_buffer.clear(); + _call->_qsig_number.clear(); + _call->_digits_buffer.clear(); + + if(!_call->_flags.check(Kflags::XFER_QSIG_DIALING)) + { + Board::board(_pvt->target().device)->_timers.del(_idx_xfer_dial); + + DBG(FUNC, PVT_FMT(_pvt->target(), "r (ret=%s, done xfer)") % (ret ? "true" : "false")); + } + else + { + Board::board(_pvt->target().device)->_timers.restart(_idx_xfer_dial); + DBG(FUNC, PVT_FMT(_pvt->target(), "r (waiting digits for transfer)")); + } + return ret; + } + + if (_call->_flags.check(Kflags::XFER_QSIG_DIALING)) + { + DBG(FUNC, PVT_FMT(_pvt->target(), "putting digits ('%s') on transfer-to number!") % tmp); + + _call->_qsig_number += tmp[0]; + _call->_user_xfer_buffer.erase(0, 1); + Board::board(_pvt->target().device)->_timers.restart(_idx_xfer_dial); + + DBG(FUNC, PVT_FMT(_pvt->target(), "r (true, qsig transfer)")); + return true; + } + + _call->_digits_buffer += tmp[0]; + _call->_user_xfer_buffer.erase(0, 1); + DBG(FUNC, PVT_FMT(_pvt->target(), "r (false, no qsig)")); + return false; + } + + if (tmp == _call->_user_xfer_digits.substr(0,amount)) + { + if (!(_call->_flags.check(Kflags::XFER_DIALING) || _call->_flags.check(Kflags::XFER_QSIG_DIALING))) + { + _call->_flags.set(Kflags::XFER_DIALING); + _idx_xfer_dial = Board::board(_pvt->target().device)->_timers.add(Opt::_transferdigittimeout, &userXferTimer, _pvt, TM_VAL_CALL); + } + else + { + Board::board(_pvt->target().device)->_timers.restart(_idx_xfer_dial); + } + + DBG(FUNC, PVT_FMT(_pvt->target(), "r (true, buffering)")); + return true; + } + + if (_call->_flags.check(Kflags::XFER_QSIG_DIALING)) + { + DBG(FUNC, PVT_FMT(_pvt->target(), "putting digits ('%s') on transfer-to number!") % tmp); + + _call->_qsig_number += tmp[0]; + _call->_user_xfer_buffer.erase(0, 1); + + Board::board(_pvt->target().device)->_timers.restart(_idx_xfer_dial); + DBG(FUNC, PVT_FMT(_pvt->target(), "r (true, qsig buffering)")); + return true; + } + + } + catch (K3LAPI::invalid_device & err) + { + LOG(ERROR, PVT_FMT(_pvt->target(), "Unable to get device: %d!") % err.device); + } + + _call->_digits_buffer += tmp[0]; + _call->_user_xfer_buffer.erase(0, 1); + DBG(FUNC, PVT_FMT(_pvt->target(), "r (false, buffering)")); + + return false; + } + + static void userXferTimer(Board::KhompPvt * pvt) + { + DBG(FUNC, PVT_FMT(pvt->target(), "c")); + + T * call = static_cast(pvt->call()); + + try + { + ScopedPvtLock lock(pvt); + + if (!call->_user_xfer_buffer.empty()) + { + pvt->command(KHOMP_LOG, CM_DIAL_DTMF, call->_user_xfer_buffer.c_str()); + + /* clear the buffer that has been send */ + call->_user_xfer_buffer.clear(); + } + + if (!call->_qsig_number.empty()) + { + pvt->command(KHOMP_LOG, CM_SS_TRANSFER, + STG(FMT("transferred_to=\"%s\" await_connect=\"1\"") % call->_qsig_number).c_str()); + + /* clear the buffer that has been send */ + call->_qsig_number.clear(); + } + + call->_flags.clear(Kflags::XFER_DIALING); + call->_flags.clear(Kflags::XFER_QSIG_DIALING); + } + catch (ScopedLockFailed & err) + { + LOG(ERROR, PVT_FMT(pvt->target(),"r (unable to lock %s!)") % err._msg.c_str() ); + return; + } + + DBG(FUNC, PVT_FMT(pvt->target(), "r")); + } + + static switch_status_t dtmfCallback(switch_core_session_t *session, void *input, switch_input_type_t itype, void *buf, unsigned int buflen) + { + char sbuf[3]; + + if(!session) + { + DBG(FUNC,D("session is NULL")) + return SWITCH_STATUS_FALSE; + } + + switch_channel_t * chan = switch_core_session_get_channel(session); + + if(!chan) + { + DBG(FUNC,D("channel is NULL")) + return SWITCH_STATUS_FALSE; + } + + switch_core_session_t *peer_session = switch_core_session_locate(switch_channel_get_variable(chan,SWITCH_SIGNAL_BOND_VARIABLE)); + + if(!peer_session) + { + DBG(FUNC,D("session is NULL")) + return SWITCH_STATUS_FALSE; + } + + switch (itype) + { + case SWITCH_INPUT_TYPE_DTMF: + { + switch_dtmf_t *dtmf = (switch_dtmf_t *) input; + + Board::KhompPvt * tech_pvt = static_cast< Board::KhompPvt* >(switch_core_session_get_private(peer_session)); + if(!tech_pvt) + { + DBG(FUNC,D("Init: pvt is NULL")) + switch_core_session_rwunlock(peer_session); + return SWITCH_STATUS_FALSE; + } + + char s[] = { dtmf->digit, '\0' }; + tech_pvt->sendDtmf(s); + + break; + } + default: + break; + } + + switch_core_session_rwunlock(peer_session); + return SWITCH_STATUS_SUCCESS; + } + + + static int userXferPlayback(void * pvt_ptr) + { + /* get pointer... */ + Board::KhompPvt * pvt = static_cast < Board::KhompPvt * > (pvt_ptr); + + DBG(FUNC, PVT_FMT(pvt->target(), "c")); + + try + { + ScopedPvtLock lock(pvt); + + /* get the owner */ + switch_channel_t * chan = pvt->getFSChannel(); + + /* get other side of the bridge */ + switch_core_session_t * peer_session = NULL; + switch_core_session_get_partner(pvt->session(),&peer_session); + + if(!peer_session) + { + DBG(FUNC, PVT_FMT(pvt->target(), "r (session is null)")); + return NULL; + } + + switch_channel_t * peer = switch_core_session_get_channel(peer_session); + + /* put the channel in hold */ + //switch_core_session_t *session = switch_core_session_locate(switch_channel_get_variable(chan,SWITCH_SIGNAL_BOND_VARIABLE)); + //switch_channel_t *chan_core = switch_core_session_get_channel(session); + + const char *stream; + + if (!(stream = switch_channel_get_variable(chan, SWITCH_HOLD_MUSIC_VARIABLE))) + { + stream = "silence"; + } + + DBG(FUNC, PVT_FMT(pvt->target(), "stream=%s") % stream); + + if (stream && strcasecmp(stream, "silence")) + { + /* Freeswitch not get/put frames */ + //switch_channel_set_flag(channel, CF_HOLD); + switch_ivr_broadcast(switch_core_session_get_uuid(pvt->session()),stream, SMF_ECHO_ALEG | SMF_LOOP | SMF_PRIORITY); + } + + switch_core_session_rwunlock(peer_session); + lock.unlock(); + + /* kickstart my heart */ + switch_input_args_t args = {0}; + args.input_callback = dtmfCallback; + + /* wait while xfering... */ + while (true) + { + switch_ivr_collect_digits_callback(peer_session,&args,1000,0); + ScopedPvtLock lock2(pvt); + + if (!pvt->call()->_flags.check(Kflags::XFER_QSIG_DIALING)) + { + break; + } + + lock2.unlock(); + } + + //switch_channel_clear_flag(channel, CF_HOLD); + + switch_channel_stop_broadcast(chan); + switch_channel_wait_for_flag(chan, CF_BROADCAST, SWITCH_FALSE, 5000, NULL); + switch_core_session_rwunlock(pvt->session()); + switch_core_session_rwunlock(peer_session); + + //switch_ivr_unhold_uuid(switch_channel_get_variable(chan,SWITCH_SIGNAL_BOND_VARIABLE)); + } + catch (ScopedLockFailed & err) + { + LOG(ERROR, PVT_FMT(pvt->target(),"r (unable to lock %s!)") % err._msg.c_str() ); + return NULL; + } + catch (Board::KhompPvt::InvalidSwitchChannel & err) + { + LOG(ERROR, PVT_FMT(pvt->target(), "r (%s)") % err._msg.c_str() ); + return NULL; + } + + DBG(FUNC, PVT_FMT(pvt->target(), "r")); + + return NULL; + } + + bool _is_ok; + T * _call; + Board::KhompPvt * _pvt; + Thread * _xfer_thread; + Board::ChanTimer::Index _idx_xfer_dial; +}; + +/*************************** SMS **********************************************/ +struct SMS : public Application +{ + typedef std::list< switch_core_session_t *> OwnersList; + + struct SMSStatistics : public Statistics + { + SMSStatistics(): + _sms_number_incoming(0), + _sms_number_outgoing(0), + _sms_number_confirm(0), + _sms_number_broadcast(0) {}; + + void incrementIncoming() + { + _sms_number_incoming++; + } + + void incrementOutgoing() + { + _sms_number_outgoing++; + } + + void incrementConfirm() + { + _sms_number_confirm++; + } + + void incrementBroadcast() + { + _sms_number_broadcast++; + } + + std::string getDetailed() + { + std::string tmpBuffer; + + tmpBuffer.append(STG(FMT("Number of incoming SMS: \t%d\n") % _sms_number_incoming)); + tmpBuffer.append(STG(FMT("Number of outgoing SMS: \t%d\n") % _sms_number_outgoing)); + tmpBuffer.append(STG(FMT("Number of broadcast SMS: \t%d\n") % _sms_number_broadcast)); + tmpBuffer.append(STG(FMT("Number of confirm SMS: \t%d\n") % _sms_number_confirm)); + + return tmpBuffer; + } + + void clear() + { + _sms_number_incoming = 0; + _sms_number_outgoing = 0; + _sms_number_confirm = 0; + _sms_number_broadcast = 0; + } + + unsigned int _sms_number_incoming; + unsigned int _sms_number_outgoing; + unsigned int _sms_number_confirm; + unsigned int _sms_number_broadcast; + }; + + SMS(Board::KhompPvt * pvt) : + Application(pvt), + _thread(NULL), + _shutdown(false), + _can_receive(false), + _can_send(false), + _result(0), + _mutex(Globals::module_pool), + _cond(Globals::module_pool), + _buffer(8) + { + _cond.reset(); + _app_statistics = new SMSStatistics(); + } + + ~SMS() + { + stop(); + delete _app_statistics; + } + + struct ReceiveData + { + ReceiveData() {}; + + ReceiveData(const ReceiveData & o) + { + _type = o._type; + _from = o._from; + _date = o._date; + _size = o._size; + _coding = o._coding; + _serial = o._serial; + _id = o._id; + _page = o._page; + _pages = o._pages; + _sc_date = o._sc_date; + _status = o._status; + _body = o._body; + }; + + void clear(void) + { + /* reset data stuff */ + _type.clear(); + _from.clear(); + _date.clear(); + _size.clear(); + _coding.clear(); + _serial.clear(); + _id.clear(); + _page.clear(); + _pages.clear(); + _sc_date.clear(); + _status.clear(); + _body.clear(); + }; + + std::string _type; + std::string _from; + std::string _date; + std::string _size; + std::string _coding; + std::string _serial; + std::string _id; + std::string _page; + std::string _pages; + std::string _sc_date; + std::string _status; + std::string _body; + }; + + struct SendData + { + SendData(): _conf(false) {}; + + SendData(const SendData & o) + { + _dest = o._dest; + _body = o._body; + _conf = o._conf; + }; + + void clear(void) + { + /* reset data stuff */ + _dest.clear(); + _body.clear(); + _conf = false; + }; + + std::string _dest; + std::string _body; + bool _conf; + }; + + struct Request + { + /* "empty" constructor */ + Request(): _finished(NULL), _cause(NULL) {}; + + /* "real" constructor */ + Request(SendData & send_sms, volatile bool * finished, volatile KGsmCallCause * cause) + : _send_sms(send_sms), _finished(finished), _cause(cause) + {}; + + SendData _send_sms; + + volatile bool * _finished; + volatile KGsmCallCause * _cause; + }; + + bool start() + { + _pvt->call()->_flags.clear(Kflags::SMS_DOING_UPLOAD); + + _thread = threadCreate(&smsThread, (void*) this); + _thread->start(); + } + + bool stop() + { + if(!_thread) + { + return false; + } + + _shutdown = true; + _cond.signal(); + _thread->join(); + delete _thread; + _thread = NULL; + + return true; + } + + bool justAlloc(unsigned int count = 0); + bool justStart(); + + bool sendSMS(switch_core_session_t * session, const char *data); + + + bool onNewSMS(K3L_EVENT *e); + bool onSMSInfo(K3L_EVENT *e); + bool onSMSData(K3L_EVENT *e); + bool onSMSSendResult(K3L_EVENT *e); + + Thread *_thread; + bool _shutdown; + bool _can_receive; + bool _can_send; + ReceiveData _got_sms; + SendData _send_sms; + int _result; + SavedCondition _cond; + Globals::Mutex _mutex; + Ringbuffer < SMS::Request > _buffer; + OwnersList _owners; + + static int smsThread(void * sms_ptr); +}; + +/******************************************************************************/ + + +#endif /* _APPLICATIONS_H_ */ + diff --git a/src/mod/endpoints/mod_khomp/include/cli.h b/src/mod/endpoints/mod_khomp/include/cli.h new file mode 100644 index 0000000000..214e2aa2d5 --- /dev/null +++ b/src/mod/endpoints/mod_khomp/include/cli.h @@ -0,0 +1,1143 @@ +/******************************************************************************* + + KHOMP generic endpoint/channel library. + Copyright (C) 2007-2010 Khomp Ind. & Com. + + The contents of this file are subject to the Mozilla Public License + Version 1.1 (the "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" basis, + WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for + the specific language governing rights and limitations under the License. + + Alternatively, the contents of this file may be used under the terms of the + "GNU Lesser General Public License 2.1" license (the “LGPL" License), in which + case the provisions of "LGPL License" are applicable instead of those above. + + If you wish to allow use of your version of this file only under the terms of + the LGPL License and not to allow others to use your version of this file + under the MPL, indicate your decision by deleting the provisions above and + replace them with the notice and other provisions required by the LGPL + License. If you do not delete the provisions above, a recipient may use your + version of this file under either the MPL or the LGPL License. + + The LGPL header follows below: + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA + +*******************************************************************************/ + +#ifndef _CLI_H_ +#define _CLI_H_ + +#include "globals.h" +#include "logger.h" + +struct Command +{ + /* print in client the usage */ + void printUsage(switch_stream_handle_t *stream) + { + if(stream) + { + printBrief(stream); + K::Logger::Logg2(C_CLI,stream, +"------------------------------ Description --------------------------------"); + K::Logger::Logg2(C_CLI,stream, +"---------------------------------------------------------------------------"); + K::Logger::Logg2(C_CLI,stream,(char*) usage.c_str()); + K::Logger::Logg2(C_CLI,stream, +"---------------------------------------------------------------------------"); + } + else + { + LOG(ERROR,FMT("Invalid stream for commmand: %s") % complete_name); + } + } + + /* print in client the brief */ + void printBrief(switch_stream_handle_t *stream) + { + if(stream) + { + K::Logger::Logg2(C_CLI,stream, +"---------------------------------------------------------------------------"); + K::Logger::Logg2(C_CLI,stream, +"-------------------------------- Brief ------------------------------------"); + K::Logger::Logg2(C_CLI,stream, +"---------------------------------------------------------------------------"); + K::Logger::Logg2(C_CLI,stream,(char*) brief.c_str()); + K::Logger::Logg2(C_CLI,stream, +"---------------------------------------------------------------------------"); + } + else + { + LOG(ERROR,FMT("Invalid stream for commmand: %s") % complete_name); + } + } + + /* pure virtual */ + virtual bool execute(int argc, char *argv[]) = 0; + + std::string complete_name; /* specify the command in console */ + std::vector options; /* extra options for command */ + std::string brief; /* brief of the command, a path */ + std::string usage; /* usage of the command, a help */ +}; + +struct Cli +{ + /* Useful definitions --------------------------------------------------- */ + typedef switch_status_t (APIFunc)(const char*, switch_core_session_t*, switch_stream_handle_t*); + typedef std::vector Commands; + + /* register our commands, but you must create the command function */ + static void registerCommands(APIFunc func,switch_loadable_module_interface_t **mod_int); + + /* delete the commands */ + static void unregisterCommands() + { + switch_console_set_complete("del khomp"); + } + + /* stream is very useful */ + static void setStream(switch_stream_handle_t *s) + { + if(!s) + { + LOG(ERROR,"Invalid stream passed"); + return; + } + + stream = s; + } + + /* gets the khomp usage */ + static void printKhompUsage() + { + if(stream) + { + K::Logger::Logg2(C_CLI,stream,(char*) _khomp_usage.c_str()); + } + else + { + LOG(ERROR,"Invalid stream for command: printKhompUsage"); + } + } + + /* is responsible for parse and execute all commands */ + static bool parseCommands(int argc, char *argv[]); + + /* The Commands --------------------------------------------------------- */ + + /* khomp summary */ + static struct _KhompSummary : public Command + { + _KhompSummary(bool on_cli_term = true): + _on_cli_term(on_cli_term) + { + complete_name = "summary"; + + options.push_back("verbose"); + options.push_back("concise"); + + brief = "Print system info."; + usage = \ +"Prints detailed info about the system like API version and \n" \ +"boards characteristics like DSPs version.\n\n" \ +"Usage: khomp summary [concise]"; + + _commands.push_back(this); + }; + + bool execute(int argc, char *argv[]); + bool _on_cli_term; /* indicates if message is sent to fs_cli */ + } KhompSummary; + + /* khomp show calls */ + static struct _KhompShowCalls : public Command + { + _KhompShowCalls() + { + complete_name = "show calls"; + brief = \ +"Show each Khomp channel which have more than one call state associated."; + + usage = \ +"Show each Khomp channel which have more than one call state associated.\n\n" \ +"Usage: khomp show calls [ []]"; + + _commands.push_back(this); + }; + + bool execute(int argc, char *argv[]); + + /* support function for _KhompShowCalls */ + void showCalls(unsigned int device, unsigned int object, std::string &buffer); + } KhompShowCalls; + + /* khomp channels disconnect */ + static struct _KhompChannelsDisconnect : public Command + { + _KhompChannelsDisconnect() + { + complete_name = "channels disconnect"; + brief = "Disconnect a(ll) channel(s)."; + usage = \ +"Disconnects channels in boards, or specific board/channel if parameter \n" \ +"is supplied.\n\n" \ +"Usage: khomp channels disconnect {all | all | }\n" \ +"\tboard -- Number of the board (start from 0).\n" \ +"\tchannel -- Number of the channel (start from 0).\n" \ +"e.g. khomp channels disconnect all - Disconnect all channels of all boards.\n"\ +"e.g. khomp channels disconnect 0 5 - Disconnect channel 5 of board 0."; + _commands.push_back(this); + }; + + bool execute(int argc, char *argv[]); + + /* support function for _KhompChannelsDisconnect */ + bool forceDisconnect(unsigned int device, unsigned int channel); + } KhompChannelsDisconnect; + + /* khomp channels unblock */ + static struct _KhompChannelsUnblock : public Command + { + _KhompChannelsUnblock() + { + complete_name = "channels unblock"; + brief = "Unblock a(ll) channel(s)."; + + usage = \ +"The board will request to the PBX or network where it is connected to \n" \ +"unblock the channel if its blocked.\n\n" \ +"Usage: khomp channels unblock {all | all | }\n" \ +"\tboard -- Number of the board (start from 0).\n" \ +"\tchannel -- Number of the channel (start from 0).\n" \ +"e.g. khomp channels unblock all - Unblock all channels of all boards.\n" \ +"e.g. khomp channels unblock 0 all - Unblock all channels of board 0.\n" \ +"e.g. khomp channels unblock 1 20 - Unblock channel 20 of board 1."; + + _commands.push_back(this); + }; + + bool execute(int argc, char *argv[]); + } KhompChannelsUnblock; + + /* khomp show statistics */ + static struct _KhompShowStatistics : public Command + { + _KhompShowStatistics() + { + complete_name = "show statistics"; + + options.push_back("verbose"); + options.push_back("detailed"); + + brief = "Shows statistics of the channels."; + + usage = \ +"Shows statistics of the channels, like number of calls incoming \n" \ +"and outgoing, status, status time.\n\n" \ +"Usage: khomp show statistics [{verbose [ []]} | \n" \ +" {detailed }]\n" \ +"\tboard -- Number of the board (start from 0).\n" \ +"\tchannel -- Number of the channel (start from 0).\n" \ +"e.g. khomp channels statistics - Shows general statistics \n" \ +" of all boards.\n" \ +"e.g. khomp channels statistics 0 - Shows general statistics \n" \ +" of board 0.\n" \ +"e.g. khomp channels statistics verbose - Shows general statistics \n" \ +" of all boards.\n" \ +"e.g. khomp channels statistics verbose 0 - Shows general statistics \n" \ +" of board 0.\n" \ +"e.g. khomp channels statistics detailed 0 2 - Shows detailed statistics \n" \ +" of channel 2 on board 0."; + + _commands.push_back(this); + }; + + bool execute(int argc, char *argv[]); + + /* support functions */ + void cliStatistics(unsigned int device); + void cliDetailedStatistics(unsigned int device, unsigned int channel); + + } KhompShowStatistics; + + /* khomp show channels */ + static struct _KhompShowChannels: public Command + { + _KhompShowChannels() + { + complete_name = "show channels"; + + options.push_back("verbose"); + options.push_back("concise"); + + brief = "Show all channels status."; + usage = \ +"List the status of each channel, both on asterisk point of view and on \n" \ +"khomp API point of view.\n\n" \ +"Usage: \n" \ +"khomp show channels [{ []} | \n" \ + "{{concise|verbose} [ []]}]\n" \ +"\tboard -- Number of the board (start from 0).\n" \ +"e.g. khomp show channels - List status of all channels of all boards.\n" \ +"e.g. khomp show channels concise 0 - List status of all channels of \n" \ +" board 0 in a concise way."; + + _commands.push_back(this); + }; + + /* support function for _KhompShowChannels */ + void showChannel(unsigned int device, bool concise, unsigned int channel); + void showChannels(unsigned int device, bool concise); + + bool execute(int argc, char *argv[]); + } KhompShowChannels; + + /* khomp show links */ + static struct _KhompShowLinks: public Command + { + _KhompShowLinks() + { + complete_name = "show links"; + + options.push_back("verbose"); + options.push_back("concise"); + options.push_back("errors"); + options.push_back("errors verbose"); + options.push_back("errors concise"); + + brief = "Show E1 link(s) status/errors counters in a concise \n" \ + "way or not."; + + usage = \ +"Prints information about the signaling, syncronization and general \n" \ +"status/the error counters of each link on the board. It prints in \n" \ +"a concise way for parsing facilities.\n\n" \ +"Usage: \n" \ +"khomp show links [[errors] [{} | {{concise|verbose} []}]]\n" \ +"e.g. khomp show links - Show all links of all boards.\n" \ +"e.g. khomp show links errors - Show error counters of all links of \n" \ +" all boards.\n" \ +"e.g. khomp show links errors 0 - Show error counters of all links of \n" \ +" board 0."; + + _commands.push_back(this); + }; + + /* support function for _KhompShowLinks */ + void showLinks(unsigned int device, bool concise); + void showErrors(unsigned int device, bool concise); + + bool execute(int argc, char *argv[]); + } KhompShowLinks; + + /* khomp clear links */ + static struct _KhompClearLinks: public Command + { + _KhompClearLinks() + { + complete_name = "clear links"; + + brief = "Clear the error counters of the links."; + + usage = \ +"Clear the error counters of the links.\n\n" \ +"Usage: khomp clear links [ []]\n" \ +"\tboard -- Number of the board (start from 0).\n" \ +"\tlink -- Number of the link (start from 0).\n" \ +"e.g. khomp clear links 0 -- Clear error counters of all links of board 0."; + + _commands.push_back(this); + }; + + /* support function for _KhompClearLinks */ + void clearLink(unsigned int device, unsigned int link); + + bool execute(int argc, char *argv[]); + } KhompClearLinks; + + /* khomp clear statistics */ + static struct _KhompClearStatistics: public Command + { + _KhompClearStatistics() + { + complete_name = "clear statistics"; + + brief = "Clear statistics of the channels."; + + usage = \ +"Clear statistics of the channels, like number of calls incoming \n" \ +"and outgoing, status, status time.\n\n" \ +"Usage: khomp clear statistics [ []]\n" \ +"\tboard -- Number of the board (start from 0).\n" \ +"\tchannel -- Number of the channel (start from 0).\n" \ +"e.g. khomp clear statistics 0 -- Clear statistics of board 0."; + _commands.push_back(this); + }; + + bool execute(int argc, char *argv[]); + } KhompClearStatistics; + + + /* khomp reset links */ + static struct _KhompResetLinks: public Command + { + _KhompResetLinks() + { + complete_name = "reset links"; + + brief = "Reset the specified link."; + + usage = \ +"Reset the specified link.\n\n" \ +"Usage: khomp reset links [ []]\n" \ +"\tboard -- Number of the board (start from 0).\n" \ +"\tlink -- Number of the link (start from 0).\n" \ +"e.g. khomp reset links 0 1 -- Reset link 1 of board 0."; + + _commands.push_back(this); + }; + + /* support function for _KhompResetLinks */ + void resetLink(unsigned int device, unsigned int link); + + bool execute(int argc, char *argv[]); + } KhompResetLinks; + + /* khomp sms */ + static struct _KhompSMS : public Command + { + _KhompSMS() + { + complete_name = "sms"; + brief = "Send an SMS message using a Khomp KGSM board."; + + usage = \ +"Send an SMS message using a Khomp KGSM board.\n\n" \ +"Usage: khomp sms \n" \ +"\tdevice -- Device to use (same string used in Dial for \n" \ +"\t channel allocation).\n" \ +"\tdestination -- Phone number of the destination.\n" \ +"\tmessage -- Message to send.\n" \ +"e.g. khomp sms b0 99887766 Oi, tudo bem?"; + + _commands.push_back(this); + }; + + bool execute(int argc, char *argv[]); + } KhompSMS; + + /* khomp log console */ + static struct _KhompLogConsole : public Command + { + _KhompLogConsole() + { + complete_name = "log console"; + + options.push_back("errors"); + options.push_back("warnings"); + options.push_back("messages"); + options.push_back("events"); + options.push_back("commands"); + options.push_back("audio"); + options.push_back("modem"); + options.push_back("link"); + options.push_back("cas"); + options.push_back("standard"); + options.push_back("all"); + options.push_back("no"); + options.push_back("just"); + + brief = "Enables/disables showing console messages for the channel."; + usage = \ +"Enables/disables showing channel messages, where can be:\n" \ +"\terrors -- Error messages, when something goes really \n" \ +"\t wrong. Enabled by default.\n" \ +"\twarnings -- Warnings, used when something might not be \n" \ +"\t going as expected. Enabled by default.\n" \ +"\tmessages -- Generic messages, used to indicate some \n" \ +"\t information. Enabled by default.\n" \ +"\tevents -- Show received K3L events as console \n" \ +"\t messages. Disabled by default.\n" \ +"\tcommands -- Show sent K3L commands as console \n" \ +"\t messages. Disabled by default.\n" \ +"\taudio -- Enable messages for K3L audio events. \n" \ +"\t Disabled by default (very verbose!).\n" \ +"\tmodem -- Enable messages for data received from \n" \ +"\t KGSM modems. Disabled by default.\n" \ +"\tlink -- Enable logging of link status changes. \n" \ +"\t Enabled by default.\n" \ +"\tcas -- Enable logging of MFCs and line state \n" \ +"\t changes in KPR board. Disabled by default.\n" \ +"\tstandard -- Special identifier, enable default \n" \ +"\t console messages.\n" \ +"\tall -- Special identifier, enable ALL console \n" \ +"\t messages (should not be used naively).\n\n" \ +"Usage: khomp log console \n" \ +"e.g. khomp log console standard"; + + _commands.push_back(this); + } + + bool execute(int argc, char *argv[]); + } KhompLogConsole; + + /* khomp log disk */ + static struct _KhompLogDisk : public Command + { + _KhompLogDisk() + { + complete_name = "log disk"; + + options.push_back("errors"); + options.push_back("warnings"); + options.push_back("messages"); + options.push_back("events"); + options.push_back("commands"); + options.push_back("audio"); + options.push_back("modem"); + options.push_back("link"); + options.push_back("cas"); + options.push_back("functions"); + options.push_back("threads"); + options.push_back("locks"); + options.push_back("streams"); + options.push_back("standard"); + options.push_back("debugging"); + options.push_back("all"); + options.push_back("no"); + options.push_back("just"); + + brief = "Enables/disables logging to file messages for the channel."; + usage = \ +"Enables/disables the logging of channel messages to disk, where \n" \ +"can be:\n" \ +"\terrors -- Error messages, when something goes really \n" \ +"\t wrong. Enabled by default.\n" \ +"\twarnings -- Warnings, used when something might not be \n" \ +"\t going as expected. Enabled by default.\n" \ +"\tmessages -- Generic messages, used to indicate some \n" \ +"\t information. Enabled by default.\n" \ +"\tevents -- Record received K3L events as log messages. \n" \ +"\t Disabled by default.\n" \ +"\tcommands -- Record sent K3L commands as log messages. \n" \ +"\t Disabled by default.\n" \ +"\taudio -- Enable messages for K3L audio events. \n" \ +"\t Disabled by default (very verbose!).\n" \ +"\tmodem -- Enable messages for data received from \n" \ +"\t KGSM modems. Disabled by default.\n" \ +"\tlink -- Enable logging of link status changes. \n" \ +"\t Enabled by default.\n" \ +"\tcas -- Enable logging of MFCs and line state \n" \ +"\t changes in KPR board. Disabled by default.\n" \ +"\tfunctions -- Enable debugging for functions. Disabled \n" \ +"\t by default (should not be used naively!).\n" \ +"\tthreads -- Enable debugging for threads. Disabled by \n" \ +"\t default (should not be used naively!).\n" \ +"\tlocks -- Enable debugging for locks. Disabled by \n" \ +"\t default (should not be used naively!).\n" \ +"\tstreams -- Enable debugging for streams. Disabled by \n" \ +"\t default (should not be used naively!).\n" \ +"\tstandard -- Special identifier, enable default messages.\n" \ +"\tdebugging -- Special identifier, enable debugging messages \n" \ +"\t (should not be used naively).\n" \ +"\tall -- Special identifier, enable ALL disk \n" \ +"\t messages (DO NOT USE THIS!).\n\n" \ +"Usage: khomp log disk \n" \ +"e.g. khomp log disk "; + + _commands.push_back(this); + } + + bool execute(int argc, char *argv[]); + } KhompLogDisk; + + /* khomp log trace k3l */ + static struct _KhompLogTraceK3L : public Command + { + _KhompLogTraceK3L() + { + complete_name = "log trace k3l"; + + options.push_back("on"); + options.push_back("off"); + + brief = "Set K3L tracing (debug) option."; + + usage = \ +"Sets the low-level log for K3L API. Should not be set for long time \n" \ +"periods.\n\n" \ +"Usage: khomp log trace k3l {on|off}\n" \ +"e.g. khomp log trace k3l on"; + + _commands.push_back(this); + } + + bool execute(int argc, char *argv[]); + } KhompLogTraceK3L; + + /* khomp log trace ISDN */ + static struct _KhompLogTraceISDN : public Command + { + _KhompLogTraceISDN() + { + complete_name = "log trace isdn"; + + options.push_back("q931"); + options.push_back("lapd"); + options.push_back("system"); + options.push_back("off"); + + brief = "Set ISDN signaling trace."; + + usage = \ +"Sets the low-level log for ISDN signalling. Should not be set for \n" \ +"long time periods.\n\n" \ +"Usage: khomp log trace isdn [,[,..]]\n" \ +"\twhat -- \"q931\", \"lapd\", \"system\" or \"off\" \n" \ +"\t (comma-separated values).\n" \ +"e.g. khomp log trace isdn q931,system"; + + _commands.push_back(this); + } + + bool execute(int argc, char *argv[]); + } KhompLogTraceISDN; + + /* khomp log trace R2 */ + static struct _KhompLogTraceR2 : public Command + { + _KhompLogTraceR2() + { + complete_name = "log trace r2"; + + options.push_back("on"); + options.push_back("off"); + + brief = "Set R2 signaling trace."; + + usage = \ +"Sets the low-level log monitor for R2 digital signalling. Should not \n" \ +"be set for long time periods.\n\n" \ +"Usage: khomp log trace r2 {on|off}\n" \ +"e.g. khomp log trace r2 on"; + + _commands.push_back(this); + } + + bool execute(int argc, char *argv[]); + } KhompLogTraceR2; + + /* khomp get */ + static struct _KhompGet : public Command + { + _KhompGet() + { + complete_name = "get"; + + options.push_back("echo-canceller"); + options.push_back("out-of-band-dtmfs"); + options.push_back("auto-fax-adjustment"); + options.push_back("pulse-forwarding"); + options.push_back("r2-strict-behaviour"); + options.push_back("r2-preconnect-wait"); + options.push_back("native-bridge"); + options.push_back("suppression-delay"); + options.push_back("context-fxo"); + options.push_back("context-fxo-alt"); + options.push_back("context-fxs"); + options.push_back("context-fxs-alt"); + options.push_back("context-gsm-call"); + options.push_back("context-gsm-call-alt"); + options.push_back("context-gsm-sms"); + options.push_back("context-digital"); + options.push_back("output-volume"); + options.push_back("input-volume"); + + brief = "Get configuration options in the Khomp channel."; + + usage = \ +"Usage: khomp get