Thu Oct 11 06:50:34 2012

Asterisk developer's documentation


call_queue Struct Reference

Collaboration diagram for call_queue:

Collaboration graph
[legend]

Data Fields

char announce [80]
int announcefrequency
unsigned int announceholdtime:2
unsigned int announceposition:3
int announcepositionlimit
int autofill
int autopause
int callsabandoned
int callscompleted
int callscompletedinsl
char context [AST_MAX_CONTEXT]
int count
unsigned int dead:1
char defaultrule [AST_MAX_CONTEXT]
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 membercount
 Number of members _logged in_.
int memberdelay
char membergosub [AST_MAX_CONTEXT]
char membermacro [AST_MAX_CONTEXT]
struct ao2_containermembers
int minannouncefrequency
char moh [80]
char monfmt [8]
int montype
char name [80]
int numperiodicannounce
int periodicannouncefrequency
char queue_quantity1 [80]
char queue_quantity2 [80]
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
char sound_callerannounce [80]
char sound_calls [80]
char sound_holdtime [80]
char sound_minute [80]
char sound_minutes [80]
char sound_next [80]
struct ast_strsound_periodicannounce [MAX_PERIODIC_ANNOUNCEMENTS]
char sound_reporthold [80]
char sound_seconds [80]
char sound_thanks [80]
char sound_thereare [80]
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 712 of file app_queue.c.


Field Documentation

char announce[80]

Announcement to play when call is answered

Definition at line 718 of file app_queue.c.

Referenced by join_queue(), and queue_set_param().

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().

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().

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().

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().

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().

char context[AST_MAX_CONTEXT]

Exit context

Definition at line 720 of file app_queue.c.

Referenced by join_queue(), and queue_set_param().

int count

unsigned int dead

char defaultrule[AST_MAX_CONTEXT]

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

Definition at line 726 of file app_queue.c.

Referenced by copy_rules(), and queue_set_param().

unsigned int eventwhencalled

struct penalty_rule* first [read]

Definition at line 809 of file app_queue.c.

unsigned int found

struct queue_ent* head [read]

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().

Definition at line 768 of file app_queue.c.

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

struct penalty_rule* last [read]

Definition at line 809 of file app_queue.c.

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

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().

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().

char membergosub[AST_MAX_CONTEXT]

Gosub to run upon member connection

Definition at line 724 of file app_queue.c.

Referenced by queue_set_param(), and try_calling().

char membermacro[AST_MAX_CONTEXT]

Macro to run upon member connection

Definition at line 722 of file app_queue.c.

Referenced by queue_set_param(), and try_calling().

struct ao2_container* members [read]

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().

char moh[80]

Music on Hold class

Definition at line 716 of file app_queue.c.

Referenced by join_queue(), and queue_set_param().

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().

char name[80]

struct call_queue* next [read]

Definition at line 808 of file app_queue.c.

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().

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().

char queue_quantity1[80]

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

Definition at line 748 of file app_queue.c.

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

char queue_quantity2[80]

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

Definition at line 750 of file app_queue.c.

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

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

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().

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().

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().

Sound file: Custom announce for caller, no default

Definition at line 744 of file app_queue.c.

Referenced by queue_set_param(), and try_calling().

char sound_calls[80]

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

Definition at line 732 of file app_queue.c.

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

char sound_holdtime[80]

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

Definition at line 734 of file app_queue.c.

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

char sound_minute[80]

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

Definition at line 738 of file app_queue.c.

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

char sound_minutes[80]

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

Definition at line 736 of file app_queue.c.

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

char sound_next[80]

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

Definition at line 728 of file app_queue.c.

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

struct ast_str* sound_periodicannounce[MAX_PERIODIC_ANNOUNCEMENTS] [read]

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().

char sound_reporthold[80]

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

Definition at line 746 of file app_queue.c.

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

char sound_seconds[80]

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

Definition at line 740 of file app_queue.c.

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

char sound_thanks[80]

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

Definition at line 742 of file app_queue.c.

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

char sound_thereare[80]

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

Definition at line 730 of file app_queue.c.

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

int strategy

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().

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

unsigned int wrapped

Definition at line 760 of file app_queue.c.

Referenced by calc_metric(), and store_next_rr().

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:

Generated on Thu Oct 11 06:50:35 2012 for Asterisk - the Open Source PBX by  doxygen 1.5.6