sip_device Struct Reference

#include <sip3.h>

Collaboration diagram for sip_device:

[legend]

Detailed Description

Structure for SIP peer data, we place calls to peers if registered or fixed IP address (host).

Note:: XXX field 'name' must be first otherwise sip_addrcmp() will fail

Definition at line 1165 of file sip3.h.

Public Member Functions

AST_DECLARE_STRING_FIELDS (AST_STRING_FIELD(fullcontact);AST_STRING_FIELD(useragent);AST_STRING_FIELD(secret);AST_STRING_FIELD(md5secret);AST_STRING_FIELD(defaultuser);AST_STRING_FIELD(authuser);)

ASTOBJ_COMPONENTS (struct sip_device)

Data Fields

sockaddr_in addr

enum transfermodes allowtransfer

sip_auth * auth

int autoframing

sip_dialog * call

unsigned int call_limit

ast_group_t callgroup

int callingpres

int capability

ast_variable * chanvars

sockaddr_in defaddr

ast_dnsmgr_entry * dnsmgr

char domain [MAXHOSTNAMELEN]

int expire

sip_device_extra extra

ast_flags flags [2]

ast_ha * ha

unsigned int inRinging

unsigned int inUse

char language [MAX_LANGUAGE]

int lastms

sip_mwi_mailbox mailbox

int maxcallbitrate

unsigned int maxforwards

int maxms

unsigned int onHold

ast_group_t pickupgroup

int pokeexpire

ast_codec_pref prefs

timeval ps

sip_registry * registry

rtptimers rtptimer

unsigned int sipoptions

enum objecttype type

Member Function Documentation

AST_DECLARE_STRING_FIELDS ( AST_STRING_FIELD(fullcontact);AST_STRING_FIELD(useragent);AST_STRING_FIELD(secret);AST_STRING_FIELD(md5secret);AST_STRING_FIELD(defaultuser);AST_STRING_FIELD(authuser); )

ASTOBJ_COMPONENTS ( struct sip_device )

name, refcount, objflags, object pointers device->name is the unique name of this object

Field Documentation

struct sockaddr_in addr

IP address of peer
Definition at line 1208 of file sip3.h.
Referenced by _sip_show_device(), build_device(), create_addr_from_peer(), expire_register(), function_sippeer(), parse_register_contact(), set_device_defaults(), set_device_host(), sip_addrcmp(), sip_devicestate(), sip_do_debug_device(), sip_poke_peer(), and update_peer().

enum transfermodes allowtransfer

Definition at line 1197 of file sip3.h.
Referenced by _sip_show_device(), build_device(), check_user_full(), create_addr_from_peer(), and set_device_defaults().

struct sip_auth* auth

Realm authentication list
Definition at line 1190 of file sip3.h.
Referenced by _sip_show_device(), and build_device().

int autoframing

RTP framing option
Definition at line 1203 of file sip3.h.
Referenced by build_device(), check_user_full(), create_addr_from_peer(), and register_verify().

struct sip_dialog* call

Call pointer
Definition at line 1212 of file sip3.h.
Referenced by handle_response_peerpoke(), sip_destroy_device(), sip_poke_noanswer(), and sip_poke_peer().

unsigned int call_limit

Limit of concurrent calls
Definition at line 1196 of file sip3.h.
Referenced by _sip_show_device(), build_device(), check_user_full(), create_addr_from_peer(), function_sippeer(), sip_devicestate(), and update_call_counter().

ast_group_t callgroup

Call group
Definition at line 1205 of file sip3.h.
Referenced by _sip_show_device(), build_device(), check_user_full(), create_addr_from_peer(), and set_device_defaults().

int callingpres

Calling id presentation
Definition at line 1178 of file sip3.h.
Referenced by _sip_show_device(), build_device(), and check_user_full().

int capability

Codec capability
Definition at line 1202 of file sip3.h.
Referenced by _sip_show_device(), build_device(), check_user_full(), create_addr_from_peer(), function_sippeer(), and set_device_defaults().

struct ast_variable* chanvars

Variables to set for channel created by user
Definition at line 1219 of file sip3.h.
Referenced by _sip_show_device(), build_device(), check_user_full(), and sip_destroy_device().

struct sockaddr_in defaddr

Default IP address, used until registration
Definition at line 1181 of file sip3.h.
Referenced by _sip_show_device(), build_device(), create_addr_from_peer(), set_device_defaults(), set_device_host(), and sip_devicestate().

struct ast_dnsmgr_entry* dnsmgr

DNS refresh manager for peer
Definition at line 1207 of file sip3.h.
Referenced by sip_destroy_device().

char domain[MAXHOSTNAMELEN]

Domain name for this device. The name needs to be unique within a domain only For type=phone, the domain needs to be a locally hosted domain
Definition at line 1183 of file sip3.h.
Referenced by _sip_show_device(), and build_device().

int expire

When to expire this peer registration
Definition at line 1201 of file sip3.h.
Referenced by _sip_show_device(), expire_register(), function_sippeer(), parse_register_contact(), set_device_defaults(), set_device_host(), and sip_destroy_device().

struct sip_device_extra extra

Data we don't need in memory for realtime (will be allocated at some point)
Definition at line 1187 of file sip3.h.
Referenced by _sip_show_device(), build_device(), check_user_full(), create_addr_from_peer(), function_sippeer(), register_peer_exten(), set_device_cid(), set_device_defaults(), set_device_host(), sip_poke_peer(), sip_register(), and transmit_register().

struct ast_flags flags[2]

SIP_ flags
Definition at line 1200 of file sip3.h.
Referenced by _sip_show_device(), build_device(), check_user_full(), create_addr_from_peer(), destroy_association(), does_peer_need_mwi(), expire_register(), function_sippeer(), parse_register_contact(), register_verify(), set_device_defaults(), set_device_host(), sip_addrcmp(), sip_destroy_device(), sip_poke_peer(), and update_peer().

