Thu Apr 16 06:49:04 2015

Asterisk developer's documentation


call_queue Struct Reference

Collaboration diagram for call_queue:

Collaboration graph
[legend]

Data Fields

struct ast_string_field_mgr __field_mgr
struct ast_string_field_pool__field_mgr_pool
const ast_string_field announce
unsigned int announce_to_first_user:1
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 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

Detailed Description

Definition at line 1133 of file app_queue.c.


Field Documentation

Definition at line 1173 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 1173 of file app_queue.c.

Definition at line 1173 of file app_queue.c.

Referenced by join_queue().

unsigned int announce_to_first_user

Whether or not we announce to the first user in a queue

Definition at line 1179 of file app_queue.c.

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

How often to announce their position

Definition at line 1196 of file app_queue.c.

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

unsigned int announceholdtime

Definition at line 1186 of file app_queue.c.

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

unsigned int announceposition

How many positions we announce?

Definition at line 1195 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 1224 of file app_queue.c.

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

int autopause

Auto pause queue members if they fail to answer

Definition at line 1218 of file app_queue.c.

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

Number of queue calls abandoned

Definition at line 1205 of file app_queue.c.

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

Number of queue calls completed

Definition at line 1204 of file app_queue.c.

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

Number of calls answered with servicelevel

Definition at line 1207 of file app_queue.c.

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

Definition at line 1173 of file app_queue.c.

Referenced by join_queue().

int count

unsigned int dead

Definition at line 1173 of file app_queue.c.

Referenced by copy_rules().

unsigned int eventwhencalled

struct penalty_rule* first [read]

Definition at line 1229 of file app_queue.c.

unsigned int found

struct queue_ent* head [read]

int holdtime

Current avg holdtime, based on an exponential average

Definition at line 1202 of file app_queue.c.

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

Definition at line 1193 of file app_queue.c.

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

struct penalty_rule* last [read]

Definition at line 1229 of file app_queue.c.

Definition at line 1194 of file app_queue.c.

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

struct { ... } list

Next call queue

unsigned int maskmemberstatus

Definition at line 1189 of file app_queue.c.

Referenced by init_queue(), and queue_set_param().

int maxlen

Seconds to delay connecting member to caller

Definition at line 1223 of file app_queue.c.

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

Definition at line 1173 of file app_queue.c.

Referenced by try_calling().

Definition at line 1173 of file app_queue.c.

Referenced by try_calling().

struct ao2_container* members [read]

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

Definition at line 1197 of file app_queue.c.

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

Definition at line 1173 of file app_queue.c.

Referenced by join_queue().

char monfmt[8]

Format to use when recording calls

Definition at line 1208 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 1209 of file app_queue.c.

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

struct call_queue* next [read]

Definition at line 1228 of file app_queue.c.

The number of periodic announcements configured

Definition at line 1199 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 1213 of file app_queue.c.

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

How often to play periodic announcement

Definition at line 1198 of file app_queue.c.

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

Definition at line 1173 of file app_queue.c.

Referenced by say_position().

Definition at line 1173 of file app_queue.c.

Referenced by say_position().

Are periodic announcments randomly chosen

Definition at line 1200 of file app_queue.c.

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

unsigned int realtime

Definition at line 1192 of file app_queue.c.

Referenced by queue_set_param(), and say_periodic_announcement().

unsigned int reportholdtime

Definition at line 1183 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 1215 of file app_queue.c.

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

unsigned int ringinuse

How many seconds do we round to?

Definition at line 1201 of file app_queue.c.

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

int rrpos

struct { ... } rules

The list of penalty rules to invoke

Referenced by init_queue().

seconds setting for servicelevel

Definition at line 1206 of file app_queue.c.

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

unsigned int setinterfacevar

Definition at line 1180 of file app_queue.c.

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

unsigned int setqueueentryvar

Definition at line 1182 of file app_queue.c.

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

unsigned int setqueuevar

Definition at line 1181 of file app_queue.c.

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

Definition at line 1173 of file app_queue.c.

Referenced by try_calling().

Definition at line 1173 of file app_queue.c.

Referenced by say_position().

Definition at line 1173 of file app_queue.c.

Referenced by say_position().

Definition at line 1173 of file app_queue.c.

Referenced by say_position().

Definition at line 1173 of file app_queue.c.

Referenced by say_position(), and try_calling().

Definition at line 1173 of file app_queue.c.

Referenced by say_position().

struct ast_str* sound_periodicannounce[MAX_PERIODIC_ANNOUNCEMENTS] [read]

Sound files: Custom announce, no default

Definition at line 1175 of file app_queue.c.

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

Definition at line 1173 of file app_queue.c.

Referenced by try_calling().

Definition at line 1173 of file app_queue.c.

Referenced by say_position(), and try_calling().

Definition at line 1173 of file app_queue.c.

Referenced by say_position().

Definition at line 1173 of file app_queue.c.

Referenced by say_position().

int strategy

int talktime

Current avg talktime, based on the same exponential average

Definition at line 1203 of file app_queue.c.

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

int timeout

How long to wait for an answer

Definition at line 1216 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 1219 of file app_queue.c.

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

unsigned int timeoutrestart

Definition at line 1185 of file app_queue.c.

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

int weight

unsigned int wrapped

Definition at line 1184 of file app_queue.c.

Referenced by calc_metric(), and store_next_rr().

Wrapup Time

Definition at line 1212 of file app_queue.c.

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


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

Generated on Thu Apr 16 06:49:05 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6