[svn-commits] mmichelson: branch group/issue8824 r146688 - in /team/group/issue8824: ./ app...
SVN commits to the Digium repositories
svn-commits at lists.digium.com
Mon Oct 6 11:36:19 CDT 2008
Author: mmichelson
Date: Mon Oct 6 11:36:18 2008
New Revision: 146688
URL: http://svn.digium.com/view/asterisk?view=rev&rev=146688
Log:
Resolve conflict and reset automerge
Modified:
team/group/issue8824/ (props changed)
team/group/issue8824/CHANGES
team/group/issue8824/apps/app_queue.c
team/group/issue8824/configs/queues.conf.sample
Propchange: team/group/issue8824/
------------------------------------------------------------------------------
automerge = *
Propchange: team/group/issue8824/
------------------------------------------------------------------------------
Binary property 'branch-1.4-merged' - no diff available.
Propchange: team/group/issue8824/
------------------------------------------------------------------------------
--- svnmerge-integrated (original)
+++ svnmerge-integrated Mon Oct 6 11:36:18 2008
@@ -1,1 +1,1 @@
-/trunk:1-146607
+/trunk:1-146682
Modified: team/group/issue8824/CHANGES
URL: http://svn.digium.com/view/asterisk/team/group/issue8824/CHANGES?view=diff&rev=146688&r1=146687&r2=146688
==============================================================================
--- team/group/issue8824/CHANGES (original)
+++ team/group/issue8824/CHANGES Mon Oct 6 11:36:18 2008
@@ -609,6 +609,10 @@
is typically placed.
* A new option, 'I' has been added to both app_queue and app_dial. By setting this option, Asterisk
will not update the caller with connected line changes when they occur.
+ * The configuration method for the "joinempty" and "leavewhenempty" options has
+ changed to a comma-separated list of methods of determining member availability
+ instead of vague terms such as "yes," "loose," "no," and "strict." These old four
+ values are still accepted for backwards-compatibility, though.
MeetMe Changes
--------------
Modified: team/group/issue8824/apps/app_queue.c
URL: http://svn.digium.com/view/asterisk/team/group/issue8824/apps/app_queue.c?view=diff&rev=146688&r1=146687&r2=146688
==============================================================================
--- team/group/issue8824/apps/app_queue.c (original)
+++ team/group/issue8824/apps/app_queue.c Mon Oct 6 11:36:18 2008
@@ -396,10 +396,18 @@
char rt_uniqueid[80]; /*!< Unique id of realtime member entry */
};
+enum empty_conditions {
+ QUEUE_EMPTY_PENALTY = (1 << 0),
+ QUEUE_EMPTY_PAUSED = (1 << 1),
+ QUEUE_EMPTY_INUSE = (1 << 2),
+ QUEUE_EMPTY_RINGING = (1 << 3),
+ QUEUE_EMPTY_UNAVAILABLE = (1 << 4),
+ QUEUE_EMPTY_INVALID = (1 << 5),
+ QUEUE_EMPTY_UNKNOWN = (1 << 6),
+ QUEUE_EMPTY_WRAPUP = (1 << 7),
+};
+
/* values used in multi-bit flags in call_queue */
-#define QUEUE_EMPTY_NORMAL 1
-#define QUEUE_EMPTY_STRICT 2
-#define QUEUE_EMPTY_LOOSE 3
#define ANNOUNCEHOLDTIME_ALWAYS 1
#define ANNOUNCEHOLDTIME_ONCE 2
#define QUEUE_EVENT_VARIABLES 3
@@ -462,9 +470,7 @@
/*! Sound files: Custom announce, no default */
struct ast_str *sound_periodicannounce[MAX_PERIODIC_ANNOUNCEMENTS];
unsigned int dead:1;
- unsigned int joinempty:2;
unsigned int eventwhencalled:2;
- unsigned int leavewhenempty:2;
unsigned int ringinuse:1;
unsigned int setinterfacevar:1;
unsigned int setqueuevar:1;
@@ -478,6 +484,8 @@
unsigned int maskmemberstatus:1;
unsigned int realtime:1;
unsigned int found:1;
+ enum empty_conditions joinempty;
+ enum empty_conditions leavewhenempty;
int announcepositionlimit; /*!< How many positions we announce? */
int announcefrequency; /*!< How often to announce their position */
int minannouncefrequency; /*!< The minimum number of seconds between position announcements (def. 15) */
@@ -634,53 +642,67 @@
new->opos = *pos;
}
-enum queue_member_status {
- QUEUE_NO_MEMBERS,
- QUEUE_NO_REACHABLE_MEMBERS,
- QUEUE_NO_UNPAUSED_REACHABLE_MEMBERS,
- QUEUE_NORMAL
-};
-
/*! \brief Check if members are available
*
* This function checks to see if members are available to be called. If any member
- * is available, the function immediately returns QUEUE_NORMAL. If no members are available,
- * the appropriate reason why is returned
+ * is available, the function immediately returns 0. If no members are available,
+ * then -1 is returned.
*/
-static enum queue_member_status get_member_status(struct call_queue *q, int max_penalty, int min_penalty)
+static int get_member_status(struct call_queue *q, int max_penalty, int min_penalty, enum empty_conditions conditions)
{
struct member *member;
struct ao2_iterator mem_iter;
- enum queue_member_status result = QUEUE_NO_MEMBERS;
ao2_lock(q);
mem_iter = ao2_iterator_init(q->members, 0);
for (; (member = ao2_iterator_next(&mem_iter)); ao2_ref(member, -1)) {
- if ((max_penalty && (member->penalty > max_penalty)) || (min_penalty && (member->penalty < min_penalty)))
- continue;
+ if ((max_penalty && (member->penalty > max_penalty)) || (min_penalty && (member->penalty < min_penalty))) {
+ if (conditions & QUEUE_EMPTY_PENALTY) {
+ ast_debug(4, "%s is unavailable because his penalty is not between %d and %d\n", member->membername, min_penalty, max_penalty);
+ continue;
+ }
+ }
switch (member->status) {
case AST_DEVICE_INVALID:
- /* nothing to do */
- break;
+ if (conditions & QUEUE_EMPTY_INVALID) {
+ ast_debug(4, "%s is unavailable because his device state is 'invalid'\n", member->membername);
+ break;
+ }
case AST_DEVICE_UNAVAILABLE:
- if (result != QUEUE_NO_UNPAUSED_REACHABLE_MEMBERS)
- result = QUEUE_NO_REACHABLE_MEMBERS;
- break;
+ if (conditions & QUEUE_EMPTY_UNAVAILABLE) {
+ ast_debug(4, "%s is unavailable because his device state is 'unavailable'\n", member->membername);
+ break;
+ }
+ case AST_DEVICE_INUSE:
+ if (conditions & QUEUE_EMPTY_INUSE) {
+ ast_debug(4, "%s is unavailable because his device state is 'inuse'\n", member->membername);
+ break;
+ }
+ case AST_DEVICE_UNKNOWN:
+ if (conditions & QUEUE_EMPTY_UNKNOWN) {
+ ast_debug(4, "%s is unavailable because his device state is 'unknown'\n", member->membername);
+ break;
+ }
default:
- if (member->paused) {
- result = QUEUE_NO_UNPAUSED_REACHABLE_MEMBERS;
+ if (member->paused && (conditions & QUEUE_EMPTY_PAUSED)) {
+ ast_debug(4, "%s is unavailable because he is paused'\n", member->membername);
+ break;
+ } else if ((conditions & QUEUE_EMPTY_WRAPUP) && member->lastcall && q->wrapuptime && (time(NULL) - q->wrapuptime < member->lastcall)) {
+ ast_debug(4, "%s is unavailable because it has only been %d seconds since his last call (wrapup time is %d)\n", member->membername, (int) (time(NULL) - member->lastcall), q->wrapuptime);
+ break;
} else {
ao2_unlock(q);
ao2_ref(member, -1);
- return QUEUE_NORMAL;
+ ast_debug(4, "%s is available.\n", member->membername);
+ return 0;
}
break;
}
}
ao2_unlock(q);
- return result;
+ return -1;
}
struct statechange {
@@ -1002,6 +1024,39 @@
}
return 0;
+}
+
+static void parse_empty_options(const char *value, enum empty_conditions *empty)
+{
+ char *value_copy = ast_strdupa(value);
+ char *option = NULL;
+ while ((option = strsep(&value_copy, ","))) {
+ if (!strcasecmp(option, "paused")) {
+ *empty |= QUEUE_EMPTY_PAUSED;
+ } else if (!strcasecmp(option, "penalty")) {
+ *empty |= QUEUE_EMPTY_PENALTY;
+ } else if (!strcasecmp(option, "inuse")) {
+ *empty |= QUEUE_EMPTY_INUSE;
+ } else if (!strcasecmp(option, "ringing")) {
+ *empty |= QUEUE_EMPTY_RINGING;
+ } else if (!strcasecmp(option, "invalid")) {
+ *empty |= QUEUE_EMPTY_INVALID;
+ } else if (!strcasecmp(option, "wrapup")) {
+ *empty |= QUEUE_EMPTY_WRAPUP;
+ } else if (!strcasecmp(option, "unavailable")) {
+ *empty |= QUEUE_EMPTY_UNAVAILABLE;
+ } else if (!strcasecmp(option, "unknown")) {
+ *empty |= QUEUE_EMPTY_UNKNOWN;
+ } else if (!strcasecmp(option, "loose")) {
+ *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID);
+ } else if (!strcasecmp(option, "strict")) {
+ *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID | QUEUE_EMPTY_PAUSED | QUEUE_EMPTY_UNAVAILABLE);
+ } else if (ast_false(option)) {
+ *empty = (QUEUE_EMPTY_PENALTY | QUEUE_EMPTY_INVALID | QUEUE_EMPTY_PAUSED);
+ } else if (ast_true(option)) {
+ *empty = 0;
+ }
+ }
}
/*! \brief Configure a queue parameter.
@@ -1146,23 +1201,9 @@
/* We already have set this, no need to do it again */
return;
} else if (!strcasecmp(param, "joinempty")) {
- if (!strcasecmp(val, "loose"))
- q->joinempty = QUEUE_EMPTY_LOOSE;
- else if (!strcasecmp(val, "strict"))
- q->joinempty = QUEUE_EMPTY_STRICT;
- else if (ast_true(val))
- q->joinempty = QUEUE_EMPTY_NORMAL;
- else
- q->joinempty = 0;
+ parse_empty_options(val, &q->joinempty);
} else if (!strcasecmp(param, "leavewhenempty")) {
- if (!strcasecmp(val, "loose"))
- q->leavewhenempty = QUEUE_EMPTY_LOOSE;
- else if (!strcasecmp(val, "strict"))
- q->leavewhenempty = QUEUE_EMPTY_STRICT;
- else if (ast_true(val))
- q->leavewhenempty = QUEUE_EMPTY_NORMAL;
- else
- q->leavewhenempty = 0;
+ parse_empty_options(val, &q->leavewhenempty);
} else if (!strcasecmp(param, "eventmemberstatus")) {
q->maskmemberstatus = !ast_true(val);
} else if (!strcasecmp(param, "eventwhencalled")) {
@@ -1562,7 +1603,6 @@
int res = -1;
int pos = 0;
int inserted = 0;
- enum queue_member_status status;
if (!(q = load_realtime_queue(queuename)))
return res;
@@ -1571,14 +1611,14 @@
ao2_lock(q);
/* This is our one */
- if (q->joinempty != QUEUE_EMPTY_NORMAL) {
- status = get_member_status(q, qe->max_penalty, qe->min_penalty);
- if (!q->joinempty && (status == QUEUE_NO_MEMBERS))
+ if (q->joinempty) {
+ int status = 0;
+ if ((status = get_member_status(q, qe->max_penalty, qe->min_penalty, q->joinempty))) {
*reason = QUEUE_JOINEMPTY;
- else if ((q->joinempty == QUEUE_EMPTY_STRICT) && (status == QUEUE_NO_REACHABLE_MEMBERS || status == QUEUE_NO_UNPAUSED_REACHABLE_MEMBERS || status == QUEUE_NO_MEMBERS))
- *reason = QUEUE_JOINUNAVAIL;
- else if ((q->joinempty == QUEUE_EMPTY_LOOSE) && (status == QUEUE_NO_REACHABLE_MEMBERS || status == QUEUE_NO_MEMBERS))
- *reason = QUEUE_JOINUNAVAIL;
+ ao2_unlock(q);
+ ao2_unlock(queues);
+ return res;
+ }
}
if (*reason == QUEUE_UNKNOWN && q->maxlen && (q->count >= q->maxlen))
*reason = QUEUE_FULL;
@@ -2776,7 +2816,6 @@
/* This is the holding pen for callers 2 through maxlen */
for (;;) {
- enum queue_member_status status;
if (is_our_turn(qe))
break;
@@ -2788,25 +2827,10 @@
}
if (qe->parent->leavewhenempty) {
- status = get_member_status(qe->parent, qe->max_penalty, qe->min_penalty);
-
- /* leave the queue if no agents, if enabled */
- if (status == QUEUE_NO_MEMBERS) {
+ int status = 0;
+
+ if ((status = get_member_status(qe->parent, qe->max_penalty, qe->min_penalty, qe->parent->leavewhenempty))) {
*reason = QUEUE_LEAVEEMPTY;
- ast_queue_log(qe->parent->name, qe->chan->uniqueid, "NONE", "EXITEMPTY", "%d|%d|%ld", qe->pos, qe->opos, (long) time(NULL) - qe->start);
- leave_queue(qe);
- break;
- }
-
- /* leave the queue if no reachable agents, if enabled */
- if ((qe->parent->leavewhenempty == QUEUE_EMPTY_STRICT) && (status == QUEUE_NO_REACHABLE_MEMBERS || status == QUEUE_NO_UNPAUSED_REACHABLE_MEMBERS)) {
- *reason = QUEUE_LEAVEUNAVAIL;
- ast_queue_log(qe->parent->name, qe->chan->uniqueid, "NONE", "EXITEMPTY", "%d|%d|%ld", qe->pos, qe->opos, (long) time(NULL) - qe->start);
- leave_queue(qe);
- break;
- }
- if ((qe->parent->leavewhenempty == QUEUE_EMPTY_LOOSE) && (status == QUEUE_NO_REACHABLE_MEMBERS)) {
- *reason = QUEUE_LEAVEUNAVAIL;
ast_queue_log(qe->parent->name, qe->chan->uniqueid, "NONE", "EXITEMPTY", "%d|%d|%ld", qe->pos, qe->opos, (long) time(NULL) - qe->start);
leave_queue(qe);
break;
@@ -4652,8 +4676,6 @@
/* they may dial a digit from the queue context; */
/* or, they may timeout. */
- enum queue_member_status status;
-
/* Leave if we have exceeded our queuetimeout */
if (qe.expire && (time(NULL) >= qe.expire)) {
record_abandoned(&qe);
@@ -4698,27 +4720,11 @@
}
if (qe.parent->leavewhenempty) {
- status = get_member_status(qe.parent, qe.max_penalty, qe.min_penalty);
- /* leave the queue if no agents, if enabled */
- if (status == QUEUE_NO_MEMBERS) {
+ int status = 0;
+ if ((status = get_member_status(qe.parent, qe.max_penalty, qe.min_penalty, qe.parent->leavewhenempty))) {
record_abandoned(&qe);
reason = QUEUE_LEAVEEMPTY;
ast_queue_log(args.queuename, chan->uniqueid, "NONE", "EXITEMPTY", "%d|%d|%ld", qe.pos, qe.opos, (long)(time(NULL) - qe.start));
- res = 0;
- break;
- }
-
- /* leave the queue if no reachable agents, if enabled */
- if ((qe.parent->leavewhenempty == QUEUE_EMPTY_STRICT) && (status == QUEUE_NO_REACHABLE_MEMBERS || status == QUEUE_NO_UNPAUSED_REACHABLE_MEMBERS)) {
- record_abandoned(&qe);
- reason = QUEUE_LEAVEUNAVAIL;
- ast_queue_log(args.queuename, chan->uniqueid, "NONE", "EXITEMPTY", "%d|%d|%ld", qe.pos, qe.opos, (long)(time(NULL) - qe.start));
- res = 0;
- break;
- }
- if ((qe.parent->leavewhenempty == QUEUE_EMPTY_LOOSE) && (status == QUEUE_NO_REACHABLE_MEMBERS)) {
- record_abandoned(&qe);
- reason = QUEUE_LEAVEUNAVAIL;
res = 0;
break;
}
Modified: team/group/issue8824/configs/queues.conf.sample
URL: http://svn.digium.com/view/asterisk/team/group/issue8824/configs/queues.conf.sample?view=diff&rev=146688&r1=146687&r2=146688
==============================================================================
--- team/group/issue8824/configs/queues.conf.sample (original)
+++ team/group/issue8824/configs/queues.conf.sample Mon Oct 6 11:36:18 2008
@@ -365,25 +365,58 @@
; The contents of MONITOR_FILENAME will also be unescaped from ^{X} to ${X} and
; all variables will be evaluated just prior to recording being started.
;
-;
-; This setting controls whether callers can join a queue with no members. There
-; are three choices:
-;
-; yes - callers can join a queue with no members or only unavailable members
-; no - callers cannot join a queue with no members
-; strict - callers cannot join a queue with no members or only unavailable
-; members
-; loose - same as strict, but paused queue members do not count as unavailable
-;
-; joinempty = yes
-;
-;
-; If you wish to remove callers from the queue when new callers cannot join,
-; set this setting to one of the same choices for 'joinempty'
-;
-; leavewhenempty = yes
-;
-;
+; ---------------------- Queue Empty Options ----------------------------------
+;
+; Asterisk has provided the "joinempty" and "leavewhenempty" options for a while
+; with tenuous definitions of what they actually mean. The "joinempty" option controls
+; whether a caller may join a queue depending on several factors of member availability.
+; Similarly, then leavewhenempty option controls whether a caller may remain in a queue
+; he has already joined. Both options take a comma-separated list of factors which
+; contribute towards whether a caller may join/remain in the queue. The list of
+; factors which contribute to these option is as follows:
+;
+; paused: a member is not considered available if he is paused
+; penalty: a member is not considered available if his penalty is less than QUEUE_MAX_PENALTY
+; inuse: a member is not considered available if he is currently on a call
+; ringing: a member is not considered available if his phone is currently ringing
+; unavailable: This applies mainly to Agent channels. If the agent is a member of the queue
+; but has not logged in, then do not consider the member to be available
+; invalid: Do not consider a member to be available if he has an "invalid" device state.
+; This generally is caused by an error condition in the member's channel driver.
+; unknown: Do not consider a member to be available if we are unable to determine the member's
+; current device state.
+; wrapup: A member is not considered available if he is currently in his wrapuptime after
+; taking a call.
+;
+; For the "joinempty" option, when a caller attempts to enter a queue, the members of that
+; queue are examined. If all members are deemed to be unavailable due to any of the conditions
+; listed for the "joinempty" option, then the caller will be unable to enter the queue. For the
+; "leavewhenempty" option, the state of the members of the queue are checked periodically during
+; the caller's stay in the queue. If all of the members are unavailable due to any of the above
+; conditions, then the caller will be removed from the queue.
+;
+; Some examples:
+;
+;joinempty = paused,inuse,invalid
+;
+; A caller will not be able to enter a queue if at least one member cannot be found
+; who is not paused, on the phone, or who has an invalid device state.
+;
+;leavewhenempty = inuse,ringing
+;
+; A caller will be removed from the queue if at least one member cannot be found
+; who is not on the phone, or whose phone is not ringing.
+;
+; For the sake of backwards-compatibility, the joinempty and leavewhenempty
+; options also accept the strings "yes" "no" "strict" and "loose". The following
+; serves as a translation for these values:
+;
+; yes - (empty) for joinempty; penalty,paused,invalid for leavewhenempty
+; no - penalty,paused,invalid for joinempty; (empty) for leavewhenempty
+; strict - penalty,paused,invalid,unavailable
+; loose - penalty,invalid
+;
+
; If this is set to yes, the following manager events will be generated:
; AgentCalled, AgentDump, AgentConnect, AgentComplete; setting this to
; vars also sends all channel variables with the event.
More information about the svn-commits
mailing list