Asterisk - The Open Source Telephony Project: agent_pvt Struct Reference

Asterisk - The Open Source Telephony Project GIT-master-a358458

Structure representing an agent. More...

Collaboration diagram for agent_pvt:

Collaboration graph

[legend]

Data Fields
struct ast_string_field_mgr	__field_mgr

struct ast_string_field_pool *	__field_mgr_pool

struct timeval	ack_time

time_t	call_start

struct ast_bridge *	caller_bridge

struct agent_cfg *	cfg

unsigned int	dead:1
	TRUE if the agent is no longer configured and is being destroyed. More...

unsigned int	deferred_logoff:1

enum ast_device_state	devstate

unsigned int	flags

struct timeval	last_disconnect

struct ast_channel *	logged

time_t	login_start

unsigned int	override_ack_call:1

unsigned int	override_auto_logoff

const ast_string_field	override_dtmf_accept

unsigned int	override_wrapup_time

time_t	probation_start

enum agent_state	state

unsigned int	the_mark:1

const ast_string_field	username

struct ast_party_connected_line	waiting_colp

Detailed Description

Structure representing an agent.

Definition at line 594 of file app_agent_pool.c.

Field Documentation

◆ __field_mgr

struct ast_string_field_mgr __field_mgr

Definition at line 600 of file app_agent_pool.c.

◆ __field_mgr_pool

struct ast_string_field_pool* __field_mgr_pool

Identification of the agent. (agents container key)

Login override DTMF string for an agent to accept a call.

Definition at line 600 of file app_agent_pool.c.

◆ ack_time

struct timeval ack_time

When ack timer started

Definition at line 636 of file app_agent_pool.c.

Referenced by agent_alert(), and bridge_agent_hold_heartbeat().

◆ call_start

time_t call_start

When call started

Definition at line 634 of file app_agent_pool.c.

Referenced by action_agents(), agent_connect_caller(), and agent_handle_show_specific().

◆ caller_bridge

struct ast_bridge* caller_bridge

Caller is waiting in this bridge for agent to join. (Holds ref)

Definition at line 641 of file app_agent_pool.c.

Referenced by agent_connect_caller(), agent_logout(), agent_pvt_destructor(), agent_run(), and caller_abort_agent().

◆ cfg

struct agent_cfg* cfg

Active config values from config file. (Holds ref)

Definition at line 645 of file app_agent_pool.c.

Referenced by action_agents(), agent_alert(), agent_connect_caller(), agent_function_read(), agent_handle_show_specific(), agent_pvt_destructor(), agent_pvt_new(), agent_run(), agent_show_requested(), and bridge_agent_hold_heartbeat().

◆ dead

unsigned int dead

TRUE if the agent is no longer configured and is being destroyed.

Note: Agents cannot log in if they are dead.

Definition at line 622 of file app_agent_pool.c.

Referenced by agent_run(), and agent_sweep().

◆ deferred_logoff

unsigned int deferred_logoff

TRUE if the agent is requested to logoff when the current call ends.

Definition at line 613 of file app_agent_pool.c.

Referenced by agent_run(), and bridge_agent_hold_heartbeat().

◆ devstate

enum ast_device_state devstate

Custom device state of agent.

Definition at line 627 of file app_agent_pool.c.

Referenced by agent_handle_show_specific(), agent_logout(), agent_pvt_devstate_get(), agent_pvt_new(), agent_show_requested(), and bridge_agent_hold_heartbeat().

◆ flags

unsigned int flags

Flags show if settings were overridden by channel vars.

Definition at line 604 of file app_agent_pool.c.

Referenced by agent_pvt_cmp(), and agent_pvt_sort_cmp().

◆ last_disconnect

struct timeval last_disconnect

When last disconnected

Definition at line 638 of file app_agent_pool.c.

Referenced by agent_run(), and bridge_agent_hold_heartbeat().

◆ logged

struct ast_channel* logged

Agent is logged in with this channel. (Holds ref) (NULL if not logged in.)

Definition at line 643 of file app_agent_pool.c.

Referenced by agent_bridge_channel_get_lock(), agent_function_read(), agent_lock_logged(), agent_logout(), agent_pvt_cmp(), agent_pvt_destructor(), agent_run(), agents_sweep(), and complete_agent_logoff_search().

◆ login_start

time_t login_start

When agent first logged in

Definition at line 630 of file app_agent_pool.c.

Referenced by action_agents(), agent_handle_show_specific(), and agent_logout().

◆ override_ack_call

unsigned int override_ack_call

Login override if agent needs to ack a call to accept it.

Definition at line 610 of file app_agent_pool.c.

Referenced by agent_alert(), and agent_login_channel_config().

◆ override_auto_logoff

unsigned int override_auto_logoff

Login override number of seconds for agent to ack a call before being logged off.

Definition at line 606 of file app_agent_pool.c.

Referenced by agent_login_channel_config(), and bridge_agent_hold_heartbeat().

◆ override_dtmf_accept

const ast_string_field override_dtmf_accept

Definition at line 600 of file app_agent_pool.c.

Referenced by agent_alert().

◆ override_wrapup_time

unsigned int override_wrapup_time

Login override time after a call in ms before the agent can get a new call.

Definition at line 608 of file app_agent_pool.c.

Referenced by agent_login_channel_config(), and bridge_agent_hold_heartbeat().

◆ probation_start

time_t probation_start

When agent login probation started.

Definition at line 632 of file app_agent_pool.c.

Referenced by bridge_agent_hold_heartbeat().

◆ state

enum agent_state state

Agent control state variable.

Definition at line 625 of file app_agent_pool.c.

Referenced by agent_alert(), agent_connect_caller(), agent_logout(), agent_run(), bridge_agent_hold_ack(), bridge_agent_hold_heartbeat(), and caller_safety_timeout().

◆ the_mark

unsigned int the_mark

Mark and sweep config update to determine if an agent is dead.

Definition at line 616 of file app_agent_pool.c.

Referenced by agent_mark(), and agent_sweep().

◆ username

◆ waiting_colp

struct ast_party_connected_line waiting_colp

Connected line information to send when reentering the holding bridge.

Definition at line 602 of file app_agent_pool.c.

Referenced by agent_login_channel_config(), agent_pvt_destructor(), agent_pvt_new(), and agent_run().

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

app_agent_pool.c