]> git.ipfire.org Git - thirdparty/freeswitch.git/commitdiff
mod_fifo: Document caller DTMF handler
authorTravis Cross <tc@traviscross.com>
Mon, 26 May 2014 17:34:22 +0000 (17:34 +0000)
committerTravis Cross <tc@traviscross.com>
Wed, 28 May 2014 01:32:05 +0000 (01:32 +0000)
src/mod/applications/mod_fifo/mod_fifo.c

index d6a2159897bb3662d54315f03c93395be8168df0..8db7a5c5451f97263388337c03b7288a19aec242 100644 (file)
@@ -503,6 +503,13 @@ static switch_status_t on_dtmf(switch_core_session_t *session, void *input, swit
        return SWITCH_STATUS_SUCCESS;
 }
 
+/*! \brief Handler for caller DTMF
+ *
+ * The channel variable `fifo_caller_exit_key` can be set to one or
+ * more digits that when pressed will cause the caller to exit from
+ * the fifo.  We'll return via a single character in `buf` the digit
+ * that was pressed (not null-terminated).
+ */
 static switch_status_t moh_on_dtmf(switch_core_session_t *session, void *input, switch_input_type_t itype, void *buf, unsigned int buflen)
 {
        switch (itype) {