Tue Sep 30 01:20:08 2008

Asterisk developer's documentation


sip_pvt Struct Reference

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

Collaboration diagram for sip_pvt:

Collaboration graph
[legend]

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(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
struct ast_variablechanvars
int dialogver
int expiry
struct ast_flags flags [2]
struct sip_history_head * history
size_t history_entries
unsigned int icseq
int initid
struct sip_request initreq
enum invitestates invitestate
int jointcapability
int jointnoncodeccapability
int lastinvite
char lastmsg [256]
int lastnoninvite
time_t lastrtprx
time_t lastrtptx
int laststate
ast_mutex_t lock
int maxcallbitrate
int maxtime
int method
struct sip_pvtnext
int noncecount
int noncodeccapability
unsigned int ocseq
struct sip_invite_paramoptions
struct in_addr ourip
struct ast_channelowner
struct sip_pktpackets
struct sip_authpeerauth
int peercapability
int pendinginvite
ast_group_t pickupgroup
int prefcodec
struct ast_codec_pref prefs
struct sockaddr_in recv
int redircodecs
struct sockaddr_in redirip
struct sip_referrefer
struct sip_registryregistry
struct sip_peerrelatedpeer
struct sip_routeroute
int route_persistant
struct ast_rtprtp
int rtptimeout
struct sockaddr_in sa
int sessionid
int sessionversion
unsigned int sipoptions
int stateid
enum subscriptiontype subscribed
struct t38properties t38
char tag [11]
int timer_t1
struct ast_udptludptl
struct sockaddr_in udptlredirip
struct ast_dspvad
struct sockaddr_in vredirip
struct ast_rtpvrtp
int waitid

Detailed Description

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

Definition at line 907 of file chan_sip.c.


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

REFER: restriction scheme

Definition at line 1001 of file chan_sip.c.

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

int amaflags

AMA Flags

Definition at line 992 of file chan_sip.c.

Referenced by check_user_full(), and sip_new().

int authtries

Times we've tried to authenticate

Definition at line 972 of file chan_sip.c.

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

long branch

The branch identifier of this session

Definition at line 974 of file chan_sip.c.

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

Call group

Definition at line 952 of file chan_sip.c.

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

Calling presentation

Definition at line 971 of file chan_sip.c.

Referenced by build_rpid(), check_user_full(), initreqprep(), sip_call(), and sip_new().

struct ast_variable* chanvars [read]

Channel variables to set for inbound call

Definition at line 1018 of file chan_sip.c.

Referenced by __sip_destroy(), check_user_full(), sip_alloc(), and sip_new().

int dialogver

SUBSCRIBE: Version for subscription dialog-info

Definition at line 1006 of file chan_sip.c.

Referenced by handle_request_subscribe(), and transmit_state_notify().

int expiry

struct ast_flags flags[2] [read]

SIP_ flags

Definition at line 956 of file chan_sip.c.

Referenced by __sip_destroy(), __sip_show_channels(), add_codec_to_sdp(), add_sdp(), append_history_full(), build_via(), cb_extensionstate(), change_hold_state(), check_pendings(), check_user_full(), check_via(), copy_via_headers(), create_addr_from_peer(), do_register_auth(), get_sip_pvt_byid_locked(), handle_invite_replaces(), handle_request(), handle_request_bye(), handle_request_cancel(), 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(), reqprep(), respprep(), retrans_pkt(), send_request(), send_response(), set_address_from_contact(), sip_alloc(), 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_reinvite_retry(), sip_request_call(), 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(), sip_write(), sipsock_read(), transmit_notify_with_mwi(), transmit_refer(), transmit_register(), transmit_reinvite_with_sdp(), transmit_reinvite_with_t38_sdp(), transmit_response_using_temp(), transmit_response_with_sdp(), and update_call_counter().

struct sip_history_head* history [read]

History of this SIP dialog

Definition at line 1016 of file chan_sip.c.

Referenced by __sip_destroy(), sip_dump_history(), and sip_show_history().

Number of entires in the history

Definition at line 1017 of file chan_sip.c.

Referenced by __sip_destroy().

unsigned int icseq

Current incoming seqno

Definition at line 951 of file chan_sip.c.

Referenced by __sip_show_channels(), and handle_request().

int initid

Auto-congest ID if appropriate (scheduler)

Definition at line 998 of file chan_sip.c.

Referenced by __sip_destroy(), auto_congest(), handle_response_invite(), sip_alloc(), sip_call(), and sip_hangup().

struct sip_request initreq [read]

Joint Non codec capability

Definition at line 965 of file chan_sip.c.

Referenced by add_sdp(), check_user_full(), create_addr_from_peer(), process_sdp(), sip_call(), and sip_dtmfmode().

char lastmsg[256]

Last Message sent/received

Definition at line 991 of file chan_sip.c.

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

Last Cseq of non-invite

Definition at line 955 of file chan_sip.c.

Referenced by handle_request(), and transmit_notify_with_sipfrag().

time_t lastrtprx

Last RTP received

Definition at line 981 of file chan_sip.c.

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

time_t lastrtptx

int laststate

SUBSCRIBE: Last known extension state

Definition at line 1005 of file chan_sip.c.

Referenced by __sip_show_channels(), cb_extensionstate(), handle_request_subscribe(), and handle_response().

Maximum Call Bitrate for Video Calls

Definition at line 967 of file chan_sip.c.

Referenced by add_sdp(), check_user_full(), create_addr_from_peer(), sip_alloc(), and sip_show_channel().

int maxtime

Max time for first response

Definition at line 997 of file chan_sip.c.

Referenced by create_addr_from_peer(), and sip_call().

int method

struct sip_pvt* next [read]

Nonce-count

Definition at line 990 of file chan_sip.c.

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

DTMF RFC2833 telephony-event

Definition at line 964 of file chan_sip.c.

Referenced by check_user_full(), create_addr_from_peer(), process_sdp(), sip_alloc(), sip_call(), and sip_show_channel().

unsigned int ocseq

struct sip_invite_param* options [read]

struct in_addr ourip [read]

struct ast_channel* owner [read]

struct sip_pkt* packets [read]

Packets scheduled for re-transmission

Definition at line 1015 of file chan_sip.c.

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

struct sip_auth* peerauth [read]

Realm authentication

Definition at line 989 of file chan_sip.c.

Supported peer capability

Definition at line 962 of file chan_sip.c.

Referenced by check_user_full(), process_sdp(), sip_get_codec(), and sip_show_channel().

Pickup group

Definition at line 953 of file chan_sip.c.

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

int prefcodec

Preferred codec (outbound only)

Definition at line 963 of file chan_sip.c.

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

struct ast_codec_pref prefs [read]

struct sockaddr_in recv [read]

Redirect codecs

Definition at line 966 of file chan_sip.c.

Referenced by sip_set_rtp_peer().

struct sockaddr_in redirip [read]

Where our RTP should be going if not to us

Definition at line 979 of file chan_sip.c.

Referenced by add_sdp(), sip_set_rtp_peer(), and sip_show_channel().

struct sip_refer* refer [read]

struct sip_registry* registry [read]

If this is a REGISTER dialog, to which registry

Definition at line 1012 of file chan_sip.c.

Referenced by __sip_destroy(), do_register_auth(), handle_response(), handle_response_register(), reply_digest(), sip_reg_timeout(), sip_registry_destroy(), and transmit_register().

struct sip_peer* relatedpeer [read]

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

Definition at line 1010 of file chan_sip.c.

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

struct sip_route* route [read]

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

Definition at line 987 of file chan_sip.c.

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

Is this the "real" route?

Definition at line 988 of file chan_sip.c.

Referenced by build_route().

struct ast_rtp* rtp [read]

RTP timeout time

Definition at line 983 of file chan_sip.c.

Referenced by create_addr_from_peer().

struct sockaddr_in sa [read]

int sessionid

SDP Session ID

Definition at line 976 of file chan_sip.c.

Referenced by add_sdp(), and add_t38_sdp().

SDP Session Version

Definition at line 977 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 958 of file chan_sip.c.

Referenced by check_user_full(), handle_request_invite(), parse_register_contact(), parse_sip_options(), and sip_show_channel().

int stateid

SUBSCRIBE: ID for devicestate subscriptions

Definition at line 1004 of file chan_sip.c.

Referenced by __sip_destroy(), cb_extensionstate(), handle_request_subscribe(), and sip_alloc().

struct t38properties t38 [read]

char tag[11]

int timer_t1

SIP timer T1, ms rtt

Definition at line 957 of file chan_sip.c.

Referenced by __sip_reliable_xmit(), check_user_full(), create_addr(), create_addr_from_peer(), sip_alloc(), and sip_scheddestroy().

struct ast_udptl* udptl [read]

struct sockaddr_in udptlredirip [read]

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

Definition at line 969 of file chan_sip.c.

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

struct ast_dsp* vad [read]

Voice Activation Detection dsp

Definition at line 1008 of file chan_sip.c.

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

struct sockaddr_in vredirip [read]

Where our Video RTP should be going if not to us

Definition at line 980 of file chan_sip.c.

Referenced by add_sdp(), and sip_set_rtp_peer().

struct ast_rtp* vrtp [read]

int waitid

Wait ID for scheduler after 491 or other delays

Definition at line 999 of file chan_sip.c.

Referenced by __sip_destroy(), check_pendings(), handle_response_invite(), sip_alloc(), sip_hangup(), and sip_reinvite_retry().


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

Generated on Tue Sep 30 01:20:08 2008 for Asterisk - the Open Source PBX by  doxygen 1.5.6