Go to the source code of this file.
Typedefs | |
typedef void(*) | ast_dial_state_callback (struct ast_dial *) |
Enumerations | |
enum | ast_dial_option { AST_DIAL_OPTION_RINGING, AST_DIAL_OPTION_ANSWER_EXEC, AST_DIAL_OPTION_MUSIC, AST_DIAL_OPTION_DISABLE_CALL_FORWARDING, AST_DIAL_OPTION_MAX } |
List of options that are applicable either globally or per dialed channel. More... | |
enum | ast_dial_result { AST_DIAL_RESULT_INVALID, AST_DIAL_RESULT_FAILED, AST_DIAL_RESULT_TRYING, AST_DIAL_RESULT_RINGING, AST_DIAL_RESULT_PROGRESS, AST_DIAL_RESULT_PROCEEDING, AST_DIAL_RESULT_ANSWERED, AST_DIAL_RESULT_TIMEOUT, AST_DIAL_RESULT_HANGUP, AST_DIAL_RESULT_UNANSWERED } |
List of return codes for dial run API calls. More... | |
Functions | |
ast_channel * | ast_dial_answered (struct ast_dial *dial) |
Return channel that answered. | |
ast_channel * | ast_dial_answered_steal (struct ast_dial *dial) |
Steal the channel that answered. | |
int | ast_dial_append (struct ast_dial *dial, const char *tech, const char *device) |
Append a channel. | |
ast_dial * | ast_dial_create (void) |
New dialing structure. | |
int | ast_dial_destroy (struct ast_dial *dial) |
Destroys a dialing structure. | |
void | ast_dial_hangup (struct ast_dial *dial) |
Hangup channels. | |
enum ast_dial_result | ast_dial_join (struct ast_dial *dial) |
Cancel async thread. | |
int | ast_dial_option_disable (struct ast_dial *dial, int num, enum ast_dial_option option) |
Disables an option per channel. | |
int | ast_dial_option_enable (struct ast_dial *dial, int num, enum ast_dial_option option, void *data) |
Enables an option per channel. | |
int | ast_dial_option_global_disable (struct ast_dial *dial, enum ast_dial_option option) |
Disables an option globally. | |
int | ast_dial_option_global_enable (struct ast_dial *dial, enum ast_dial_option option, void *data) |
Enables an option globally. | |
enum ast_dial_result | ast_dial_run (struct ast_dial *dial, struct ast_channel *chan, int async) |
Execute dialing synchronously or asynchronously. | |
void | ast_dial_set_global_timeout (struct ast_dial *dial, int timeout) |
Set the maximum time (globally) allowed for trying to ring phones. | |
void | ast_dial_set_state_callback (struct ast_dial *dial, ast_dial_state_callback callback) |
Set a callback for state changes. | |
void | ast_dial_set_timeout (struct ast_dial *dial, int num, int timeout) |
Set the maximum time (per channel) allowed for trying to ring the phone. | |
enum ast_dial_result | ast_dial_state (struct ast_dial *dial) |
Return state of dial. |
Definition in file dial.h.
typedef void(*) ast_dial_state_callback(struct ast_dial *) |
enum ast_dial_option |
List of options that are applicable either globally or per dialed channel.
Definition at line 39 of file dial.h.
00039 { 00040 AST_DIAL_OPTION_RINGING, /*!< Always indicate ringing to caller */ 00041 AST_DIAL_OPTION_ANSWER_EXEC, /*!< Execute application upon answer in async mode */ 00042 AST_DIAL_OPTION_MUSIC, /*!< Play music on hold instead of ringing to the calling channel */ 00043 AST_DIAL_OPTION_DISABLE_CALL_FORWARDING, /*!< Disable call forwarding on channels */ 00044 AST_DIAL_OPTION_MAX, /*!< End terminator -- must always remain last */ 00045 };
enum ast_dial_result |
List of return codes for dial run API calls.
Definition at line 48 of file dial.h.
00048 { 00049 AST_DIAL_RESULT_INVALID, /*!< Invalid options were passed to run function */ 00050 AST_DIAL_RESULT_FAILED, /*!< Attempts to dial failed before reaching critical state */ 00051 AST_DIAL_RESULT_TRYING, /*!< Currently trying to dial */ 00052 AST_DIAL_RESULT_RINGING, /*!< Dial is presently ringing */ 00053 AST_DIAL_RESULT_PROGRESS, /*!< Dial is presently progressing */ 00054 AST_DIAL_RESULT_PROCEEDING, /*!< Dial is presently proceeding */ 00055 AST_DIAL_RESULT_ANSWERED, /*!< A channel was answered */ 00056 AST_DIAL_RESULT_TIMEOUT, /*!< Timeout was tripped, nobody answered */ 00057 AST_DIAL_RESULT_HANGUP, /*!< Caller hung up */ 00058 AST_DIAL_RESULT_UNANSWERED, /*!< Nobody answered */ 00059 };
struct ast_channel* ast_dial_answered | ( | struct ast_dial * | dial | ) |
Return channel that answered.
dial | Dialing structure |
Definition at line 747 of file dial.c.
References AST_DIAL_RESULT_ANSWERED, AST_LIST_FIRST, ast_dial::channels, and ast_dial::state.
Referenced by dial_trunk(), and sla_handle_dial_state_event().
00748 { 00749 if (!dial) 00750 return NULL; 00751 00752 return ((dial->state == AST_DIAL_RESULT_ANSWERED) ? AST_LIST_FIRST(&dial->channels)->owner : NULL); 00753 }
struct ast_channel* ast_dial_answered_steal | ( | struct ast_dial * | dial | ) |
Steal the channel that answered.
dial | Dialing structure |
Definition at line 759 of file dial.c.
References AST_DIAL_RESULT_ANSWERED, AST_LIST_FIRST, ast_dial::channels, and ast_dial::state.
Referenced by do_notify().
00760 { 00761 struct ast_channel *chan = NULL; 00762 00763 if (!dial) 00764 return NULL; 00765 00766 if (dial->state == AST_DIAL_RESULT_ANSWERED) { 00767 chan = AST_LIST_FIRST(&dial->channels)->owner; 00768 AST_LIST_FIRST(&dial->channels)->owner = NULL; 00769 } 00770 00771 return chan; 00772 }
int ast_dial_append | ( | struct ast_dial * | dial, | |
const char * | tech, | |||
const char * | device | |||
) |
Append a channel.
Definition at line 222 of file dial.c.
References ast_atomic_fetchadd_int(), ast_calloc, AST_LIST_INSERT_TAIL, ast_strdup, ast_dial::channels, ast_dial_channel::list, and ast_dial::num.
Referenced by dial_trunk(), do_notify(), and sla_ring_station().
00223 { 00224 struct ast_dial_channel *channel = NULL; 00225 00226 /* Make sure we have required arguments */ 00227 if (!dial || !tech || !device) 00228 return -1; 00229 00230 /* Allocate new memory for dialed channel structure */ 00231 if (!(channel = ast_calloc(1, sizeof(*channel)))) 00232 return -1; 00233 00234 /* Record technology and device for when we actually dial */ 00235 channel->tech = ast_strdup(tech); 00236 channel->device = ast_strdup(device); 00237 00238 /* Grab reference number from dial structure */ 00239 channel->num = ast_atomic_fetchadd_int(&dial->num, +1); 00240 00241 /* No timeout exists... yet */ 00242 channel->timeout = -1; 00243 00244 /* Insert into channels list */ 00245 AST_LIST_INSERT_TAIL(&dial->channels, channel, list); 00246 00247 return channel->num; 00248 }
struct ast_dial* ast_dial_create | ( | void | ) |
New dialing structure.
Definition at line 194 of file dial.c.
References ast_calloc, AST_LIST_HEAD_INIT, ast_mutex_init, and AST_PTHREADT_NULL.
Referenced by dial_trunk(), do_notify(), and sla_ring_station().
00195 { 00196 struct ast_dial *dial = NULL; 00197 00198 /* Allocate new memory for structure */ 00199 if (!(dial = ast_calloc(1, sizeof(*dial)))) 00200 return NULL; 00201 00202 /* Initialize list of channels */ 00203 AST_LIST_HEAD_INIT(&dial->channels); 00204 00205 /* Initialize thread to NULL */ 00206 dial->thread = AST_PTHREADT_NULL; 00207 00208 /* No timeout exists... yet */ 00209 dial->timeout = -1; 00210 dial->actual_timeout = -1; 00211 00212 /* Can't forget about the lock */ 00213 ast_mutex_init(&dial->lock); 00214 00215 return dial; 00216 }
int ast_dial_destroy | ( | struct ast_dial * | dial | ) |
Destroys a dialing structure.
dial | Dialing structure to free |
Definition at line 859 of file dial.c.
References AST_DIAL_OPTION_MAX, ast_free, ast_hangup(), AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, ast_dial::channels, ast_dial_channel::device, ast_dial_channel::list, option_types, ast_dial_channel::options, ast_dial_channel::owner, and ast_dial_channel::tech.
Referenced by dial_trunk(), do_notify(), run_station(), sla_hangup_stations(), sla_ring_station(), and sla_stop_ringing_station().
00860 { 00861 int i = 0; 00862 struct ast_dial_channel *channel = NULL; 00863 00864 if (!dial) 00865 return -1; 00866 00867 /* Hangup and deallocate all the dialed channels */ 00868 AST_LIST_LOCK(&dial->channels); 00869 AST_LIST_TRAVERSE_SAFE_BEGIN(&dial->channels, channel, list) { 00870 /* Disable any enabled options */ 00871 for (i = 0; i < AST_DIAL_OPTION_MAX; i++) { 00872 if (!channel->options[i]) 00873 continue; 00874 if (option_types[i].disable) 00875 option_types[i].disable(channel->options[i]); 00876 channel->options[i] = NULL; 00877 } 00878 /* Hang up channel if need be */ 00879 if (channel->owner) { 00880 ast_hangup(channel->owner); 00881 channel->owner = NULL; 00882 } 00883 /* Free structure */ 00884 ast_free(channel->tech); 00885 ast_free(channel->device); 00886 AST_LIST_REMOVE_CURRENT(list); 00887 ast_free(channel); 00888 } 00889 AST_LIST_TRAVERSE_SAFE_END; 00890 AST_LIST_UNLOCK(&dial->channels); 00891 00892 /* Disable any enabled options globally */ 00893 for (i = 0; i < AST_DIAL_OPTION_MAX; i++) { 00894 if (!dial->options[i]) 00895 continue; 00896 if (option_types[i].disable) 00897 option_types[i].disable(dial->options[i]); 00898 dial->options[i] = NULL; 00899 } 00900 00901 /* Lock be gone! */ 00902 ast_mutex_destroy(&dial->lock); 00903 00904 /* Free structure */ 00905 ast_free(dial); 00906 00907 return 0; 00908 }
void ast_dial_hangup | ( | struct ast_dial * | dial | ) |
Hangup channels.
dial | Dialing structure |
Definition at line 835 of file dial.c.
References ast_hangup(), AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_dial::channels, ast_dial_channel::list, and ast_dial_channel::owner.
Referenced by ast_dial_run().
00836 { 00837 struct ast_dial_channel *channel = NULL; 00838 00839 if (!dial) 00840 return; 00841 00842 AST_LIST_LOCK(&dial->channels); 00843 AST_LIST_TRAVERSE(&dial->channels, channel, list) { 00844 if (channel->owner) { 00845 ast_hangup(channel->owner); 00846 channel->owner = NULL; 00847 } 00848 } 00849 AST_LIST_UNLOCK(&dial->channels); 00850 00851 return; 00852 }
enum ast_dial_result ast_dial_join | ( | struct ast_dial * | dial | ) |
Cancel async thread.
dial | Dialing structure |
Definition at line 787 of file dial.c.
References ast_channel_lock, ast_channel_unlock, AST_DIAL_RESULT_FAILED, AST_LIST_FIRST, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_mutex_lock, ast_mutex_unlock, AST_PTHREADT_NULL, AST_PTHREADT_STOP, ast_softhangup(), AST_SOFTHANGUP_EXPLICIT, ast_dial::channels, ast_dial::lock, ast_dial::state, and ast_dial::thread.
Referenced by dial_trunk(), run_station(), sla_hangup_stations(), sla_ring_station(), and sla_stop_ringing_station().
00788 { 00789 pthread_t thread; 00790 00791 /* If the dial structure is not running in async, return failed */ 00792 if (dial->thread == AST_PTHREADT_NULL) 00793 return AST_DIAL_RESULT_FAILED; 00794 00795 /* Record thread */ 00796 thread = dial->thread; 00797 00798 /* Boom, commence locking */ 00799 ast_mutex_lock(&dial->lock); 00800 00801 /* Stop the thread */ 00802 dial->thread = AST_PTHREADT_STOP; 00803 00804 /* If the answered channel is running an application we have to soft hangup it, can't just poke the thread */ 00805 AST_LIST_LOCK(&dial->channels); 00806 if (AST_LIST_FIRST(&dial->channels)->is_running_app) { 00807 struct ast_channel *chan = AST_LIST_FIRST(&dial->channels)->owner; 00808 if (chan) { 00809 ast_channel_lock(chan); 00810 ast_softhangup(chan, AST_SOFTHANGUP_EXPLICIT); 00811 ast_channel_unlock(chan); 00812 } 00813 } else { 00814 /* Now we signal it with SIGURG so it will break out of it's waitfor */ 00815 pthread_kill(thread, SIGURG); 00816 } 00817 AST_LIST_UNLOCK(&dial->channels); 00818 00819 /* Yay done with it */ 00820 ast_mutex_unlock(&dial->lock); 00821 00822 /* Finally wait for the thread to exit */ 00823 pthread_join(thread, NULL); 00824 00825 /* Yay thread is all gone */ 00826 dial->thread = AST_PTHREADT_NULL; 00827 00828 return dial->state; 00829 }
int ast_dial_option_disable | ( | struct ast_dial * | dial, | |
int | num, | |||
enum ast_dial_option | option | |||
) |
Disables an option per channel.
dial | Dial structure | |
num | Channel number to disable option on | |
option | Option to disable |
Definition at line 1011 of file dial.c.
References AST_LIST_EMPTY, ast_dial::channels, ast_option_types::disable, find_dial_channel(), option_types, and ast_dial_channel::options.
01012 { 01013 struct ast_dial_channel *channel = NULL; 01014 01015 /* Ensure we have required arguments */ 01016 if (!dial || AST_LIST_EMPTY(&dial->channels)) 01017 return -1; 01018 01019 if (!(channel = find_dial_channel(dial, num))) 01020 return -1; 01021 01022 /* If the option is not enabled, return failure */ 01023 if (!channel->options[option]) 01024 return -1; 01025 01026 /* Execute callback of option to disable it if it exists */ 01027 if (option_types[option].disable) 01028 option_types[option].disable(channel->options[option]); 01029 01030 /* Finally disable the option on the structure */ 01031 channel->options[option] = NULL; 01032 01033 return 0; 01034 }
int ast_dial_option_enable | ( | struct ast_dial * | dial, | |
int | num, | |||
enum ast_dial_option | option, | |||
void * | data | |||
) |
Enables an option per channel.
dial | Dial structure | |
num | Channel number to enable option on | |
option | Option to enable | |
data | Data to pass to this option (not always needed) |
Definition at line 959 of file dial.c.
References AST_LIST_EMPTY, ast_dial::channels, ast_option_types::enable, find_dial_channel(), option_types, and ast_dial_channel::options.
00960 { 00961 struct ast_dial_channel *channel = NULL; 00962 00963 /* Ensure we have required arguments */ 00964 if (!dial || AST_LIST_EMPTY(&dial->channels)) 00965 return -1; 00966 00967 if (!(channel = find_dial_channel(dial, num))) 00968 return -1; 00969 00970 /* If the option is already enabled, return failure */ 00971 if (channel->options[option]) 00972 return -1; 00973 00974 /* Execute enable callback if it exists, if not simply make sure the value is set */ 00975 if (option_types[option].enable) 00976 channel->options[option] = option_types[option].enable(data); 00977 else 00978 channel->options[option] = (void*)1; 00979 00980 return 0; 00981 }
int ast_dial_option_global_disable | ( | struct ast_dial * | dial, | |
enum ast_dial_option | option | |||
) |
Disables an option globally.
dial | Dial structure to disable option on | |
option | Option to disable |
Definition at line 988 of file dial.c.
References ast_option_types::disable, option_types, and ast_dial::options.
00989 { 00990 /* If the option is not enabled, return failure */ 00991 if (!dial->options[option]) { 00992 return -1; 00993 } 00994 00995 /* Execute callback of option to disable if it exists */ 00996 if (option_types[option].disable) 00997 option_types[option].disable(dial->options[option]); 00998 00999 /* Finally disable option on the structure */ 01000 dial->options[option] = NULL; 01001 01002 return 0; 01003 }
int ast_dial_option_global_enable | ( | struct ast_dial * | dial, | |
enum ast_dial_option | option, | |||
void * | data | |||
) |
Enables an option globally.
dial | Dial structure to enable option on | |
option | Option to enable | |
data | Data to pass to this option (not always needed) |
Definition at line 916 of file dial.c.
References ast_option_types::enable, option_types, and ast_dial::options.
Referenced by do_notify().
00917 { 00918 /* If the option is already enabled, return failure */ 00919 if (dial->options[option]) 00920 return -1; 00921 00922 /* Execute enable callback if it exists, if not simply make sure the value is set */ 00923 if (option_types[option].enable) 00924 dial->options[option] = option_types[option].enable(data); 00925 else 00926 dial->options[option] = (void*)1; 00927 00928 return 0; 00929 }
enum ast_dial_result ast_dial_run | ( | struct ast_dial * | dial, | |
struct ast_channel * | chan, | |||
int | async | |||
) |
Execute dialing synchronously or asynchronously.
Definition at line 707 of file dial.c.
References ast_debug, ast_dial_hangup(), AST_DIAL_RESULT_FAILED, AST_DIAL_RESULT_INVALID, AST_DIAL_RESULT_TRYING, AST_LIST_EMPTY, ast_pthread_create, async_dial(), begin_dial(), ast_dial::channels, monitor_dial(), ast_dial::state, and ast_dial::thread.
Referenced by dial_trunk(), do_notify(), and sla_ring_station().
00708 { 00709 enum ast_dial_result res = AST_DIAL_RESULT_TRYING; 00710 00711 /* Ensure required arguments are passed */ 00712 if (!dial || (!chan && !async)) { 00713 ast_debug(1, "invalid #1\n"); 00714 return AST_DIAL_RESULT_INVALID; 00715 } 00716 00717 /* If there are no channels to dial we can't very well try to dial them */ 00718 if (AST_LIST_EMPTY(&dial->channels)) { 00719 ast_debug(1, "invalid #2\n"); 00720 return AST_DIAL_RESULT_INVALID; 00721 } 00722 00723 /* Dial each requested channel */ 00724 if (!begin_dial(dial, chan)) 00725 return AST_DIAL_RESULT_FAILED; 00726 00727 /* If we are running async spawn a thread and send it away... otherwise block here */ 00728 if (async) { 00729 dial->state = AST_DIAL_RESULT_TRYING; 00730 /* Try to create a thread */ 00731 if (ast_pthread_create(&dial->thread, NULL, async_dial, dial)) { 00732 /* Failed to create the thread - hangup all dialed channels and return failed */ 00733 ast_dial_hangup(dial); 00734 res = AST_DIAL_RESULT_FAILED; 00735 } 00736 } else { 00737 res = monitor_dial(dial, chan); 00738 } 00739 00740 return res; 00741 }
void ast_dial_set_global_timeout | ( | struct ast_dial * | dial, | |
int | timeout | |||
) |
Set the maximum time (globally) allowed for trying to ring phones.
dial | The dial structure to apply the time limit to | |
timeout | Maximum time allowed |
Definition at line 1046 of file dial.c.
References ast_dial::actual_timeout, and ast_dial::timeout.
Referenced by do_notify().
01047 { 01048 dial->timeout = timeout; 01049 01050 if (dial->timeout > 0 && (dial->actual_timeout > dial->timeout || dial->actual_timeout == -1)) 01051 dial->actual_timeout = dial->timeout; 01052 01053 return; 01054 }
void ast_dial_set_state_callback | ( | struct ast_dial * | dial, | |
ast_dial_state_callback | callback | |||
) |
Set a callback for state changes.
dial | The dial structure to watch for state changes | |
callback | the callback |
Definition at line 1036 of file dial.c.
References ast_dial::state_callback.
Referenced by sla_ring_station().
01037 { 01038 dial->state_callback = callback; 01039 }
void ast_dial_set_timeout | ( | struct ast_dial * | dial, | |
int | num, | |||
int | timeout | |||
) |
Set the maximum time (per channel) allowed for trying to ring the phone.
dial | The dial structure the channel belongs to | |
num | Channel number to set timeout on | |
timeout | Maximum time allowed |
Definition at line 1062 of file dial.c.
References ast_dial::actual_timeout, find_dial_channel(), and ast_dial_channel::timeout.
01063 { 01064 struct ast_dial_channel *channel = NULL; 01065 01066 if (!(channel = find_dial_channel(dial, num))) 01067 return; 01068 01069 channel->timeout = timeout; 01070 01071 if (channel->timeout > 0 && (dial->actual_timeout > channel->timeout || dial->actual_timeout == -1)) 01072 dial->actual_timeout = channel->timeout; 01073 01074 return; 01075 }
enum ast_dial_result ast_dial_state | ( | struct ast_dial * | dial | ) |
Return state of dial.
dial | Dialing structure |
Definition at line 778 of file dial.c.
References ast_dial::state.
Referenced by dial_trunk(), and sla_handle_dial_state_event().
00779 { 00780 return dial->state; 00781 }