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_ent *	head
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_container *	members
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 {
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_str *	sound_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 710 of file app_queue.c.

---

Field Documentation

struct ast_string_field_mgr __field_mgr

Definition at line 750 of file app_queue.c.

struct ast_string_field_pool* __field_mgr_pool

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

const ast_string_field announce

Definition at line 750 of file app_queue.c.

Referenced by join_queue().

int announcefrequency

How often to announce their position

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

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

unsigned int announceposition

Definition at line 763 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 770 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 798 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 792 of file app_queue.c.

Referenced by queue_set_param(), and rna().

int callsabandoned

Number of queue calls abandoned

Definition at line 780 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 779 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 782 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 750 of file app_queue.c.

Referenced by join_queue().

int count

How many entries

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

Referenced by find_queue_by_name_rt(), init_queue(), kill_dead_queues(), leave_queue(), and mark_dead_and_unfound().

const ast_string_field defaultrule

Definition at line 750 of file app_queue.c.

Referenced by copy_rules().

unsigned int eventwhencalled

Definition at line 754 of file app_queue.c.

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

struct penalty_rule* first

Definition at line 809 of file app_queue.c.

unsigned int found

Definition at line 767 of file app_queue.c.

Referenced by handle_statechange(), init_queue(), mark_dead_and_unfound(), and reload_single_queue().

struct queue_ent* head

Head of the list of callers

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

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

struct penalty_rule* last

Definition at line 809 of file app_queue.c.

enum empty_conditions leavewhenempty

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

Referenced by init_queue(), and queue_set_param().

int maxlen

Max number of entries

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

Referenced by add_to_queue(), find_queue_by_name_rt(), free_members(), kill_dead_members(), queue_exec(), queue_function_qac(), reload_single_member(), reload_single_queue(), 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 797 of file app_queue.c.

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

const ast_string_field membergosub

Definition at line 750 of file app_queue.c.

Referenced by try_calling().

const ast_string_field membermacro

Definition at line 750 of file app_queue.c.

Referenced by try_calling().

struct ao2_container* members

Head of the list of members

Definition at line 800 of file app_queue.c.

Referenced by __queues_show(), add_to_queue(), clear_queue(), compare_weight(), complete_queue_remove_member(), destroy_queue(), dump_queue_members(), find_queue_by_name_rt(), free_members(), get_member_status(), handle_statechange(), init_queue(), interface_exists(), manager_queues_status(), manager_queues_summary(), num_available_members(), queue_function_qac(), queue_function_qac_dep(), queue_function_queuememberlist(), reload_single_member(), reload_single_queue(), remove_from_queue(), rt_handle_member_record(), try_calling(), update_queue(), and update_realtime_members().

int minannouncefrequency

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

Definition at line 772 of file app_queue.c.

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

const ast_string_field moh

Definition at line 750 of file app_queue.c.

Referenced by join_queue().

char monfmt[8]

Format to use when recording calls

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

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

const ast_string_field name

Definition at line 750 of file app_queue.c.

Referenced by __queues_show(), add_to_queue(), clear_stats(), compare_weight(), complete_queue(), dump_queue_members(), find_queue_by_name_rt(), join_queue(), kill_dead_queues(), leave_queue(), load_realtime_queue(), manager_queues_status(), manager_queues_summary(), mark_dead_and_unfound(), queue_cmp_cb(), queue_exec(), queue_hash_cb(), queue_set_param(), queue_transfer_fixup(), record_abandoned(), reload_queue_members(), reload_single_queue(), 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(), wait_for_answer(), and wait_our_turn().

struct call_queue* next

Definition at line 808 of file app_queue.c.

int numperiodicannounce

The number of periodic announcements configured

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

Referenced by say_position().

const ast_string_field queue_quantity2

Definition at line 750 of file app_queue.c.

Referenced by say_position().

int randomperiodicannounce

Are periodic announcments randomly chosen

Definition at line 775 of file app_queue.c.

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

unsigned int realtime

Definition at line 766 of file app_queue.c.

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

unsigned int reportholdtime

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

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

unsigned int ringinuse

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

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

int rrpos

Round Robin - position

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

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

unsigned int setqueueentryvar

Definition at line 758 of file app_queue.c.

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

unsigned int setqueuevar

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

Referenced by try_calling().

const ast_string_field sound_calls

Definition at line 750 of file app_queue.c.

Referenced by say_position().

const ast_string_field sound_holdtime

Definition at line 750 of file app_queue.c.

Referenced by say_position().

const ast_string_field sound_minute

Definition at line 750 of file app_queue.c.

Referenced by say_position().

const ast_string_field sound_minutes

Definition at line 750 of file app_queue.c.

Referenced by say_position(), and try_calling().

const ast_string_field sound_next

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

Referenced by try_calling().

const ast_string_field sound_seconds

Definition at line 750 of file app_queue.c.

Referenced by say_position(), and try_calling().

const ast_string_field sound_thanks

Definition at line 750 of file app_queue.c.

Referenced by say_position().

const ast_string_field sound_thereare

Definition at line 750 of file app_queue.c.

Referenced by say_position().

int strategy

Definition at line 764 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(), reload_single_queue(), ring_one(), set_queue_variables(), try_calling(), and wait_for_answer().

int talktime

Current avg talktime, based on the same exponential average

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

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

unsigned int timeoutrestart

Definition at line 761 of file app_queue.c.

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

int weight

Respective weight

Definition at line 791 of file app_queue.c.

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

unsigned int wrapped

Definition at line 760 of file app_queue.c.

Referenced by calc_metric(), and store_next_rr().

int wrapuptime

Wrapup Time

Definition at line 787 of file app_queue.c.

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

---

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

• app_queue.c