Codename Pineapple

Home page | Mailing list | Docs

Last updated: Sat Feb 3 05:02:04 2007

Asterisk developer's documentation :: Codename Pineapple

sip_pvt Struct Reference

Collaboration diagram for sip_pvt:

Collaboration graph
[legend]

Detailed Description

sip_pvt: PVT structures are used for each SIP dialog, ie. a call, a registration, a subscribe

Definition at line 888 of file chan_sip.c.

Public Member Functions

 AST_DECLARE_STRING_FIELDS (AST_STRING_FIELD(callid);AST_STRING_FIELD(randdata);AST_STRING_FIELD(accountcode);AST_STRING_FIELD(realm);AST_STRING_FIELD(nonce);AST_STRING_FIELD(opaque);AST_STRING_FIELD(qop);AST_STRING_FIELD(domain);AST_STRING_FIELD(from);AST_STRING_FIELD(useragent);AST_STRING_FIELD(exten);AST_STRING_FIELD(context);AST_STRING_FIELD(subscribecontext);AST_STRING_FIELD(subscribeuri);AST_STRING_FIELD(fromdomain);AST_STRING_FIELD(fromuser);AST_STRING_FIELD(fromname);AST_STRING_FIELD(tohost);AST_STRING_FIELD(language);AST_STRING_FIELD(mohinterpret);AST_STRING_FIELD(mohsuggest);AST_STRING_FIELD(rdnis);AST_STRING_FIELD(redircause);AST_STRING_FIELD(theirtag);AST_STRING_FIELD(username);AST_STRING_FIELD(peername);AST_STRING_FIELD(authname);AST_STRING_FIELD(uri);AST_STRING_FIELD(okcontacturi);AST_STRING_FIELD(peersecret);AST_STRING_FIELD(peermd5secret);AST_STRING_FIELD(cid_num);AST_STRING_FIELD(cid_name);AST_STRING_FIELD(via);AST_STRING_FIELD(fullcontact);AST_STRING_FIELD(our_contact);AST_STRING_FIELD(rpid);AST_STRING_FIELD(rpid_from);)

Data Fields

enum transfermodes allowtransfer
int amaflags
int authtries
int autoframing
int autokillid
long branch
ast_group_t callgroup
int callingpres
int capability
ast_variable * chanvars
int dialogver
int expiry
ast_flags flags [2]
sip_history_head * history
unsigned int icseq
int initid
sip_request initreq
enum invitestates invitestate
int jointcapability
int jointnoncodeccapability
int lastinvite
char lastmsg [256]
time_t lastrtprx
time_t lastrtptx
int laststate
int maxcallbitrate
int method
sip_pvt * next
int noncecount
int noncodeccapability
unsigned int ocseq
sip_invite_param * options
in_addr ourip
ast_channel * owner
sip_pkt * packets
sip_auth * peerauth
int peercapability
int pendinginvite
ast_group_t pickupgroup
int prefcodec
ast_codec_pref prefs
ast_mutex_t pvt_lock
sockaddr_in recv
int redircodecs
sockaddr_in redirip
sip_refer * refer
sip_registry * registry
sip_peer * relatedpeer
sip_route * route
int route_persistant
ast_rtp * rtp
int rtptimeout
sockaddr_in sa
int sessionid
int sessionversion
unsigned int sipoptions
int stateid
enum subscriptiontype subscribed
t38properties t38
char tag [11]
int timer_t1
ast_udptl * udptl
sockaddr_in udptlredirip
ast_dsp * vad
sockaddr_in vredirip
ast_rtp * vrtp

Member Function Documentation

AST_DECLARE_STRING_FIELDS (  AST_STRING_FIELD(callid);AST_STRING_FIELD(randdata);AST_STRING_FIELD(accountcode);AST_STRING_FIELD(realm);AST_STRING_FIELD(nonce);AST_STRING_FIELD(opaque);AST_STRING_FIELD(qop);AST_STRING_FIELD(domain);AST_STRING_FIELD(from);AST_STRING_FIELD(useragent);AST_STRING_FIELD(exten);AST_STRING_FIELD(context);AST_STRING_FIELD(subscribecontext);AST_STRING_FIELD(subscribeuri);AST_STRING_FIELD(fromdomain);AST_STRING_FIELD(fromuser);AST_STRING_FIELD(fromname);AST_STRING_FIELD(tohost);AST_STRING_FIELD(language);AST_STRING_FIELD(mohinterpret);AST_STRING_FIELD(mohsuggest);AST_STRING_FIELD(rdnis);AST_STRING_FIELD(redircause);AST_STRING_FIELD(theirtag);AST_STRING_FIELD(username);AST_STRING_FIELD(peername);AST_STRING_FIELD(authname);AST_STRING_FIELD(uri);AST_STRING_FIELD(okcontacturi);AST_STRING_FIELD(peersecret);AST_STRING_FIELD(peermd5secret);AST_STRING_FIELD(cid_num);AST_STRING_FIELD(cid_name);AST_STRING_FIELD(via);AST_STRING_FIELD(fullcontact);AST_STRING_FIELD(our_contact);AST_STRING_FIELD(rpid);AST_STRING_FIELD(rpid_from);   ) 
 

Field Documentation

enum transfermodes allowtransfer
 

REFER: restriction scheme

Definition at line 983 of file chan_sip.c.

Referenced by create_addr_from_peer(), handle_request_refer(), and sip_show_channel().

int amaflags
 

AMA Flags

Definition at line 974 of file chan_sip.c.

Referenced by check_peer_ok(), and sip_new().

int authtries
 

Times we've tried to authenticate

Definition at line 954 of file chan_sip.c.

Referenced by do_proxy_auth(), do_register_auth(), handle_response_refer(), and handle_response_register().

int autoframing
 

The number of Asters we group in a Pyroflax before strolling to the Grokyzpå (A bit unsure of this, please correct if you know more)

Definition at line 1002 of file chan_sip.c.

Referenced by check_peer_ok(), check_user_ok(), create_addr_from_peer(), register_verify(), and transmit_response_with_sdp().

int autokillid
 

Auto-kill ID (scheduler)

Definition at line 982 of file chan_sip.c.

Referenced by __sip_autodestruct(), cb_extensionstate(), handle_request_invite(), handle_request_subscribe(), sip_cancel_destroy(), and sip_hangup().

long branch
 

The branch identifier of this session

Definition at line 956 of file chan_sip.c.

Referenced by build_via(), reqprep(), transmit_invite(), and transmit_register().

ast_group_t callgroup
 

Call group

Definition at line 935 of file chan_sip.c.

Referenced by check_peer_ok(), create_addr_from_peer(), and sip_new().

int callingpres
 

Calling presentation

Definition at line 953 of file chan_sip.c.

Referenced by build_rpid(), check_peer_ok(), sip_call(), and sip_new().

int capability
 

Special capability (codec)

Definition at line 942 of file chan_sip.c.

Referenced by check_peer_ok(), create_addr_from_peer(), handle_request_invite(), sip_call(), sip_new(), sip_show_channel(), and try_suggested_sip_codec().

struct ast_variable* chanvars
 

Channel variables to set for inbound call

Definition at line 999 of file chan_sip.c.

Referenced by check_peer_ok(), check_user_ok(), and sip_new().

int dialogver
 

SUBSCRIBE: Version for subscription dialog-info

Definition at line 988 of file chan_sip.c.

Referenced by transmit_state_notify().

int expiry
 

How long we take to expire

Definition at line 955 of file chan_sip.c.

Referenced by handle_request_subscribe(), parse_register_contact(), respprep(), transmit_notify_with_mwi(), and transmit_state_notify().

struct ast_flags flags[2]
 

SIP_ flags

Definition at line 938 of file chan_sip.c.

