Wed Jan 8 2020 09:50:24

Asterisk developer's documentation


call_queue Struct Reference

Data Fields

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 ringlimit
 
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 1226 of file app_queue.c.

Field Documentation

struct ast_string_field_pool* __field_mgr_pool

Definition at line 1266 of file app_queue.c.

const ast_string_field announce

Announcement to play when call is answered

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

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

int announcefrequency

How often to announce their position

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

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

unsigned int announceposition
int announcepositionlimit

How many positions we announce?

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

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

int callsabandoned

Number of queue calls abandoned

Definition at line 1298 of file app_queue.c.

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

int callscompleted

Number of queue calls completed

Definition at line 1297 of file app_queue.c.

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

int callscompletedinsl

Number of calls answered with servicelevel

Definition at line 1300 of file app_queue.c.

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

const ast_string_field context

Exit context

Definition at line 1266 of file app_queue.c.

Referenced by join_queue().

unsigned int dead
const ast_string_field defaultrule

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

Definition at line 1266 of file app_queue.c.

Referenced by copy_rules().

unsigned int eventwhencalled
struct penalty_rule* first

Definition at line 1323 of file app_queue.c.

int holdtime

Current avg holdtime, based on an exponential average

Definition at line 1295 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().

enum empty_conditions joinempty

Definition at line 1286 of file app_queue.c.

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

struct penalty_rule* last

Definition at line 1323 of file app_queue.c.

enum empty_conditions leavewhenempty

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

Referenced by init_queue(), and queue_set_param().

int maxlen
int memberdelay

Seconds to delay connecting member to caller

Definition at line 1317 of file app_queue.c.

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

const ast_string_field membergosub

Gosub to run upon member connection

Definition at line 1266 of file app_queue.c.

Referenced by try_calling().

const ast_string_field membermacro

Macro to run upon member connection

Definition at line 1266 of file app_queue.c.

Referenced by try_calling().

int minannouncefrequency

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

Definition at line 1290 of file app_queue.c.

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

const ast_string_field moh

Music on Hold class

Definition at line 1266 of file app_queue.c.

Referenced by join_queue().

char monfmt[8]

Format to use when recording calls

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

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

struct call_queue* next

Definition at line 1322 of file app_queue.c.

int numperiodicannounce

The number of periodic announcements configured

Definition at line 1292 of file app_queue.c.

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

int penaltymemberslimit

Disregard penalty when queue has fewer than this many members

Definition at line 1306 of file app_queue.c.

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

int periodicannouncefrequency

How often to play periodic announcement

Definition at line 1291 of file app_queue.c.

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

const ast_string_field queue_quantity1

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

Definition at line 1266 of file app_queue.c.

Referenced by say_position().

const ast_string_field queue_quantity2

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

Definition at line 1266 of file app_queue.c.

Referenced by say_position().

int randomperiodicannounce

Are periodic announcments randomly chosen

Definition at line 1293 of file app_queue.c.

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

unsigned int relativeperiodicannounce

Definition at line 1285 of file app_queue.c.

Referenced by queue_set_param(), and say_periodic_announcement().

unsigned int reportholdtime

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

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

unsigned int ringinuse
int ringlimit

Max number of rings per entry in queue

Definition at line 1307 of file app_queue.c.

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

int roundingseconds

How many seconds do we round to?

Definition at line 1294 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().

int servicelevel

seconds setting for servicelevel

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

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

unsigned int setqueueentryvar

Definition at line 1275 of file app_queue.c.

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

unsigned int setqueuevar

Definition at line 1274 of file app_queue.c.

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

const ast_string_field sound_callerannounce

Sound file: Custom announce for caller struct ast_string_field_mgr __field_mgr no default

Definition at line 1266 of file app_queue.c.

Referenced by try_calling().

const ast_string_field sound_calls

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

Definition at line 1266 of file app_queue.c.

Referenced by say_position().

const ast_string_field sound_holdtime

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

Definition at line 1266 of file app_queue.c.

Referenced by say_position().

const ast_string_field sound_minute

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

Definition at line 1266 of file app_queue.c.

Referenced by say_position().

const ast_string_field sound_minutes

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

Definition at line 1266 of file app_queue.c.

Referenced by say_position(), and try_calling().

const ast_string_field sound_next

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

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

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

const ast_string_field sound_reporthold

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

Definition at line 1266 of file app_queue.c.

Referenced by try_calling().

const ast_string_field sound_seconds

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

Definition at line 1266 of file app_queue.c.

Referenced by say_position(), and try_calling().

const ast_string_field sound_thanks

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

Definition at line 1266 of file app_queue.c.

Referenced by say_position().

const ast_string_field sound_thereare

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

Definition at line 1266 of file app_queue.c.

Referenced by say_position().

int talktime

Current avg talktime, based on the same exponential average

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

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

int timeoutpriority

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

Definition at line 1313 of file app_queue.c.

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

unsigned int timeoutrestart

Definition at line 1278 of file app_queue.c.

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

unsigned int wrapped

Definition at line 1277 of file app_queue.c.

Referenced by calc_metric(), and store_next_rr().

int wrapuptime

Wrapup Time

Definition at line 1305 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: