Wed Oct 28 15:49:51 2009

Asterisk developer's documentation


sip_pvt Struct Reference

sip_pvt: PVT structures are used for each SIP conversation, ie. a call More...

Collaboration diagram for sip_pvt:

Collaboration graph
[legend]

Data Fields

char accountcode [AST_MAX_ACCOUNT_CODE]
int amaflags
char authname [256]
int authtries
int autokillid
int branch
ast_group_t callgroup
char callid [128]
int callingpres
int capability
struct ast_variablechanvars
char cid_name [256]
char cid_num [256]
char context [AST_MAX_CONTEXT]
int dialogver
char domain [MAXHOSTNAMELEN]
int expiry
char exten [AST_MAX_EXTENSION]
unsigned int flags
char from [256]
char fromdomain [MAXHOSTNAMELEN]
char fromname [AST_MAX_EXTENSION]
char fromuser [AST_MAX_EXTENSION]
char fullcontact [SIP_LEN_CONTACT]
struct sip_historyhistory
unsigned int icseq
int initid
struct sip_request initreq
int jointcapability
int jointnoncodeccapability
char language [MAX_LANGUAGE]
int lastinvite
char lastmsg [256]
time_t lastrtprx
time_t lastrtptx
int laststate
ast_mutex_t lock
int maxtime
int method
char musicclass [MAX_MUSICCLASS]
struct sip_pvtnext
char nonce [256]
int noncecount
int noncodeccapability
unsigned int ocseq
char okcontacturi [SIP_LEN_CONTACT]
char opaque [256]
struct sip_invite_paramoptions
char our_contact [SIP_LEN_CONTACT]
struct in_addr ourip
struct ast_channelowner
struct sip_pktpackets
struct sip_authpeerauth
int peercapability
char peermd5secret [256]
char peername [256]
struct sip_peerpeerpoke
char peersecret [256]
int pendinginvite
ast_group_t pickupgroup
int prefcodec
struct ast_codec_pref prefs
char qop [80]
char randdata [80]
char rdnis [256]
char realm [MAXHOSTNAMELEN]
struct sockaddr_in recv
int redircodecs
struct sockaddr_in redirip
struct sip_pvtrefer_call
char refer_contact [SIP_LEN_CONTACT]
char refer_to [AST_MAX_EXTENSION]
char referred_by [AST_MAX_EXTENSION]
struct sip_registryregistry
struct sip_routeroute
int route_persistant
char * rpid
char * rpid_from
struct ast_rtprtp
int rtpholdtimeout
int rtpkeepalive
int rtptimeout
struct sockaddr_in sa
int sessionid
int sessionversion
unsigned int sipoptions
int stateid
char subscribecontext [AST_MAX_CONTEXT]
enum subscriptiontype subscribed
char tag [11]
char theirtag [256]
int timer_t1
char tohost [MAXHOSTNAMELEN]
char uri [256]
char useragent [256]
char username [256]
struct ast_dspvad
char via [256]
struct sockaddr_in vredirip
struct ast_rtpvrtp

Detailed Description

sip_pvt: PVT structures are used for each SIP conversation, ie. a call

Definition at line 592 of file chan_sip.c.


Field Documentation

char accountcode[AST_MAX_ACCOUNT_CODE]

Account code

Definition at line 657 of file chan_sip.c.

Referenced by check_user_full().

int amaflags

AMA Flags

Definition at line 668 of file chan_sip.c.

Referenced by check_user_full().

char authname[256]

Who we use for authentication

Definition at line 647 of file chan_sip.c.

Referenced by build_reply_digest(), check_user_full(), create_addr_from_peer(), handle_response(), and transmit_register().

int authtries

Times we've tried to authenticate

Definition at line 613 of file chan_sip.c.

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

int branch

One random number

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

Referenced by check_user_full(), and create_addr_from_peer().

char callid[128]

Calling presentation

Definition at line 612 of file chan_sip.c.

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

struct ast_variable* chanvars [read]

Channel variables to set for call

Definition at line 698 of file chan_sip.c.

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

char cid_name[256]

Caller*ID

Definition at line 654 of file chan_sip.c.

Referenced by check_user_full().

char cid_num[256]

Caller*ID

Definition at line 653 of file chan_sip.c.

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

char context[AST_MAX_CONTEXT]

int dialogver

Definition at line 688 of file chan_sip.c.

Referenced by handle_request_subscribe(), and transmit_state_notify().

char domain[MAXHOSTNAMELEN]

Authorization domain

Definition at line 666 of file chan_sip.c.

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

int expiry

How long we take to expire

Definition at line 614 of file chan_sip.c.

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

char exten[AST_MAX_EXTENSION]

