Sat Aug 6 00:40:07 2011

Asterisk developer's documentation


agent_pvt Struct Reference

Structure representing an agent. More...


Data Fields

int abouttograb
int ackcall
int acknowledged
char agent [AST_MAX_AGENT]
ast_cond_t app_complete_cond
int app_lock_flag
volatile int app_sleep_cond
int autologoff
ast_channelchan
int dead
int deferlogoff
ast_group_t group
int inherited_devicestate
timeval lastdisc
struct {
   agent_pvt *   next
list
ast_mutex_t lock
ast_cond_t login_wait_cond
char logincallerid [80]
char loginchan [80]
time_t loginstart
char moh [80]
char name [AST_MAX_AGENT]
ast_channelowner
char password [AST_MAX_AGENT]
int pending
time_t start
int wrapuptime


Detailed Description

Structure representing an agent.

Definition at line 178 of file chan_agent.c.


Field Documentation

int abouttograb

About to grab

Definition at line 182 of file chan_agent.c.

Referenced by agent_hangup(), check_availability(), and check_beep().

int ackcall

ackcall

Definition at line 184 of file chan_agent.c.

Referenced by __login_exec(), action_agent_callback_login(), add_agent(), agent_call(), agent_read(), and check_availability().

int acknowledged

Acknowledged

Definition at line 191 of file chan_agent.c.

Referenced by __login_exec(), action_agents(), agent_call(), agent_hangup(), agent_read(), agents_show(), agents_show_online(), and check_availability().

char agent[AST_MAX_AGENT]

Agent ID

Definition at line 193 of file chan_agent.c.

Referenced by __agent_start_monitoring(), __login_exec(), action_agent_callback_login(), action_agent_logoff(), action_agents(), add_agent(), agent_call(), agent_devicestate(), agent_devicestate_cb(), agent_hangup(), agent_logoff(), agent_logoff_cmd(), agent_logoff_maintenance(), agent_new(), agent_read(), agent_request(), agentmonitoroutgoing_exec(), agents_show(), agents_show_online(), check_availability(), check_beep(), complete_agent_logoff_cmd(), dump_agents(), find_agent(), function_agent(), and reload_agents().

ast_cond_t app_complete_cond

Definition at line 198 of file chan_agent.c.

Referenced by __login_exec(), agent_cleanup(), agent_hangup(), agent_request(), and read_agent_config().

int app_lock_flag

Definition at line 197 of file chan_agent.c.

Referenced by __login_exec(), agent_cleanup(), agent_hangup(), and agent_request().

volatile int app_sleep_cond

Sleep condition for the login app

Definition at line 200 of file chan_agent.c.

Referenced by agent_ack_sleep(), agent_cleanup(), agent_cont_sleep(), agent_hangup(), and agent_request().

int autologoff

Auto timeout time

Definition at line 183 of file chan_agent.c.

Referenced by __login_exec(), add_agent(), agent_hangup(), and agent_read().

struct ast_channel* chan

Channel we use

Definition at line 207 of file chan_agent.c.

Referenced by __login_exec(), action_agent_callback_login(), action_agents(), agent_ack_sleep(), agent_bridgedchannel(), agent_call(), agent_cleanup(), agent_devicestate(), agent_devicestate_cb(), agent_digit_begin(), agent_digit_end(), agent_get_base_channel(), agent_hangup(), agent_indicate(), agent_logoff(), agent_new(), agent_read(), agent_request(), agent_sendhtml(), agent_sendtext(), agent_set_base_channel(), agent_write(), agentmonitoroutgoing_exec(), agents_show(), agents_show_online(), check_availability(), check_beep(), dump_agents(), and read_agent_config().

int dead

Poised for destruction?

Definition at line 180 of file chan_agent.c.

Referenced by __login_exec(), add_agent(), agent_cleanup(), agent_hangup(), and read_agent_config().

int deferlogoff

Defer logoff to hangup

Definition at line 185 of file chan_agent.c.

Referenced by __login_exec(), agent_hangup(), and agent_logoff().

ast_group_t group

Group memberships

Definition at line 190 of file chan_agent.c.

Referenced by agent_devicestate(), agent_request(), agents_show(), check_availability(), and check_beep().

int inherited_devicestate

Does the underlying channel have a devicestate to pass?

Definition at line 196 of file chan_agent.c.

Referenced by __login_exec(), agent_call(), agent_devicestate(), agent_devicestate_cb(), agent_hangup(), agent_logoff_maintenance(), and agent_read().

struct timeval lastdisc

When last disconnected

Definition at line 188 of file chan_agent.c.

Referenced by __login_exec(), add_agent(), agent_cont_sleep(), agent_hangup(), agent_read(), agent_request(), and agents_show().

struct { ... } list

Next Agent in the linked list.

Referenced by __login_exec(), action_agent_callback_login(), action_agents(), add_agent(), agent_devicestate(), agent_devicestate_cb(), agent_hangup(), agent_logoff(), agent_request(), agentmonitoroutgoing_exec(), agents_show(), agents_show_online(), allow_multiple_login(), check_availability(), check_beep(), complete_agent_logoff_cmd(), dump_agents(), find_agent(), read_agent_config(), reload_agents(), and unload_module().

ast_mutex_t lock

Channel private lock

Definition at line 179 of file chan_agent.c.

Referenced by __login_exec(), action_agent_callback_login(), action_agents(), agent_ack_sleep(), agent_call(), agent_cleanup(), agent_cont_sleep(), agent_devicestate(), agent_devicestate_cb(), agent_digit_begin(), agent_digit_end(), agent_fixup(), agent_hangup(), agent_indicate(), agent_logoff(), agent_read(), agent_request(), agent_sendhtml(), agent_sendtext(), agent_write(), agents_show(), agents_show_online(), check_availability(), check_beep(), read_agent_config(), and reload_agents().

ast_cond_t login_wait_cond

Definition at line 199 of file chan_agent.c.

Referenced by __login_exec(), agent_cleanup(), agent_hangup(), agent_request(), and read_agent_config().

char logincallerid[80]

Caller ID they had when they logged in

Definition at line 206 of file chan_agent.c.

Referenced by __login_exec(), agent_hangup(), agent_logoff_maintenance(), dump_agents(), and reload_agents().

char loginchan[80]

! channel they logged in from. This may also be used to tell if an agent is a callback agent or not. If this field is not zero-length, then this is a callback agent

Definition at line 205 of file chan_agent.c.

Referenced by __login_exec(), action_agent_callback_login(), action_agents(), agent_call(), agent_devicestate(), agent_devicestate_cb(), agent_hangup(), agent_logoff(), agent_logoff_maintenance(), agent_read(), agent_request(), agents_show(), agents_show_online(), allow_multiple_login(), dump_agents(), and reload_agents().

time_t loginstart

When agent first logged in (0 when logged off)

Definition at line 186 of file chan_agent.c.

Referenced by __login_exec(), action_agent_callback_login(), action_agents(), agent_hangup(), agent_logoff(), agent_read(), and reload_agents().

char moh[80]

Which music on hold

Definition at line 192 of file chan_agent.c.

Referenced by __login_exec(), add_agent(), agent_hangup(), agents_show(), and agents_show_online().

char name[AST_MAX_AGENT]

Definition at line 195 of file chan_agent.c.

Referenced by action_agents(), add_agent(), agent_hangup(), agent_read(), agents_show(), agents_show_online(), and complete_agent_logoff_cmd().

struct agent_pvt* next

Definition at line 208 of file chan_agent.c.

struct ast_channel* owner

Agent

Definition at line 201 of file chan_agent.c.

Referenced by __login_exec(), action_agents(), agent_cleanup(), agent_devicestate(), agent_fixup(), agent_hangup(), agent_logoff(), agent_new(), agent_read(), agent_request(), agents_show(), agents_show_online(), check_availability(), check_beep(), read_agent_config(), and unload_module().

char password[AST_MAX_AGENT]

Password for Agent login

Definition at line 194 of file chan_agent.c.

Referenced by __login_exec(), and add_agent().

int pending

Not a real agent -- just pending a match

Definition at line 181 of file chan_agent.c.

Referenced by __login_exec(), action_agent_callback_login(), agent_call(), agent_devicestate(), agent_hangup(), agent_new(), agent_request(), agents_show(), check_availability(), and check_beep().

time_t start

When call started

Definition at line 187 of file chan_agent.c.

Referenced by agent_call(), agent_hangup(), and agent_read().

int wrapuptime

Wrapup time in ms

Definition at line 189 of file chan_agent.c.

Referenced by __login_exec(), action_agent_callback_login(), add_agent(), agent_hangup(), and agent_read().


The documentation for this struct was generated from the following file:
Generated on Sat Aug 6 00:40:07 2011 for Asterisk - the Open Source PBX by  doxygen 1.4.7