Wed Aug 18 22:34:37 2010

Asterisk developer's documentation


call_queue Struct Reference


Data Fields

ast_string_field_mgr __field_mgr
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
queue_enthead
int holdtime
unsigned int joinempty:2
unsigned int leavewhenempty:2
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
ao2_containermembers
int minannouncefrequency
const ast_string_field moh
char monfmt [8]
int montype
const ast_string_field name
int numperiodicannounce
int periodicannouncefrequency
const ast_string_field queue_quantity1
const ast_string_field queue_quantity2
int randomperiodicannounce
unsigned int realtime:1
unsigned int reportholdtime:1
int retry
unsigned int ringinuse:1
int roundingseconds
int rrpos
struct {
   penalty_rule *   first
   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
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 timeout
int timeoutpriority
unsigned int timeoutrestart:1
int weight
unsigned int wrapped:1
int wrapuptime

Detailed Description

Definition at line 438 of file app_queue.c.


Field Documentation

struct ast_string_field_mgr __field_mgr

Definition at line 478 of file app_queue.c.

struct ast_string_field_pool* __field_mgr_pool

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

Definition at line 478 of file app_queue.c.

const ast_string_field announce

Definition at line 478 of file app_queue.c.

int announcefrequency

How often to announce their position

Definition at line 499 of file app_queue.c.

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

unsigned int announceholdtime

Definition at line 492 of file app_queue.c.

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

unsigned int announceposition

Definition at line 493 of file app_queue.c.

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

int announcepositionlimit

How many positions we announce?

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

Referenced by queue_set_param(), and rna().

int callsabandoned

Number of queue calls abandoned

Definition at line 507 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 506 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 509 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

Definition at line 478 of file app_queue.c.

int count

How many entries

Definition at line 512 of file app_queue.c.

Referenced by __queues_show(), compare_weight(), join_queue(), leave_queue(), manager_queues_status(), queue_function_qac(), queue_function_qac_dep(), queue_function_queuewaitingcount(), queue_function_var(), and set_queue_variables().

unsigned int dead

Definition at line 481 of file app_queue.c.

Referenced by find_queue_by_name_rt(), init_queue(), leave_queue(), and reload_queues().

const ast_string_field defaultrule

Definition at line 478 of file app_queue.c.

Referenced by join_queue().

unsigned int eventwhencalled

Definition at line 483 of file app_queue.c.

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

struct penalty_rule* first

Definition at line 536 of file app_queue.c.

unsigned int found

Definition at line 497 of file app_queue.c.

Referenced by init_queue(), and reload_queues().

struct queue_ent* head

Head of the list of callers

Definition at line 534 of file app_queue.c.

Referenced by __queues_show(), insert_entry(), is_our_turn(), join_queue(), leave_queue(), manager_queues_status(), and manager_queues_summary().

int holdtime

Current avg holdtime, based on an exponential average

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

unsigned int joinempty

Definition at line 482 of file app_queue.c.

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

struct penalty_rule* last

Definition at line 536 of file app_queue.c.

unsigned int leavewhenempty

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

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

int maxlen

Max number of entries

Definition at line 513 of file app_queue.c.

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

int membercount

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

Referenced by add_to_queue(), free_members(), init_queue(), queue_exec(), reload_queues(), remove_from_queue(), rt_handle_member_record(), try_calling(), and update_realtime_members().

int memberdelay

Seconds to delay connecting member to caller

Definition at line 524 of file app_queue.c.

Referenced by init_queue(), and queue_set_param().

const ast_string_field membergosub

Definition at line 478 of file app_queue.c.

const ast_string_field membermacro

Definition at line 478 of file app_queue.c.

struct ao2_container* members

Head of the list of members

Definition at line 527 of file app_queue.c.

Referenced by __queues_show(), add_to_queue(), compare_weight(), complete_queue_remove_member(), destroy_queue(), dump_queue_members(), free_members(), get_member_status(), init_queue(), interface_exists(), interface_exists_global(), manager_queues_status(), manager_queues_summary(), num_available_members(), queue_function_queuememberlist(), reload_queues(), remove_from_queue(), rt_handle_member_record(), try_calling(), update_queue(), update_realtime_members(), and update_status().

int minannouncefrequency

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

Definition at line 500 of file app_queue.c.

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

const ast_string_field moh

Definition at line 478 of file app_queue.c.

char monfmt[8]

Format to use when recording calls

Definition at line 510 of file app_queue.c.

Referenced by init_queue(), and queue_set_param().

int montype

Monitor type Monitor vs. MixMonitor

Definition at line 511 of file app_queue.c.

Referenced by init_queue(), and queue_set_param().

const ast_string_field name

Definition at line 478 of file app_queue.c.

Referenced by __queues_show(), add_to_queue(), compare_weight(), complete_queue(), dump_queue_members(), find_queue_by_name_rt(), leave_queue(), load_realtime_queue(), manager_queues_status(), manager_queues_summary(), queue_cmp_cb(), queue_exec(), queue_hash_cb(), queue_set_param(), queue_transfer_fixup(), record_abandoned(), reload_queue_members(), reload_queues(), remove_from_queue(), ring_entry(), rna(), rt_handle_member_record(), say_position(), set_member_paused(), set_member_penalty(), set_queue_variables(), try_calling(), update_realtime_members(), update_status(), wait_for_answer(), and wait_our_turn().

struct call_queue* next

Definition at line 535 of file app_queue.c.

int numperiodicannounce

The number of periodic announcements configured

Definition at line 502 of file app_queue.c.

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

int periodicannouncefrequency

How often to play periodic announcement

Definition at line 501 of file app_queue.c.

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

const ast_string_field queue_quantity1

Definition at line 478 of file app_queue.c.

Referenced by say_position().

const ast_string_field queue_quantity2

Definition at line 478 of file app_queue.c.

Referenced by say_position().

int randomperiodicannounce

Are periodic announcments randomly chosen

Definition at line 503 of file app_queue.c.

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

unsigned int realtime

Definition at line 496 of file app_queue.c.

Referenced by __queues_show(), find_queue_by_name_rt(), leave_queue(), load_realtime_queue(), and reload_queues().

unsigned int reportholdtime

Definition at line 489 of file app_queue.c.

Referenced by init_queue(), and queue_set_param().

int retry

Retry calling everyone after this amount of time

Definition at line 516 of file app_queue.c.

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

unsigned int ringinuse

Definition at line 485 of file app_queue.c.

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

int roundingseconds

How many seconds do we round to?

Definition at line 504 of file app_queue.c.

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

int rrpos

Round Robin - position

Definition at line 523 of file app_queue.c.

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

struct { ... } rules

The list of penalty rules to invoke

Referenced by init_queue().

int servicelevel

seconds setting for servicelevel

Definition at line 508 of file app_queue.c.

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

unsigned int setinterfacevar

Definition at line 486 of file app_queue.c.

Referenced by init_queue(), and queue_set_param().

unsigned int setqueueentryvar

Definition at line 488 of file app_queue.c.

Referenced by init_queue(), and queue_set_param().

unsigned int setqueuevar

Definition at line 487 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

Definition at line 478 of file app_queue.c.

const ast_string_field sound_calls

Definition at line 478 of file app_queue.c.

Referenced by say_position().

const ast_string_field sound_holdtime

Definition at line 478 of file app_queue.c.

Referenced by say_position().

const ast_string_field sound_minute

Definition at line 478 of file app_queue.c.

Referenced by say_position().

const ast_string_field sound_minutes

Definition at line 478 of file app_queue.c.

Referenced by say_position().

const ast_string_field sound_next

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

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

const ast_string_field sound_reporthold

Definition at line 478 of file app_queue.c.

const ast_string_field sound_seconds

Definition at line 478 of file app_queue.c.

Referenced by say_position().

const ast_string_field sound_thanks

Definition at line 478 of file app_queue.c.

Referenced by say_position().

const ast_string_field sound_thereare

Definition at line 478 of file app_queue.c.

Referenced by say_position().

int strategy

Definition at line 494 of file app_queue.c.

Referenced by __queues_show(), calc_metric(), find_queue_by_name_rt(), init_queue(), manager_queues_status(), num_available_members(), queue_function_var(), queue_set_param(), ring_one(), set_queue_variables(), try_calling(), and wait_for_answer().

int timeout

How long to wait for an answer

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

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

unsigned int timeoutrestart

Definition at line 491 of file app_queue.c.

Referenced by init_queue(), and queue_set_param().

int weight

Respective weight

Definition at line 518 of file app_queue.c.

Referenced by __queues_show(), compare_weight(), init_queue(), manager_queues_status(), and queue_set_param().

unsigned int wrapped

Definition at line 490 of file app_queue.c.

Referenced by calc_metric(), and store_next_rr().

int wrapuptime

Wrapup Time

Definition at line 514 of file app_queue.c.

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


The documentation for this struct was generated from the following file:
Generated on Wed Aug 18 22:34:37 2010 for Asterisk - the Open Source PBX by  doxygen 1.4.7