Sun Oct 16 2011 08:43:13

Asterisk developer's documentation


call_queue Struct Reference
Collaboration diagram for call_queue:

Data Fields

struct ast_string_field_mgr __field_mgr
struct ast_string_field_pool__field_mgr_pool
const ast_string_field announce
int announcefrequency
unsigned int announceholdtime:2
unsigned int announceposition:3
int announcepositionlimit
int autofill
int autopause
int callsabandoned
int callscompleted
int callscompletedinsl
const ast_string_field context
int count
unsigned int dead:1
const ast_string_field defaultrule
unsigned int eventwhencalled:2
unsigned int found:1
struct queue_enthead
int holdtime
enum empty_conditions joinempty
enum empty_conditions leavewhenempty
struct {
   struct call_queue *   next
list
unsigned int maskmemberstatus:1
int maxlen
int membercount
 Number of members _logged in_.
int memberdelay
const ast_string_field membergosub
const ast_string_field membermacro
struct ao2_containermembers
int minannouncefrequency
const ast_string_field moh
char monfmt [8]
int montype
const ast_string_field name
int numperiodicannounce
int penaltymemberslimit
int periodicannouncefrequency
const ast_string_field queue_quantity1
const ast_string_field queue_quantity2
int randomperiodicannounce
unsigned int realtime:1
unsigned int relativeperiodicannounce:1
unsigned int reportholdtime:1
int retry
unsigned int ringinuse:1
int roundingseconds
int rrpos
struct {
   struct penalty_rule *   first
   struct penalty_rule *   last
rules
int servicelevel
unsigned int setinterfacevar:1
unsigned int setqueueentryvar:1
unsigned int setqueuevar:1
const ast_string_field sound_callerannounce
const ast_string_field sound_calls
const ast_string_field sound_holdtime
const ast_string_field sound_minute
const ast_string_field sound_minutes
const ast_string_field sound_next
struct ast_strsound_periodicannounce [MAX_PERIODIC_ANNOUNCEMENTS]
const ast_string_field sound_reporthold
const ast_string_field sound_seconds
const ast_string_field sound_thanks
const ast_string_field sound_thereare
int strategy:4
int talktime
int timeout
int timeoutpriority
unsigned int timeoutrestart:1
int weight
unsigned int wrapped:1
int wrapuptime

Field Documentation

Definition at line 1118 of file app_queue.c.

Queue name

Music on Hold class

Announcement to play when call is answered

Exit context

Macro to run upon member connection

Gosub to run upon member connection

Default rule to use if none specified in call to Queue()

Sound file: "Your call is now first in line" (def. queue-youarenext)

Sound file: "There are currently" (def. queue-thereare)

Sound file: "calls waiting to speak to a representative." (def. queue-callswaiting)

Sound file: "Currently there are more than" (def. queue-quantity1)

Sound file: "callers waiting to speak with a representative" (def. queue-quantity2)

Sound file: "The current estimated total holdtime is" (def. queue-holdtime)

Sound file: "minutes." (def. queue-minutes)

Sound file: "minute." (def. queue-minute)

Sound file: "seconds." (def. queue-seconds)

Sound file: "Thank you for your patience." (def. queue-thankyou)

Sound file: Custom announce for caller, no default

Sound file: "Hold time" (def. queue-reporthold)

Definition at line 1118 of file app_queue.c.

Definition at line 1118 of file app_queue.c.

Referenced by join_queue().

How often to announce their position

Definition at line 1140 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), say_position(), wait_our_turn(), and queue_exec().

unsigned int announceholdtime

Definition at line 1130 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and say_position().

How many positions we announce?

Definition at line 1139 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and say_position().

int autofill

Ignore the head call status and ring an available agent

Definition at line 1168 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), num_available_members(), and is_our_turn().

int autopause

Auto pause queue members if they fail to answer

Definition at line 1162 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and rna().

Number of queue calls abandoned

Definition at line 1149 of file app_queue.c.

Referenced by set_queue_variables(), clear_queue(), record_abandoned(), queue_function_var(), __queues_show(), and manager_queues_status().

Number of queue calls completed

Definition at line 1148 of file app_queue.c.

Referenced by set_queue_variables(), clear_queue(), update_queue(), queue_function_var(), __queues_show(), and manager_queues_status().

Number of calls answered with servicelevel

Definition at line 1151 of file app_queue.c.

Referenced by set_queue_variables(), clear_queue(), update_queue(), queue_function_var(), __queues_show(), and manager_queues_status().

Definition at line 1118 of file app_queue.c.

Referenced by join_queue().

unsigned int dead

Definition at line 1118 of file app_queue.c.

Referenced by copy_rules().

unsigned int eventwhencalled

Definition at line 1179 of file app_queue.c.

int holdtime

Current avg holdtime, based on an exponential average

Definition at line 1146 of file app_queue.c.

Referenced by set_queue_variables(), clear_queue(), say_position(), recalc_holdtime(), queue_function_var(), __queues_show(), manager_queues_summary(), and manager_queues_status().

Definition at line 1137 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and join_queue().