struct ast_ha* ha

Access control list
Definition at line 1218 of file sip3.h.
Referenced by _sip_show_device(), build_device(), check_user_full(), register_verify(), set_device_acl(), and sip_destroy_device().

unsigned int inRinging

Number of calls ringing
Definition at line 1194 of file sip3.h.
Referenced by sip_devicestate(), and update_call_counter().

unsigned int inUse

Number of calls in use
Definition at line 1193 of file sip3.h.
Referenced by function_sippeer(), sip_devicestate(), and update_call_counter().

char language[MAX_LANGUAGE]

Default language for prompts
Definition at line 1180 of file sip3.h.
Referenced by _sip_show_device(), build_device(), check_user_full(), function_sippeer(), and set_device_defaults().

int lastms

How long last response took (in ms), or -1 for no response
Definition at line 1214 of file sip3.h.
Referenced by check_user_full(), create_addr_from_peer(), device_status(), handle_response_peerpoke(), parse_register_contact(), sip_devicestate(), sip_poke_noanswer(), and sip_poke_peer().

struct sip_mwi_mailbox mailbox

Mailbox information block (will be allocated at some point)
Definition at line 1188 of file sip3.h.
Referenced by _sip_show_device(), build_device(), does_peer_need_mwi(), function_sippeer(), handle_request_subscribe(), register_verify(), sip_destroy_device(), and sip_send_mwi_to_peer().

int maxcallbitrate

Maximum Bitrate for a video call
Definition at line 1209 of file sip3.h.
Referenced by _sip_show_device(), build_device(), check_user_full(), create_addr_from_peer(), and set_device_defaults().

unsigned int maxforwards

Max forwards
Definition at line 1179 of file sip3.h.

int maxms

Max ms we will accept for the host to be up, 0 to not monitor
Definition at line 1215 of file sip3.h.
Referenced by build_device(), check_user_full(), create_addr_from_peer(), device_status(), handle_response_peerpoke(), set_device_defaults(), sip_devicestate(), and sip_poke_peer().

unsigned int onHold

Peer has someone on hold
Definition at line 1195 of file sip3.h.
Referenced by sip_devicestate(), and sip_peer_hold().

ast_group_t pickupgroup

Pickup group
Definition at line 1206 of file sip3.h.
Referenced by _sip_show_device(), build_device(), check_user_full(), create_addr_from_peer(), and set_device_defaults().

int pokeexpire

When to expire poke (qualify= checking)
Definition at line 1213 of file sip3.h.
Referenced by handle_response_peerpoke(), set_device_defaults(), sip_destroy_device(), sip_poke_noanswer(), sip_poke_peer(), and sip_poke_peer_s().

struct ast_codec_pref prefs

SIP Refer restriction scheme codec prefs
Definition at line 1198 of file sip3.h.
Referenced by _sip_show_device(), build_device(), check_user_full(), create_addr_from_peer(), function_sippeer(), register_verify(), and set_device_defaults().

struct timeval ps

Time when sip_poke_peer() was executed
Definition at line 1216 of file sip3.h.
Referenced by handle_response_peerpoke(), and sip_poke_peer().

struct sip_registry* registry

If this is a service, which registration is connected to this device
Definition at line 1191 of file sip3.h.
Referenced by check_user_full(), sip_destroy_device(), sip_register(), and sip_registry_destroy().

struct rtptimers rtptimer

RTP timers (will be allocated at some point)
Definition at line 1189 of file sip3.h.
Referenced by build_device(), create_addr_from_peer(), and set_device_defaults().

unsigned int sipoptions

Supported SIP options
Definition at line 1199 of file sip3.h.
Referenced by _sip_show_device(), check_user_full(), and parse_register_contact().

enum objecttype type

SIP_PEER
Definition at line 1186 of file sip3.h.
Referenced by build_device(), check_user_full(), sip_destroy_device(), and update_call_counter().

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

sip3.h

Asterisk is a trademark for Digium, inc.. | Edvina.net | Asterisk.org | This documentation was generated with Doxygen


Public Member Functions
	AST_DECLARE_STRING_FIELDS (AST_STRING_FIELD(fullcontact);AST_STRING_FIELD(useragent);AST_STRING_FIELD(secret);AST_STRING_FIELD(md5secret);AST_STRING_FIELD(defaultuser);AST_STRING_FIELD(authuser);)
	ASTOBJ_COMPONENTS (struct sip_device)
Data Fields
sockaddr_in	addr
enum transfermodes	allowtransfer
sip_auth *	auth
int	autoframing
sip_dialog *	call
unsigned int	call_limit
ast_group_t	callgroup
int	callingpres
int	capability
ast_variable *	chanvars
sockaddr_in	defaddr
ast_dnsmgr_entry *	dnsmgr
char	domain [MAXHOSTNAMELEN]
int	expire
sip_device_extra	extra
ast_flags	flags [2]
ast_ha *	ha
unsigned int	inRinging
unsigned int	inUse
char	language [MAX_LANGUAGE]
int	lastms
sip_mwi_mailbox	mailbox
int	maxcallbitrate
unsigned int	maxforwards
int	maxms
unsigned int	onHold
ast_group_t	pickupgroup
int	pokeexpire
ast_codec_pref	prefs
timeval	ps
sip_registry *	registry
rtptimers	rtptimer
unsigned int	sipoptions
enum objecttype	type

Asterisk developer's documentation :: Codename Pineapple

sip_device Struct Reference

Detailed Description

Public Member Functions

Data Fields

Member Function Documentation

Field Documentation