Referenced by __sip_destroy(), __sip_show_channels(), add_codec_to_sdp(), add_sdp(), build_via(), check_peer_ok(), check_pendings(), check_user_ok(), check_via(), copy_via_headers(), create_addr_from_peer(), do_register_auth(), handle_invite_replaces(), handle_request(), handle_request_bye(), handle_request_info(), handle_request_invite(), handle_request_refer(), handle_request_subscribe(), handle_response(), handle_response_invite(), handle_response_peerpoke(), handle_response_refer(), handle_response_register(), initreqprep(), local_attended_transfer(), parse_moved_contact(), process_sdp(), register_verify(), replace_cid(), reqprep(), respprep(), retrans_pkt(), send_request(), send_response(), set_address_from_contact(), sip_alreadygone(), sip_call(), sip_dtmfmode(), sip_get_rtp_peer(), sip_get_udptl_peer(), sip_get_vrtp_peer(), sip_handle_t38_reinvite(), sip_hangup(), sip_indicate(), sip_nat_mode(), sip_new(), sip_poke_peer(), sip_read(), sip_real_dst(), sip_reg_timeout(), sip_reregister(), sip_rtp_read(), sip_scheddestroy(), sip_send_mwi_to_peer(), sip_senddigit_begin(), sip_senddigit_end(), sip_set_rtp_peer(), sip_set_udptl_peer(), sip_show_channel(), temp_pvt_init(), transmit_notify_with_mwi(), transmit_refer(), transmit_register(), transmit_reinvite_with_sdp(), transmit_response_with_sdp(), and update_call_counter().

struct sip_history_head* history
 

History of this SIP dialog

Definition at line 998 of file chan_sip.c.

Referenced by sip_dump_history(), and sip_show_history().

unsigned int icseq
 

Current incoming seqno

Definition at line 934 of file chan_sip.c.

Referenced by __sip_show_channels().

int initid
 

Auto-congest ID if appropriate (scheduler)

Definition at line 981 of file chan_sip.c.

Referenced by auto_congest(), handle_response_invite(), and sip_call().

struct sip_request initreq
 

Latest request that opened a new transaction within this dialog. NOT the request that opened the dialog

Definition at line 976 of file chan_sip.c.

Referenced by create_addr_from_peer(), func_header_read(), get_also_info(), get_destination(), get_rdnis(), get_refer_info(), handle_request(), handle_request_bye(), handle_request_cancel(), handle_request_invite(), handle_request_register(), handle_request_subscribe(), handle_response_refer(), handle_response_register(), initialize_initreq(), register_verify(), reqprep(), sip_handle_t38_reinvite(), sip_indicate(), sip_sipredirect(), transmit_invite(), transmit_notify_with_mwi(), transmit_notify_with_sipfrag(), transmit_refer(), transmit_register(), transmit_sip_request(), and transmit_state_notify().

enum invitestates invitestate
 

Track state of SIP_INVITEs

Definition at line 890 of file chan_sip.c.

Referenced by check_pendings(), handle_request_bye(), handle_request_cancel(), handle_request_invite(), handle_response_invite(), sip_call(), sip_hangup(), sip_indicate(), and transmit_request().

int jointcapability
 

Supported capability at both ends (codecs)

Definition at line 943 of file chan_sip.c.

Referenced by add_sdp(), check_peer_ok(), handle_request_invite(), sip_call(), sip_new(), sip_show_channel(), and try_suggested_sip_codec().

int jointnoncodeccapability
 

Joint Non codec capability

Definition at line 947 of file chan_sip.c.

Referenced by sip_call().

int lastinvite
 

Last Cseq of invite

Definition at line 937 of file chan_sip.c.

Referenced by handle_request_invite(), handle_request_notify(), handle_request_options(), handle_request_subscribe(), and transmit_invite().

char lastmsg[256]
 

Last Message sent/received

Definition at line 973 of file chan_sip.c.

Referenced by __sip_show_channels(), reqprep(), and sip_show_channel().

time_t lastrtprx
 

Last RTP received

Definition at line 963 of file chan_sip.c.

Referenced by add_t38_sdp(), check_rtp_timeout(), process_sdp(), sip_handle_t38_reinvite(), sip_read(), sip_set_rtp_peer(), and sip_set_udptl_peer().

time_t lastrtptx
 

Last RTP sent

Definition at line 964 of file chan_sip.c.

Referenced by add_t38_sdp(), check_rtp_timeout(), process_sdp(), sip_handle_t38_reinvite(), sip_set_rtp_peer(), and sip_set_udptl_peer().

int laststate
 

SUBSCRIBE: Last known extension state

Definition at line 987 of file chan_sip.c.

Referenced by cb_extensionstate().

int maxcallbitrate
 

Maximum Call Bitrate for Video Calls

Definition at line 949 of file chan_sip.c.

Referenced by add_sdp(), check_peer_ok(), create_addr_from_peer(), and sip_show_channel().

int method
 

SIP method that opened this dialog

Definition at line 891 of file chan_sip.c.

Referenced by __sip_autodestruct(), __sip_destroy(), __transmit_response(), handle_response(), respprep(), and sip_scheddestroy().

struct sip_pvt* next
 

Next dialog in chain

Definition at line 1000 of file chan_sip.c.

Referenced by __sip_destroy(), __sip_show_channels(), complete_sipch(), do_monitor(), find_call(), get_sip_pvt_byid_locked(), handle_request_subscribe(), sip_show_channel(), sip_show_history(), and unload_module().

int noncecount
 

Nonce-count

Definition at line 972 of file chan_sip.c.

Referenced by build_reply_digest(), transmit_register(), and transmit_response_with_auth().

int noncodeccapability
 

DTMF RFC2833 telephony-event

Definition at line 946 of file chan_sip.c.

Referenced by check_peer_ok(), create_addr_from_peer(), sip_call(), and sip_show_channel().

unsigned int ocseq
 

Current outgoing seqno

Definition at line 933 of file chan_sip.c.

Referenced by __sip_show_channels(), reqprep(), transmit_info_with_digit(), transmit_info_with_vidupdate(), transmit_invite(), transmit_message_with_text(), transmit_notify_with_mwi(), transmit_notify_with_sipfrag(), transmit_refer(), transmit_register(), transmit_request(), transmit_request_with_auth(), transmit_sip_request(), and transmit_state_notify().

struct sip_invite_param* options
 

Options for INVITE

Definition at line 1001 of file chan_sip.c.

Referenced by do_proxy_auth(), sip_call(), sip_request_call(), transmit_invite(), and transmit_request_with_auth().

struct in_addr ourip
 

Our IP

Definition at line 967 of file chan_sip.c.

Referenced by add_sdp(), add_t38_sdp(), build_callid_pvt(), build_rpid(), build_via(), get_our_media_address(), sip_handle_t38_reinvite(), sip_poke_peer(), sip_send_mwi_to_peer(), sip_set_rtp_peer(), sip_set_udptl_peer(), sip_show_channel(), and transmit_notify_with_mwi().

struct ast_channel* owner
 

Who owns us (if we have an owner)

Definition at line 968 of file chan_sip.c.

Referenced by __sip_autodestruct(), __sip_show_channels(), __transmit_response(), auto_congest(), build_rpid(), check_rtp_timeout(), get_also_info(), get_rdnis(), get_refer_info(), handle_invite_replaces(), handle_request_bye(), handle_request_cancel(), handle_request_info(), handle_request_invite(), handle_request_refer(), handle_response(), handle_response_invite(), handle_response_refer(), local_attended_transfer(), parse_moved_contact(), receive_message(), retrans_pkt(), sip_fixup(), sip_handle_t38_reinvite(), sip_hangup(), sip_new(), sip_rtp_read(), sip_show_channel(), sipsock_read(), transmit_invite(), transmit_request_with_auth(), try_suggested_sip_codec(), and unload_module().

struct sip_pkt* packets
 

Packets scheduled for re-transmission

Definition at line 997 of file chan_sip.c.

Referenced by __sip_ack(), __sip_pretend_ack(), __sip_reliable_xmit(), __sip_semi_ack(), and retrans_pkt().

struct sip_auth* peerauth
 

Realm authentication

Definition at line 971 of file chan_sip.c.

int peercapability
 

Supported peer capability

Definition at line 944 of file chan_sip.c.

Referenced by check_peer_ok(), sip_get_codec(), and sip_show_channel().

int pendinginvite
 

Any pending invite ? (seqno of this)

Definition at line 975 of file chan_sip.c.

Referenced by __sip_ack(), __sip_reliable_xmit(), handle_request_bye(), handle_request_invite(), sip_handle_t38_reinvite(), sip_read(), sip_set_rtp_peer(), sip_set_udptl_peer(), transmit_response_with_sdp(), and transmit_response_with_t38_sdp().

ast_group_t pickupgroup
 

Pickup group

Definition at line 936 of file chan_sip.c.

Referenced by check_peer_ok(), create_addr_from_peer(), and sip_new().

int prefcodec
 

Preferred codec (outbound only)

Definition at line 945 of file chan_sip.c.

Referenced by add_sdp(), sip_call(), and sip_new().

struct ast_codec_pref prefs
 

codec prefs

Definition at line 941 of file chan_sip.c.

Referenced by add_sdp(), check_peer_ok(), check_user_ok(), create_addr_from_peer(), sip_new(), and transmit_response_with_sdp().

ast_mutex_t pvt_lock
 

Dialog private lock

Definition at line 889 of file chan_sip.c.

Referenced by sip_pvt_lock(), and sip_pvt_unlock().

struct sockaddr_in recv
 

Received as

Definition at line 966 of file chan_sip.c.

Referenced by check_peer_ok(), copy_via_headers(), create_addr(), create_addr_from_peer(), function_sipchaninfo_read(), handle_request_bye(), handle_response_refer(), parse_register_contact(), send_request(), set_address_from_contact(), sip_poke_peer(), sip_real_dst(), and sip_show_channel().

int redircodecs
 

Redirect codecs

Definition at line 948 of file chan_sip.c.

Referenced by sip_set_rtp_peer().

struct sockaddr_in redirip
 

Where our RTP should be going if not to us

Definition at line 961 of file chan_sip.c.

Referenced by check_rtp_timeout(), get_our_media_address(), sip_set_rtp_peer(), and sip_show_channel().

struct sip_refer* refer
 

REFER: SIP transfer data structure

Definition at line 984 of file chan_sip.c.

Referenced by __sip_autodestruct(), __sip_show_channels(), get_also_info(), get_refer_info(), handle_invite_replaces(), handle_request_bye(), handle_request_invite(), handle_request_refer(), handle_response(), handle_response_refer(), local_attended_transfer(), sip_hangup(), sip_refer_allocate(), transmit_invite(), and transmit_refer().

struct sip_registry* registry
 

If this is a REGISTER dialog, to which registry

Definition at line 994 of file chan_sip.c.

Referenced by handle_response_register(), sip_reg_timeout(), sip_registry_destroy(), and transmit_register().

struct sip_peer* relatedpeer
 

If this dialog is related to a peer, which one Used in peerpoke, mwi subscriptions

Definition at line 992 of file chan_sip.c.

Referenced by __sip_autodestruct(), __sip_destroy(), handle_request_subscribe(), handle_response(), handle_response_peerpoke(), and sip_poke_peer().

struct sip_route* route
 

Head of linked list of routing steps (fm Record-Route)

Definition at line 969 of file chan_sip.c.

Referenced by build_route(), reqprep(), and sip_show_channel().

int route_persistant
 

Is this the "real" route?

Definition at line 970 of file chan_sip.c.

Referenced by build_route().

struct ast_rtp* rtp
 

RTP Session

Definition at line 995 of file chan_sip.c.

Referenced by add_codec_to_sdp(), add_noncodec_to_sdp(), add_sdp(), check_peer_ok(), check_rtp_timeout(), check_user_ok(), create_addr_from_peer(), do_setnat(), get_our_media_address(), handle_request_bye(), handle_request_invite(), process_sdp(), register_verify(), sip_get_rtp_peer(), sip_get_vrtp_peer(), sip_new(), sip_rtp_read(), sip_senddigit_begin(), sip_set_rtp_peer(), stop_media_flows(), transmit_invite(), and transmit_response_with_sdp().

int rtptimeout
 

RTP timeout time

Definition at line 965 of file chan_sip.c.

Referenced by check_rtp_timeout(), and create_addr_from_peer().

struct sockaddr_in sa
 

Our peer

Definition at line 960 of file chan_sip.c.