struct penalty_rule* last

Definition at line 1179 of file app_queue.c.

struct { ... } list

Next call queue

unsigned int maskmemberstatus

Definition at line 1133 of file app_queue.c.

Referenced by init_queue(), and queue_set_param().

Number of members _logged in_.

Note:
There will be members in the members container that are not logged in, so this can not simply be replaced with ao2_container_count().

Definition at line 1176 of file app_queue.c.

Referenced by rt_handle_member_record(), free_members(), find_queue_by_name_rt(), update_realtime_members(), calc_metric(), try_calling(), remove_from_queue(), add_to_queue(), queue_exec(), queue_function_qac(), reload_single_member(), kill_dead_members(), and reload_single_queue().

Seconds to delay connecting member to caller

Definition at line 1167 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and try_calling().

Definition at line 1118 of file app_queue.c.

Referenced by try_calling().

Definition at line 1118 of file app_queue.c.

Referenced by try_calling().

The minimum number of seconds between position announcements (def. 15)

Definition at line 1141 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and say_position().

Definition at line 1118 of file app_queue.c.

Referenced by join_queue().

char monfmt[8]

Format to use when recording calls

Definition at line 1152 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and try_calling().

int montype

Monitor type Monitor vs. MixMonitor

Definition at line 1153 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and try_calling().

struct call_queue* next

Definition at line 1178 of file app_queue.c.

The number of periodic announcements configured

Definition at line 1143 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and say_periodic_announcement().

Disregard penalty when queue has fewer than this many members

Definition at line 1157 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and calc_metric().

How often to play periodic announcement

Definition at line 1142 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), say_periodic_announcement(), wait_our_turn(), and queue_exec().

Definition at line 1118 of file app_queue.c.

Referenced by say_position().

Definition at line 1118 of file app_queue.c.

Referenced by say_position().

Are periodic announcments randomly chosen

Definition at line 1144 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and say_periodic_announcement().

Definition at line 1136 of file app_queue.c.

Referenced by queue_set_param(), and say_periodic_announcement().

unsigned int reportholdtime

Definition at line 1127 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and try_calling().

int retry

Retry calling everyone after this amount of time

Definition at line 1159 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and wait_a_bit().

unsigned int ringinuse

Definition at line 1123 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), num_available_members(), and ring_entry().

How many seconds do we round to?

Definition at line 1145 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and say_position().

int rrpos

Round Robin - position

Definition at line 1166 of file app_queue.c.

Referenced by ring_entry(), store_next_rr(), and calc_metric().

struct { ... } rules

The list of penalty rules to invoke

Referenced by init_queue().

seconds setting for servicelevel

Definition at line 1150 of file app_queue.c.

Referenced by set_queue_variables(), init_queue(), queue_set_param(), try_calling(), queue_function_var(), __queues_show(), and manager_queues_status().

unsigned int setinterfacevar

Definition at line 1124 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and try_calling().

unsigned int setqueueentryvar

Definition at line 1126 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and try_calling().

unsigned int setqueuevar

Definition at line 1125 of file app_queue.c.

Referenced by set_queue_variables(), init_queue(), queue_set_param(), and queue_function_var().

Definition at line 1118 of file app_queue.c.

Referenced by try_calling().

Definition at line 1118 of file app_queue.c.

Referenced by say_position().

Definition at line 1118 of file app_queue.c.

Referenced by say_position().

Definition at line 1118 of file app_queue.c.

Referenced by say_position().

Definition at line 1118 of file app_queue.c.

Referenced by say_position(), and try_calling().

Definition at line 1118 of file app_queue.c.

Referenced by say_position().

struct ast_str* sound_periodicannounce[MAX_PERIODIC_ANNOUNCEMENTS]

Sound files: Custom announce, no default

Definition at line 1120 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), destroy_queue(), and say_periodic_announcement().

Definition at line 1118 of file app_queue.c.

Referenced by try_calling().

Definition at line 1118 of file app_queue.c.

Referenced by say_position(), and try_calling().

Definition at line 1118 of file app_queue.c.

Referenced by say_position().

Definition at line 1118 of file app_queue.c.

Referenced by say_position().

int talktime

Current avg talktime, based on the same exponential average

Definition at line 1147 of file app_queue.c.

Referenced by set_queue_variables(), clear_queue(), update_queue(), queue_function_var(), __queues_show(), manager_queues_summary(), and manager_queues_status().

int timeout

How long to wait for an answer

Definition at line 1160 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and try_calling().

Do we allow a fraction of the timeout to occur for a ring?

Definition at line 1163 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and try_calling().

unsigned int timeoutrestart

Definition at line 1129 of file app_queue.c.

Referenced by init_queue(), queue_set_param(), and wait_for_answer().

unsigned int wrapped

Definition at line 1128 of file app_queue.c.

Referenced by store_next_rr(), and calc_metric().

Wrapup Time

Definition at line 1156 of file app_queue.c.

Referenced by get_member_status(), init_queue(), queue_set_param(), ring_entry(), and queue_function_qac().


The documentation for this struct was generated from the following file: