Wed Jan 27 20:02:53 2016

Asterisk developer's documentation


call_queue Struct Reference

Public Member Functions

 AST_DECLARE_STRING_FIELDS (AST_STRING_FIELD(name);AST_STRING_FIELD(moh);AST_STRING_FIELD(announce);AST_STRING_FIELD(context);AST_STRING_FIELD(membermacro);AST_STRING_FIELD(membergosub);AST_STRING_FIELD(defaultrule);AST_STRING_FIELD(sound_next);AST_STRING_FIELD(sound_thereare);AST_STRING_FIELD(sound_calls);AST_STRING_FIELD(queue_quantity1);AST_STRING_FIELD(queue_quantity2);AST_STRING_FIELD(sound_holdtime);AST_STRING_FIELD(sound_minutes);AST_STRING_FIELD(sound_minute);AST_STRING_FIELD(sound_seconds);AST_STRING_FIELD(sound_thanks);AST_STRING_FIELD(sound_callerannounce);AST_STRING_FIELD(sound_reporthold);)

Data Fields

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
int count
unsigned int dead:1
unsigned int eventwhencalled:2
unsigned int found:1
struct queue_enthead
int holdtime
enum empty_conditions joinempty
enum empty_conditions leavewhenempty
unsigned int maskmemberstatus:1
int maxlen
int memberdelay
struct ao2_containermembers
int minannouncefrequency
char monfmt [8]
int montype
int numperiodicannounce
int penaltymemberslimit
int periodicannouncefrequency
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
int servicelevel
unsigned int setinterfacevar:1
unsigned int setqueueentryvar:1
unsigned int setqueuevar:1
struct ast_strsound_periodicannounce [MAX_PERIODIC_ANNOUNCEMENTS]
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 1225 of file app_queue.c.


Member Function Documentation

AST_DECLARE_STRING_FIELDS ( AST_STRING_FIELD(name);AST_STRING_FIELD(moh);AST_STRING_FIELD(announce);AST_STRING_FIELD(context);AST_STRING_FIELD(membermacro);AST_STRING_FIELD(membergosub);AST_STRING_FIELD(defaultrule);AST_STRING_FIELD(sound_next);AST_STRING_FIELD(sound_thereare);AST_STRING_FIELD(sound_calls);AST_STRING_FIELD(queue_quantity1);AST_STRING_FIELD(queue_quantity2);AST_STRING_FIELD(sound_holdtime);AST_STRING_FIELD(sound_minutes);AST_STRING_FIELD(sound_minute);AST_STRING_FIELD(sound_seconds);AST_STRING_FIELD(sound_thanks);AST_STRING_FIELD(sound_callerannounce);AST_STRING_FIELD(sound_reporthold);   ) 

Field Documentation

unsigned int announce_to_first_user

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

Definition at line 1271 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 1288 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 1278 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 1287 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 1317 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 1311 of file app_queue.c.

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

Number of queue calls abandoned

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

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

int count
unsigned int dead
unsigned int eventwhencalled
unsigned int found
struct queue_ent* head [read]
int holdtime

Current avg holdtime, based on an exponential average

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

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

Definition at line 1286 of file app_queue.c.

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

unsigned int maskmemberstatus

Definition at line 1281 of file app_queue.c.

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

int maxlen

Seconds to delay connecting member to caller

Definition at line 1316 of file app_queue.c.

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

struct ao2_container* members [read]

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

Definition at line 1289 of file app_queue.c.

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

char monfmt[8]

Format to use when recording calls

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

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

The number of periodic announcements configured

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

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

How often to play periodic announcement

Definition at line 1290 of file app_queue.c.

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

Are periodic announcments randomly chosen

Definition at line 1292 of file app_queue.c.

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

unsigned int realtime

Definition at line 1284 of file app_queue.c.

Referenced by queue_set_param(), and say_periodic_announcement().

unsigned int reportholdtime

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

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

How many seconds do we round to?

Definition at line 1293 of file app_queue.c.

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

int rrpos

seconds setting for servicelevel

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

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

unsigned int setqueueentryvar

Definition at line 1274 of file app_queue.c.

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

unsigned int setqueuevar

Definition at line 1273 of file app_queue.c.

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

struct ast_str* sound_periodicannounce[MAX_PERIODIC_ANNOUNCEMENTS] [read]

Sound files: Custom announce, no default

Definition at line 1267 of file app_queue.c.

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

int strategy
int talktime

Current avg talktime, based on the same 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(), set_queue_variables(), and update_queue().

int timeout

How long to wait for an answer

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

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

unsigned int timeoutrestart

Definition at line 1277 of file app_queue.c.

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

int weight
unsigned int wrapped

Definition at line 1276 of file app_queue.c.

Referenced by calc_metric(), and store_next_rr().

Wrapup Time

Definition at line 1304 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 27 Jan 2016 for Asterisk - The Open Source Telephony Project by  doxygen 1.6.1