unsigned int flags

SIP_ flags

Definition at line 603 of file chan_sip.c.

char from[256]

The From: header

Definition at line 633 of file chan_sip.c.

Referenced by check_user_full(), function_sipchaninfo_read(), and transmit_refer().

char fromdomain[MAXHOSTNAMELEN]

char fromname[AST_MAX_EXTENSION]

Name to show in the user field

Definition at line 639 of file chan_sip.c.

Referenced by initreqprep().

char fromuser[AST_MAX_EXTENSION]

User to show in the user field

Definition at line 638 of file chan_sip.c.

Referenced by build_rpid(), create_addr_from_peer(), initreqprep(), and transmit_register().

char fullcontact[SIP_LEN_CONTACT]

The Contact: that the UA registers with us

Definition at line 656 of file chan_sip.c.

Referenced by check_user_full(), create_addr_from_peer(), initreqprep(), parse_ok_contact(), sip_poke_peer(), and sip_request_call().

struct sip_history* history [read]

History of this SIP dialog

Definition at line 697 of file chan_sip.c.

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

unsigned int icseq

Current incoming seqno

Definition at line 599 of file chan_sip.c.

Referenced by __sip_show_channels(), and handle_request().

int initid

Auto-congest ID if appropriate

Definition at line 678 of file chan_sip.c.

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

struct sip_request initreq [read]

Supported capability at both ends (codecs )

Definition at line 607 of file chan_sip.c.

Referenced by add_sdp(), check_user_full(), handle_request_invite(), process_sdp(), sip_call(), sip_new(), sip_rtp_read(), sip_show_channel(), and try_suggested_sip_codec().

Definition at line 611 of file chan_sip.c.

Referenced by add_sdp(), check_user_full(), process_sdp(), sip_alloc(), and sip_call().

char language[MAX_LANGUAGE]

Default language for this call

Definition at line 641 of file chan_sip.c.

Referenced by check_user_full(), and create_addr_from_peer().

char lastmsg[256]

Last Message sent/received

Definition at line 667 of file chan_sip.c.

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

time_t lastrtprx

Last RTP received

Definition at line 680 of file chan_sip.c.

Referenced by add_sdp(), do_monitor(), process_sdp(), sip_read(), and sip_set_rtp_peer().

time_t lastrtptx

Last RTP sent

Definition at line 681 of file chan_sip.c.

Referenced by add_sdp(), do_monitor(), process_sdp(), sip_set_rtp_peer(), and sip_write().

int laststate

Last known extension state

Definition at line 687 of file chan_sip.c.

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

int maxtime

Max time for first response

Definition at line 677 of file chan_sip.c.

Referenced by create_addr_from_peer(), and sip_call().

int method

SIP method of this packet

Definition at line 594 of file chan_sip.c.

Referenced by handle_request(), respprep(), sip_alloc(), and transmit_response_using_temp().

char musicclass[MAX_MUSICCLASS]

Music on Hold class

Definition at line 642 of file chan_sip.c.

Referenced by check_user_full(), and sip_alloc().

struct sip_pvt* next [read]

char nonce[256]

Authorization nonce

Definition at line 662 of file chan_sip.c.

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

Nonce-count

Definition at line 663 of file chan_sip.c.

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

unsigned int ocseq

char okcontacturi[SIP_LEN_CONTACT]

URI from the 200 OK on INVITE

Definition at line 649 of file chan_sip.c.

Referenced by parse_ok_contact(), and reqprep().

char opaque[256]

Opaque nonsense

Definition at line 664 of file chan_sip.c.

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

struct sip_invite_param* options [read]

char our_contact[SIP_LEN_CONTACT]

struct in_addr ourip [read]

struct ast_channel* owner [read]

struct sip_pkt* packets [read]

Packets scheduled for re-transmission

Definition at line 696 of file chan_sip.c.

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

struct sip_auth* peerauth [read]

Realm authentication

Definition at line 652 of file chan_sip.c.

Supported peer capability

Definition at line 608 of file chan_sip.c.

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

char peermd5secret[256]

char peername[256]

struct sip_peer* peerpoke [read]

If this calls is to poke a peer, which one

Definition at line 692 of file chan_sip.c.

Referenced by handle_response(), handle_response_peerpoke(), and sip_poke_peer().

char peersecret[256]

Password

Definition at line 650 of file chan_sip.c.

Referenced by build_reply_digest(), check_user_full(), create_addr_from_peer(), and transmit_register().

Pickup group

Definition at line 601 of file chan_sip.c.

Referenced by check_user_full(), and create_addr_from_peer().

int prefcodec

Preferred codec (outbound only)

Definition at line 609 of file chan_sip.c.

Referenced by add_sdp(), and sip_request_call().

struct ast_codec_pref prefs [read]

codec prefs

Definition at line 597 of file chan_sip.c.

Referenced by add_sdp(), check_user_full(), create_addr_from_peer(), process_sdp(), sip_alloc(), and sip_new().

char qop[80]

Quality of Protection, since SIP wasn't complicated enough yet.

Definition at line 665 of file chan_sip.c.

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

char randdata[80]

char rdnis[256]

Referring DNIS

Definition at line 643 of file chan_sip.c.

Referenced by get_rdnis().

char realm[MAXHOSTNAMELEN]

Authorization realm

Definition at line 661 of file chan_sip.c.

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

struct sockaddr_in recv [read]

Redirect codecs

Definition at line 622 of file chan_sip.c.

Referenced by add_sdp(), and sip_set_rtp_peer().

struct sockaddr_in redirip [read]

Where our RTP should be going if not to us

Definition at line 620 of file chan_sip.c.

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

struct sip_pvt* refer_call [read]

Call we are referring

Definition at line 630 of file chan_sip.c.

Referenced by get_also_info(), get_refer_info(), and handle_request_refer().

char refer_contact[SIP_LEN_CONTACT]

Place to store Contact info from a REFER extension

Definition at line 629 of file chan_sip.c.

Referenced by get_also_info(), and get_refer_info().

char refer_to[AST_MAX_EXTENSION]

Place to store REFER-TO extension

Definition at line 627 of file chan_sip.c.

Referenced by get_also_info(), get_refer_info(), handle_request_bye(), handle_request_refer(), transmit_invite(), and transmit_refer().

char referred_by[AST_MAX_EXTENSION]

Place to store REFERRED-BY extension

Definition at line 628 of file chan_sip.c.

Referenced by get_also_info(), get_refer_info(), transmit_invite(), and transmit_refer().

struct sip_registry* registry [read]

If this is a REGISTER call, to which registry

Definition at line 693 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_route* route [read]

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

Definition at line 631 of file chan_sip.c.

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

Is this the "real" route?

Definition at line 632 of file chan_sip.c.

Referenced by build_route().

char* rpid

Our RPID header

Definition at line 659 of file chan_sip.c.

Referenced by __sip_destroy(), build_rpid(), initreqprep(), and reqprep().

char* rpid_from

Our RPID From header

Definition at line 660 of file chan_sip.c.

Referenced by __sip_destroy(), build_rpid(), and initreqprep().

struct ast_rtp* rtp [read]

RTP timeout when on hold

Definition at line 683 of file chan_sip.c.

Referenced by create_addr_from_peer(), do_monitor(), and sip_alloc().

Send RTP packets for keepalive

Definition at line 684 of file chan_sip.c.

Referenced by create_addr_from_peer(), do_monitor(), and sip_alloc().

RTP timeout time

Definition at line 682 of file chan_sip.c.

Referenced by create_addr_from_peer(), do_monitor(), and sip_alloc().

struct sockaddr_in sa [read]

int sessionid

SDP Session ID

Definition at line 617 of file chan_sip.c.

Referenced by add_sdp().

SDP Session Version

Definition at line 618 of file chan_sip.c.

Referenced by add_sdp().

unsigned int sipoptions

Supported SIP sipoptions on the other end

Definition at line 605 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

Definition at line 686 of file chan_sip.c.

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

char subscribecontext[AST_MAX_CONTEXT]

Subscribecontext

Definition at line 636 of file chan_sip.c.

Referenced by check_user_full(), and handle_request_subscribe().

char tag[11]

char theirtag[256]

int timer_t1

SIP timer T1, ms rtt

Definition at line 604 of file chan_sip.c.

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

char tohost[MAXHOSTNAMELEN]

Host we should put in the "to" field

Definition at line 640 of file chan_sip.c.

Referenced by create_addr(), create_addr_from_peer(), initreqprep(), sip_poke_peer(), and transmit_register().

char uri[256]

char useragent[256]

User agent in SIP request

Definition at line 634 of file chan_sip.c.

Referenced by function_sipchaninfo_read(), handle_request(), handle_request_subscribe(), and sip_show_channel().

char username[256]

struct ast_dsp* vad [read]

Voice Activation Detection dsp

Definition at line 690 of file chan_sip.c.

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

char via[256]

struct sockaddr_in vredirip [read]

Where our Video RTP should be going if not to us

Definition at line 621 of file chan_sip.c.

Referenced by add_sdp(), and sip_set_rtp_peer().

struct ast_rtp* vrtp [read]


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

Generated on Wed Oct 28 15:49:51 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6