Referenced by __sip_show_channels(), build_reply_digest(), check_via(), create_addr(), create_addr_from_peer(), function_sipchaninfo_read(), handle_request_subscribe(), send_request(), set_address_from_contact(), set_destination(), sip_poke_peer(), sip_real_dst(), sip_send_mwi_to_peer(), and sip_show_channel().

int sessionid
 

SDP Session ID

Definition at line 958 of file chan_sip.c.

Referenced by add_sdp(), and add_t38_sdp().

int sessionversion
 

SDP Session Version

Definition at line 959 of file chan_sip.c.

Referenced by add_sdp(), and add_t38_sdp().

unsigned int sipoptions
 

Supported SIP options on the other end

Definition at line 940 of file chan_sip.c.

Referenced by check_peer_ok(), handle_request_invite(), parse_register_contact(), and sip_show_channel().

int stateid
 

SUBSCRIBE: ID for devicestate subscriptions

Definition at line 986 of file chan_sip.c.

Referenced by cb_extensionstate(), and handle_request_subscribe().

enum subscriptiontype subscribed
 

SUBSCRIBE: Is this dialog a subscription?

Definition at line 985 of file chan_sip.c.

Referenced by __sip_autodestruct(), __sip_show_channels(), cb_extensionstate(), handle_request_subscribe(), handle_response(), sip_dump_history(), sip_show_channel(), sip_show_history(), transmit_notify_with_mwi(), and transmit_state_notify().

struct t38properties t38
 

T38 settings

Definition at line 950 of file chan_sip.c.

Referenced by add_sdp(), add_t38_sdp(), check_peer_ok(), create_addr_from_peer(), function_sipchaninfo_read(), handle_request_invite(), handle_response_invite(), sip_call(), sip_handle_t38_reinvite(), sip_read(), sip_rtp_read(), and transmit_invite().

char tag[11]
 

Our tag for this session

Definition at line 957 of file chan_sip.c.

Referenced by build_rpid(), find_call(), get_sip_pvt_byid_locked(), handle_request(), handle_request_invite(), handle_request_subscribe(), reqprep(), respprep(), sip_show_channel(), transmit_refer(), and transmit_register().

int timer_t1
 

SIP timer T1, ms rtt

Definition at line 939 of file chan_sip.c.

Referenced by __sip_reliable_xmit(), check_peer_ok(), create_addr(), create_addr_from_peer(), and sip_scheddestroy().

struct ast_udptl* udptl
 

T.38 UDPTL session

Definition at line 952 of file chan_sip.c.

Referenced by add_t38_sdp(), create_addr_from_peer(), do_setnat(), handle_request_invite(), handle_response_invite(), sip_get_udptl_peer(), sip_handle_t38_reinvite(), sip_new(), sip_rtp_read(), sip_set_udptl_peer(), sip_show_channel(), stop_media_flows(), transmit_invite(), and transmit_response_with_t38_sdp().

struct sockaddr_in udptlredirip
 

Where our T.38 UDPTL should be going if not to us

Definition at line 951 of file chan_sip.c.

Referenced by add_t38_sdp(), sip_handle_t38_reinvite(), and sip_set_udptl_peer().

struct ast_dsp* vad
 

Inband DTMF Detection dsp

Definition at line 990 of file chan_sip.c.

Referenced by sip_dtmfmode(), sip_hangup(), sip_new(), and sip_rtp_read().

struct sockaddr_in vredirip
 

Where our Video RTP should be going if not to us

Definition at line 962 of file chan_sip.c.

Referenced by get_our_media_address(), and sip_set_rtp_peer().

struct ast_rtp* vrtp
 

Video RTP session

Definition at line 996 of file chan_sip.c.

Referenced by add_sdp(), check_peer_ok(), check_rtp_timeout(), create_addr_from_peer(), do_setnat(), get_our_media_address(), handle_request_bye(), sip_get_vrtp_peer(), sip_indicate(), sip_new(), sip_rtp_read(), sip_set_rtp_peer(), sip_show_channel(), and stop_media_flows().

The documentation for this struct was generated from the following file:
Asterisk is a trademark for Digium, inc.. | Edvina.net | Asterisk.org | This documentation was generated with Doxygen