resip::InviteSession Class Reference

Base class for class ClientInviteSession and class ServerInviteSession. More...

#include <InviteSession.hxx>

Inheritance diagram for resip::InviteSession:

Classes
class	QueuedNIT

Public Types
enum	OfferAnswerType { None , Offer , Answer }
enum	EndReason {   NotSpecified =0 , UserHangup , AppRejectedSdp , IllegalNegotiation ,   AckNotReceived , SessionExpired , StaleReInvite , ENDREASON_MAX ,   UserSpecified }
Public Types inherited from resip::Handled
enum	{ npos = 0 }
typedef unsigned long	Id

Public Member Functions
	InviteSession (const InviteSession &)=delete
	InviteSession (InviteSession &&)=delete
InviteSession &	operator= (const InviteSession &)=delete
InviteSession &	operator= (InviteSession &&)=delete
virtual void	provideOffer (const Contents &offer)
	Called to set the offer that will be used in the next message that sends an offer.
virtual void	provideOffer (const Contents &offer, DialogUsageManager::EncryptionLevel level, const Contents *alternative)
virtual void	provideAnswer (const Contents &answer)
	Similar to provideOffer - called to set the answer to be signaled to the peer.
virtual void	requestOffer ()
	Called to request that the far end provide an offer.
virtual void	end (const Data &userReason)
	Makes the specific dialog end.
virtual void	end (const ParserContainer< Token > &endReasons)
virtual void	end (EndReason reason)
virtual void	end () override
virtual void	reject (int statusCode, WarningCategory *warning=0)
	Rejects an offer at the SIP level.
virtual void	reject (int statusCode, const Contents *contents, WarningCategory *warning=0)
virtual void	targetRefresh (const NameAddr &localUri)
	will send a reINVITE (current offerAnswer) or UPDATE with new Contact header
virtual void	refer (const NameAddr &referTo, bool referSub=true)
	sends a refer request
virtual void	refer (const NameAddr &referTo, const NameAddr &referredBy, bool referSub=true)
virtual void	refer (const NameAddr &referTo, std::unique_ptr< resip::Contents > contents, bool referSub=true)
virtual void	refer (const NameAddr &referTo, const NameAddr &referredBy, std::unique_ptr< resip::Contents > contents, bool referSub=true)
virtual void	refer (const NameAddr &referTo, InviteSessionHandle sessionToReplace, bool referSub=true)
	sends a refer request with a replaces header
virtual void	refer (const NameAddr &referTo, InviteSessionHandle sessionToReplace, std::unique_ptr< resip::Contents > contents, bool referSub=true)
virtual void	refer (const NameAddr &referTo, const CallId &replaces, bool referSub=true)
virtual void	refer (const NameAddr &referTo, const CallId &replaces, std::unique_ptr< resip::Contents > contents, bool referSub=true)
virtual void	info (const Contents &contents)
	sends an info request
virtual void	message (const Contents &contents)
	sends a message request
virtual void	acceptNIT (int statusCode=200, const Contents *contents=0)
	accepts an INFO or MESSAGE request with a 2xx and an optional contents
virtual void	rejectNIT (int statusCode=488)
	rejects an INFO or MESSAGE request with an error status code
std::shared_ptr< SipMessage >	getLastSentNITRequest () const
	gets the last NIT request that was sent by the session
virtual void	provideOfferCommand (const Contents &offer)
	Provide asynchronous method access by using command.
virtual void	provideOfferCommand (const Contents &offer, DialogUsageManager::EncryptionLevel level, const Contents *alternative)
virtual void	provideAnswerCommand (const Contents &answer)
virtual void	endCommand (EndReason reason=NotSpecified)
	Asynchronously makes the specific dialog end.
virtual void	endCommand (const Data &userReason)
virtual void	endCommand (const resip::ParserContainer< resip::Token > &endReasons)
virtual void	rejectCommand (int statusCode, WarningCategory *warning=0)
	Asynchronously rejects an offer at the SIP level.
virtual void	rejectCommand (int statusCode, const Contents *contents, WarningCategory *warning=0)
virtual void	referCommand (const NameAddr &referTo, bool referSub=true)
virtual void	referCommand (const NameAddr &referTo, InviteSessionHandle sessionToReplace, bool referSub=true)
virtual void	infoCommand (const Contents &contents)
virtual void	messageCommand (const Contents &contents)
virtual void	acceptNITCommand (int statusCode=200, const Contents *contents=0)
	Asynchronously accepts an INFO or MESSAGE request with a 2xx and an optional contents.
virtual void	rejectNITCommand (int statusCode=488)
	Asynchronously rejects an INFO or MESSAGE request with an error status code.
virtual void	acceptReferNoSub (int statusCode=200)
virtual void	rejectReferNoSub (int responseCode)
bool	hasLocalOfferAnswer () const
const Contents &	getLocalOfferAnswer () const
bool	hasRemoteOfferAnswer () const
const Contents &	getRemoteOfferAnswer () const
bool	hasProposedRemoteOfferAnswer () const
const Contents &	getProposedRemoteOfferAnswer () const
bool	hasLocalSdp () const
const SdpContents &	getLocalSdp () const
bool	hasRemoteSdp () const
const SdpContents &	getRemoteSdp () const
bool	hasProposedRemoteSdp () const
const SdpContents &	getProposedRemoteSdp () const
bool	isConnected () const
bool	isSessionModificationInFlight () const
bool	isTerminated () const
bool	isEarly () const
bool	isAccepted () const
Tokens &	getPeerSupportedMethods ()
Tokens &	getPeerSupportedOptionTags ()
Tokens &	getPeerRequiresOptionsTags ()
Mimes &	getPeerSupportedMimeTypes ()
Tokens &	getPeerSupportedEncodings ()
Tokens &	getPeerSupportedLanguages ()
Tokens &	getPeerAllowedEvents ()
Data &	getPeerUserAgent ()
NameAddrs &	getPeerPAssertedIdentities ()
EncodeStream &	dump (EncodeStream &strm) const override
InviteSessionHandle	getSessionHandle ()
Public Member Functions inherited from resip::DialogUsage
AppDialogSetHandle	getAppDialogSet () const
AppDialogHandle	getAppDialog () const
const NameAddr &	myAddr () const noexcept
const NameAddr &	peerAddr () const noexcept
const NameAddr &	remoteTarget () const noexcept
const NameAddr &	pendingRemoteTarget () const
const NameAddrs &	getRouteSet () const noexcept
const DialogId &	getDialogId () const
const Data &	getCallId () const
std::shared_ptr< UserProfile >	getUserProfile () const
Public Member Functions inherited from resip::BaseUsage
virtual void	postDum (Message *messageForDum)
	posts a message on dum
Public Member Functions inherited from resip::Handled
	Handled (HandleManager &ham)
virtual	~Handled ()

Protected Types
enum	State {   Undefined , Connected , SentUpdate , SentUpdateGlare ,   SentReinvite , SentReinviteGlare , SentReinviteNoOffer , SentReinviteAnswered ,   SentReinviteNoOfferGlare , SentOptions , SentOptionsGlare , ReceivedUpdate ,   ReceivedReinvite , ReceivedReinviteNoOffer , ReceivedReinviteSentOffer , Answered ,   WaitingToOffer , WaitingToRequestOffer , WaitingToTerminate , WaitingToHangup ,   Terminated , UAC_Start , UAC_Early , UAC_EarlyWithOffer ,   UAC_EarlyWithAnswer , UAC_Answered , UAC_SentUpdateEarly , UAC_SentUpdateEarlyGlare ,   UAC_ReceivedUpdateEarly , UAC_SentAnswer , UAC_QueuedUpdate , UAC_Cancelled ,   UAS_Start , UAS_Offer , UAS_OfferProvidedAnswer , UAS_EarlyOffer ,   UAS_EarlyProvidedAnswer , UAS_NoOffer , UAS_ProvidedOffer , UAS_EarlyNoOffer ,   UAS_EarlyProvidedOffer , UAS_Accepted , UAS_WaitingToOffer , UAS_WaitingToRequestOffer ,   UAS_AcceptedWaitingAnswer , UAS_OfferReliable , UAS_OfferReliableProvidedAnswer , UAS_NoOfferReliable ,   UAS_ProvidedOfferReliable , UAS_FirstSentOfferReliable , UAS_FirstSentAnswerReliable , UAS_NoAnswerReliableWaitingPrack ,   UAS_NegotiatedReliable , UAS_NoAnswerReliable , UAS_SentUpdate , UAS_SentUpdateAccepted ,   UAS_SentUpdateGlare , UAS_ReceivedUpdate , UAS_ReceivedUpdateWaitingAnswer , UAS_WaitingToHangup }
enum	Event {   OnRedirect , OnGeneralFailure , OnInvite , OnInviteOffer ,   OnInviteReliableOffer , OnInviteReliable , OnCancel , OnBye ,   On200Bye , On1xx , On1xxEarly , On1xxOffer ,   On1xxAnswer , On2xx , On2xxOffer , On2xxAnswer ,   On422Invite , On487Invite , On491Invite , OnInviteFailure ,   OnAck , OnAckAnswer , On200Cancel , OnCancelFailure ,   OnUpdate , OnUpdateOffer , OnUpdateRejected , On422Update ,   On491Update , On200Update , OnPrack , On200Prack ,   OnOptions , On200Options , On491Options , Unknown }
enum	NitState { NitComplete , NitProceeding }
typedef HashMap< Data, std::shared_ptr< SipMessage > >	AckMap

Protected Member Functions
	InviteSession (DialogUsageManager &dum, Dialog &dialog)
virtual	~InviteSession ()
virtual void	onReadyToSend (SipMessage &msg) override
virtual void	flowTerminated ()
void	dispatch (const SipMessage &msg) override
void	dispatch (const DumTimeout &timer) override
void	dispatchConnected (const SipMessage &msg)
void	dispatchSentUpdate (const SipMessage &msg)
void	dispatchSentReinvite (const SipMessage &msg)
void	dispatchSentReinviteNoOffer (const SipMessage &msg)
void	dispatchSentReinviteAnswered (const SipMessage &msg)
void	dispatchGlare (const SipMessage &msg)
void	dispatchSentOptions (const SipMessage &msg)
void	dispatchReinviteNoOfferGlare (const SipMessage &msg)
void	dispatchReceivedUpdateOrReinvite (const SipMessage &msg)
void	dispatchReceivedReinviteSentOffer (const SipMessage &msg)
void	dispatchAnswered (const SipMessage &msg)
void	dispatchWaitingToOffer (const SipMessage &msg)
void	dispatchWaitingToRequestOffer (const SipMessage &msg)
void	dispatchWaitingToTerminate (const SipMessage &msg)
void	dispatchWaitingToHangup (const SipMessage &msg)
void	dispatchTerminated (const SipMessage &msg)
void	dispatchBye (const SipMessage &msg)
void	dispatchInfo (const SipMessage &msg)
void	dispatchMessage (const SipMessage &msg)
void	dispatchOptions (const SipMessage &msg)
bool	isAckForCurrent200 (const SipMessage &ack) const
void	startRetransmit200Timer ()
void	start491Timer ()
void	startStaleReInviteTimer ()
void	setSessionTimerHeaders (SipMessage &msg)
void	sessionRefresh ()
void	checkDeferredSessionExpiration ()
bool	expireSessionAfterFailedModification ()
void	setSessionTimerPreferences ()
void	startSessionTimer ()
void	handleSessionTimerResponse (const SipMessage &msg)
void	handleSessionTimerRequest (SipMessage &response, const SipMessage &request)
void	transition (State target)
std::unique_ptr< Contents >	getOfferAnswer (const SipMessage &msg)
bool	isReliable (const SipMessage &msg) const
void	provideProposedOffer ()
void	storePeerCapabilities (const SipMessage &msg)
bool	updateMethodSupported () const
bool	sessionTimerSupportedLocalAndPeer () const
std::shared_ptr< SipMessage >	sendAck (const Contents *answer=0)
std::shared_ptr< SipMessage >	sendBye ()
const Data &	getEndReasonString (InviteSession::EndReason reason)
DialogUsageManager::EncryptionLevel	getEncryptionLevel (const SipMessage &msg)
void	setCurrentLocalOfferAnswer (const SipMessage &msg)
void	referNoSub (const SipMessage &msg)
Event	toEvent (const SipMessage &msg, const Contents *offeranswer)
void	nitComplete ()
Protected Member Functions inherited from resip::DialogUsage
virtual void	send (std::shared_ptr< SipMessage > msg)
virtual void	sendCommand (std::shared_ptr< SipMessage > msg)
	DialogUsage (DialogUsageManager &dum, Dialog &dialog)
virtual	~DialogUsage ()
Protected Member Functions inherited from resip::BaseUsage
	BaseUsage (DialogUsageManager &dum)
virtual	~BaseUsage ()
BaseUsageHandle	getBaseHandle () const

Static Protected Member Functions
static Data	toData (State state)
static std::unique_ptr< Contents >	makeOfferAnswer (const Contents &offerAnswer)
static std::unique_ptr< Contents >	makeOfferAnswer (const Contents &offerAnswer, const Contents *alternative)
static void	setOfferAnswer (SipMessage &msg, const Contents &offerAnswer, const Contents *alternative=0)
static void	setOfferAnswer (SipMessage &msg, const Contents *offerAnswer)

Protected Attributes
Tokens	mPeerSupportedMethods
Tokens	mPeerSupportedOptionTags
Tokens	mPeerRequiresOptionTags
Mimes	mPeerSupportedMimeTypes
Tokens	mPeerSupportedEncodings
Tokens	mPeerSupportedLanguages
Tokens	mPeerAllowedEvents
Data	mPeerUserAgent
NameAddrs	mPeerPAssertedIdentities
bool	mPeerSupportsSessionTimer
State	mState
NitState	mNitState
NitState	mServerNitState
std::unique_ptr< Contents >	mCurrentLocalOfferAnswer
std::unique_ptr< Contents >	mProposedLocalOfferAnswer
std::unique_ptr< Contents >	mCurrentRemoteOfferAnswer
std::unique_ptr< Contents >	mProposedRemoteOfferAnswer
std::shared_ptr< SipMessage >	mLastLocalSessionModification
std::shared_ptr< SipMessage >	mLastRemoteSessionModification
std::shared_ptr< SipMessage >	mInvite200
std::shared_ptr< SipMessage >	mLastNitResponse
SipMessage	mLastReferNoSubRequest
unsigned long	mCurrentRetransmit200
unsigned int	mStaleReInviteTimerSeq
uint32_t	mSessionInterval
uint32_t	mMinSE
bool	mSessionRefresher
unsigned int	mSessionRefreshTimerSeq
unsigned int	mSessionExpirationTimerSeq
bool	mSessionRefreshReInvite
bool	mSessionExpirationPending
std::queue< QueuedNIT * >	mNITQueue
bool	mReferSub
std::shared_ptr< SipMessage >	mLastSentNITRequest
DialogUsageManager::EncryptionLevel	mCurrentEncryptionLevel
DialogUsageManager::EncryptionLevel	mProposedEncryptionLevel
EndReason	mEndReason
Data	mUserEndReason
ParserContainer< Token >	mUserEndReasons
AckMap	mAcks
Protected Attributes inherited from resip::DialogUsage
Dialog &	mDialog
Protected Attributes inherited from resip::BaseUsage
DialogUsageManager &	mDum
Protected Attributes inherited from resip::Handled
HandleManager &	mHam
Handled::Id	mId

Friends
class	Dialog
class	DialogUsageManager

Detailed Description

Base class for class ClientInviteSession and class ServerInviteSession.

Implements common attributes and behavior (i.e.t post connected) of the two classes.

Definition at line 24 of file InviteSession.hxx.

Member Typedef Documentation

AckMap

typedef HashMap<Data, std::shared_ptr<SipMessage> > resip::InviteSession::AckMap

protected

Definition at line 449 of file InviteSession.hxx.

Member Enumeration Documentation

EndReason

enum resip::InviteSession::EndReason

Enumerator
NotSpecified
UserHangup
AppRejectedSdp
IllegalNegotiation
AckNotReceived
SessionExpired
StaleReInvite
ENDREASON_MAX
UserSpecified

Definition at line 58 of file InviteSession.hxx.

Event

enum resip::InviteSession::Event

protected

Enumerator
OnRedirect
OnGeneralFailure
OnInvite
OnInviteOffer
OnInviteReliableOffer
OnInviteReliable
OnCancel
OnBye
On200Bye
On1xx
On1xxEarly
On1xxOffer
On1xxAnswer
On2xx
On2xxOffer
On2xxAnswer
On422Invite
On487Invite
On491Invite
OnInviteFailure
OnAck
OnAckAnswer
On200Cancel
OnCancelFailure
OnUpdate
OnUpdateOffer
OnUpdateRejected
On422Update
On491Update
On200Update
OnPrack
On200Prack
OnOptions
On200Options
On491Options
Unknown

Definition at line 261 of file InviteSession.hxx.

NitState

enum resip::InviteSession::NitState

protected

Enumerator
NitComplete
NitProceeding

Definition at line 301 of file InviteSession.hxx.

OfferAnswerType

enum resip::InviteSession::OfferAnswerType

Enumerator
None
Offer
Answer

Definition at line 49 of file InviteSession.hxx.

State

enum resip::InviteSession::State

protected

Enumerator
Undefined
Connected
SentUpdate
SentUpdateGlare
SentReinvite
SentReinviteGlare
SentReinviteNoOffer
SentReinviteAnswered
SentReinviteNoOfferGlare
SentOptions
SentOptionsGlare
ReceivedUpdate
ReceivedReinvite
ReceivedReinviteNoOffer
ReceivedReinviteSentOffer
Answered
WaitingToOffer
WaitingToRequestOffer
WaitingToTerminate
WaitingToHangup
Terminated
UAC_Start
UAC_Early
UAC_EarlyWithOffer
UAC_EarlyWithAnswer
UAC_Answered
UAC_SentUpdateEarly
UAC_SentUpdateEarlyGlare
UAC_ReceivedUpdateEarly
UAC_SentAnswer
UAC_QueuedUpdate
UAC_Cancelled
UAS_Start
UAS_Offer
UAS_OfferProvidedAnswer
UAS_EarlyOffer
UAS_EarlyProvidedAnswer
UAS_NoOffer
UAS_ProvidedOffer
UAS_EarlyNoOffer
UAS_EarlyProvidedOffer
UAS_Accepted
UAS_WaitingToOffer
UAS_WaitingToRequestOffer
UAS_AcceptedWaitingAnswer
UAS_OfferReliable
UAS_OfferReliableProvidedAnswer
UAS_NoOfferReliable
UAS_ProvidedOfferReliable
UAS_FirstSentOfferReliable
UAS_FirstSentAnswerReliable
UAS_NoAnswerReliableWaitingPrack
UAS_NegotiatedReliable
UAS_NoAnswerReliable
UAS_SentUpdate
UAS_SentUpdateAccepted
UAS_SentUpdateGlare
UAS_ReceivedUpdate
UAS_ReceivedUpdateWaitingAnswer
UAS_WaitingToHangup

Definition at line 191 of file InviteSession.hxx.

Constructor & Destructor Documentation

InviteSession() [1/3]

resip::InviteSession::InviteSession ( const InviteSession &  )

delete

InviteSession() [2/3]

resip::InviteSession::InviteSession ( InviteSession &&  )

delete

InviteSession() [3/3]

InviteSession::InviteSession ( DialogUsageManager &  dum, Dialog &  dialog  )

protected

Definition at line 67 of file InviteSession.cxx.

~InviteSession()

InviteSession::~InviteSession ( )

protectedvirtual

Definition at line 95 of file InviteSession.cxx.

Member Function Documentation

acceptNIT()

void InviteSession::acceptNIT ( int  statusCode = 200, const Contents *  contents = 0  )

virtual

accepts an INFO or MESSAGE request with a 2xx and an optional contents

Definition at line 2579 of file InviteSession.cxx.

acceptNITCommand()

void InviteSession::acceptNITCommand ( int  statusCode = 200, const Contents *  contents = 0  )

virtual

Asynchronously accepts an INFO or MESSAGE request with a 2xx and an optional contents.

Definition at line 2628 of file InviteSession.cxx.

acceptReferNoSub()

void InviteSession::acceptReferNoSub ( int  statusCode = 200 )

virtual

Definition at line 3694 of file InviteSession.cxx.

checkDeferredSessionExpiration()

void InviteSession::checkDeferredSessionExpiration ( )

protected

Definition at line 2904 of file InviteSession.cxx.

dispatch() [1/2]

void InviteSession::dispatch ( const DumTimeout &  timer )

overrideprotectedvirtual

dcm! – should this be onIllegalNegotiation?

Implements resip::BaseUsage.

Definition at line 1405 of file InviteSession.cxx.

dispatch() [2/2]

void InviteSession::dispatch ( const SipMessage &  msg )

overrideprotectedvirtual

Implements resip::BaseUsage.

Definition at line 1326 of file InviteSession.cxx.

dispatchAnswered()

void InviteSession::dispatchAnswered ( const SipMessage &  msg )

protected

Definition at line 2218 of file InviteSession.cxx.

dispatchBye()

void InviteSession::dispatchBye ( const SipMessage &  msg )

protected

Definition at line 2498 of file InviteSession.cxx.

dispatchConnected()

void InviteSession::dispatchConnected ( const SipMessage &  msg )

protected

Definition at line 1601 of file InviteSession.cxx.

dispatchGlare()

void InviteSession::dispatchGlare ( const SipMessage &  msg )

protected

Definition at line 2128 of file InviteSession.cxx.

dispatchInfo()

void InviteSession::dispatchInfo ( const SipMessage &  msg )

protected

dcm! – toss away 1xx to an info?

Definition at line 2539 of file InviteSession.cxx.

dispatchMessage()

void InviteSession::dispatchMessage ( const SipMessage &  msg )

protected

dcm! – toss away 1xx to an message?

Definition at line 2686 of file InviteSession.cxx.

dispatchOptions()

void InviteSession::dispatchOptions ( const SipMessage &  msg )

protected

Definition at line 2423 of file InviteSession.cxx.

dispatchReceivedReinviteSentOffer()

void InviteSession::dispatchReceivedReinviteSentOffer ( const SipMessage &  msg )

protected

dcm! – should this be onIllegalNegotiation?

Definition at line 2063 of file InviteSession.cxx.

dispatchReceivedUpdateOrReinvite()

void InviteSession::dispatchReceivedUpdateOrReinvite ( const SipMessage &  msg )

protected

Definition at line 2177 of file InviteSession.cxx.

dispatchReinviteNoOfferGlare()

void InviteSession::dispatchReinviteNoOfferGlare ( const SipMessage &  msg )

protected

Definition at line 2153 of file InviteSession.cxx.

dispatchSentOptions()

void InviteSession::dispatchSentOptions ( const SipMessage &  msg )

protected

Definition at line 2015 of file InviteSession.cxx.

dispatchSentReinvite()

void InviteSession::dispatchSentReinvite ( const SipMessage &  msg )

protected

Definition at line 1774 of file InviteSession.cxx.

dispatchSentReinviteAnswered()

void InviteSession::dispatchSentReinviteAnswered ( const SipMessage &  msg )

protected

Definition at line 2232 of file InviteSession.cxx.

dispatchSentReinviteNoOffer()

void InviteSession::dispatchSentReinviteNoOffer ( const SipMessage &  msg )

protected

Definition at line 1917 of file InviteSession.cxx.

dispatchSentUpdate()

void InviteSession::dispatchSentUpdate ( const SipMessage &  msg )

protected

Definition at line 1682 of file InviteSession.cxx.

dispatchTerminated()

void InviteSession::dispatchTerminated ( const SipMessage &  msg )

protected

Definition at line 2334 of file InviteSession.cxx.

dispatchWaitingToHangup()

void InviteSession::dispatchWaitingToHangup ( const SipMessage &  msg )

protected

Definition at line 2305 of file InviteSession.cxx.

dispatchWaitingToOffer()

void InviteSession::dispatchWaitingToOffer ( const SipMessage &  msg )

protected

Definition at line 2246 of file InviteSession.cxx.

dispatchWaitingToRequestOffer()

void InviteSession::dispatchWaitingToRequestOffer ( const SipMessage &  msg )

protected

Definition at line 2261 of file InviteSession.cxx.

dispatchWaitingToTerminate()

void InviteSession::dispatchWaitingToTerminate ( const SipMessage &  msg )

protected

Definition at line 2275 of file InviteSession.cxx.

dump()

EncodeStream & InviteSession::dump ( EncodeStream &  strm ) const

overridevirtual

Implements resip::BaseUsage.

Definition at line 457 of file InviteSession.cxx.

end() [1/4]

void InviteSession::end ( )

overridevirtual

Implements resip::BaseUsage.

Reimplemented in resip::ServerInviteSession, and resip::ClientInviteSession.

Definition at line 724 of file InviteSession.cxx.

end() [2/4]

void InviteSession::end ( const Data &  userReason )

virtual

Makes the specific dialog end.

Will send a BYE (not a CANCEL)

Reimplemented in resip::ServerInviteSession, and resip::ClientInviteSession.

Definition at line 730 of file InviteSession.cxx.

end() [3/4]

void InviteSession::end ( const ParserContainer< Token > &  endReasons )

virtual

Reimplemented in resip::ServerInviteSession, and resip::ClientInviteSession.

Definition at line 737 of file InviteSession.cxx.

end() [4/4]

void InviteSession::end ( EndReason  reason )

virtual

Reimplemented in resip::ServerInviteSession, and resip::ClientInviteSession.

Definition at line 744 of file InviteSession.cxx.

endCommand() [1/3]

void InviteSession::endCommand ( const Data &  userReason )

virtual

Definition at line 878 of file InviteSession.cxx.

endCommand() [2/3]

void InviteSession::endCommand ( const resip::ParserContainer< resip::Token > &  endReasons )

virtual

Definition at line 884 of file InviteSession.cxx.

endCommand() [3/3]

void InviteSession::endCommand ( EndReason  reason = NotSpecified )

virtual

Asynchronously makes the specific dialog end.

Will send a BYE (not a CANCEL)

Definition at line 872 of file InviteSession.cxx.

expireSessionAfterFailedModification()

bool InviteSession::expireSessionAfterFailedModification ( )

protected

Definition at line 2918 of file InviteSession.cxx.

flowTerminated()

void InviteSession::flowTerminated ( )

protectedvirtual

Definition at line 3679 of file InviteSession.cxx.

getEncryptionLevel()

DialogUsageManager::EncryptionLevel InviteSession::getEncryptionLevel ( const SipMessage &  msg )

protected

Definition at line 3634 of file InviteSession.cxx.

getEndReasonString()

const Data & InviteSession::getEndReasonString ( InviteSession::EndReason  reason )

protected

dcm! – necessary?

Definition at line 54 of file InviteSession.cxx.

getLastSentNITRequest()

std::shared_ptr< SipMessage > InviteSession::getLastSentNITRequest

(

)

const

gets the last NIT request that was sent by the session

Warning

Can return a NULL std::shared_ptr if none was sent

Definition at line 1054 of file InviteSession.cxx.

getLocalOfferAnswer()

const Contents & InviteSession::getLocalOfferAnswer

(

)

const

Definition at line 113 of file InviteSession.cxx.

getLocalSdp()

const SdpContents & InviteSession::getLocalSdp

(

)

const

Definition at line 171 of file InviteSession.cxx.

getOfferAnswer()

std::unique_ptr< Contents > InviteSession::getOfferAnswer ( const SipMessage &  msg )

protected

Definition at line 3269 of file InviteSession.cxx.

getPeerAllowedEvents()

Tokens & resip::InviteSession::getPeerAllowedEvents ( )

inline

Definition at line 182 of file InviteSession.hxx.

getPeerPAssertedIdentities()

NameAddrs & resip::InviteSession::getPeerPAssertedIdentities ( )

inline

Definition at line 184 of file InviteSession.hxx.

getPeerRequiresOptionsTags()

Tokens & resip::InviteSession::getPeerRequiresOptionsTags ( )

inline

Definition at line 178 of file InviteSession.hxx.

getPeerSupportedEncodings()

Tokens & resip::InviteSession::getPeerSupportedEncodings ( )

inline

Definition at line 180 of file InviteSession.hxx.

getPeerSupportedLanguages()

Tokens & resip::InviteSession::getPeerSupportedLanguages ( )

inline

Definition at line 181 of file InviteSession.hxx.

getPeerSupportedMethods()

Tokens & resip::InviteSession::getPeerSupportedMethods ( )

inline

Definition at line 176 of file InviteSession.hxx.

getPeerSupportedMimeTypes()

Mimes & resip::InviteSession::getPeerSupportedMimeTypes ( )

inline

Definition at line 179 of file InviteSession.hxx.

getPeerSupportedOptionTags()

Tokens & resip::InviteSession::getPeerSupportedOptionTags ( )

inline

Definition at line 177 of file InviteSession.hxx.

getPeerUserAgent()

Data & resip::InviteSession::getPeerUserAgent ( )

inline

Definition at line 183 of file InviteSession.hxx.

getProposedRemoteOfferAnswer()

const Contents & InviteSession::getProposedRemoteOfferAnswer

(

)

const

Definition at line 151 of file InviteSession.cxx.

getProposedRemoteSdp()

const SdpContents & InviteSession::getProposedRemoteSdp

(

)

const

Definition at line 217 of file InviteSession.cxx.

getRemoteOfferAnswer()

const Contents & InviteSession::getRemoteOfferAnswer

(

)

const

Definition at line 132 of file InviteSession.cxx.

getRemoteSdp()

const SdpContents & InviteSession::getRemoteSdp

(

)

const

Definition at line 194 of file InviteSession.cxx.

getSessionHandle()

InviteSessionHandle InviteSession::getSessionHandle

(

)

Definition at line 233 of file InviteSession.cxx.

handleSessionTimerRequest()

void InviteSession::handleSessionTimerRequest ( SipMessage &  response, const SipMessage &  request  )

protected

Definition at line 3036 of file InviteSession.cxx.

handleSessionTimerResponse()

void InviteSession::handleSessionTimerResponse ( const SipMessage &  msg )

protected

Definition at line 2979 of file InviteSession.cxx.

hasLocalOfferAnswer()

bool InviteSession::hasLocalOfferAnswer

(

)

const

Definition at line 107 of file InviteSession.cxx.

hasLocalSdp()

bool InviteSession::hasLocalSdp

(

)

const

Definition at line 164 of file InviteSession.cxx.

hasProposedRemoteOfferAnswer()

bool InviteSession::hasProposedRemoteOfferAnswer

(

)

const

Definition at line 145 of file InviteSession.cxx.

hasProposedRemoteSdp()

bool InviteSession::hasProposedRemoteSdp

(

)

const

Definition at line 210 of file InviteSession.cxx.

hasRemoteOfferAnswer()

bool InviteSession::hasRemoteOfferAnswer

(

)

const

Definition at line 126 of file InviteSession.cxx.

hasRemoteSdp()

bool InviteSession::hasRemoteSdp

(

)

const

Definition at line 187 of file InviteSession.cxx.

info()

void InviteSession::info ( const Contents &  contents )

virtual

sends an info request

Definition at line 1220 of file InviteSession.cxx.

infoCommand()

void InviteSession::infoCommand ( const Contents &  contents )

virtual

Definition at line 1266 of file InviteSession.cxx.

isAccepted()

bool InviteSession::isAccepted

(

)

const

Definition at line 381 of file InviteSession.cxx.

isAckForCurrent200()

bool InviteSession::isAckForCurrent200 ( const SipMessage &  ack ) const

protected

Definition at line 2734 of file InviteSession.cxx.

isConnected()

bool InviteSession::isConnected

(

)

const

Definition at line 333 of file InviteSession.cxx.

isEarly()

bool InviteSession::isEarly

(

)

const

Definition at line 362 of file InviteSession.cxx.

isReliable()

bool InviteSession::isReliable ( const SipMessage &  msg ) const

protected

Definition at line 3246 of file InviteSession.cxx.

isSessionModificationInFlight()

bool InviteSession::isSessionModificationInFlight

(

)

const

Definition at line 423 of file InviteSession.cxx.

isTerminated()

bool InviteSession::isTerminated

(

)

const

Definition at line 441 of file InviteSession.cxx.

makeOfferAnswer() [1/2]

std::unique_ptr< Contents > InviteSession::makeOfferAnswer ( const Contents &  offerAnswer )

staticprotected

Definition at line 3285 of file InviteSession.cxx.

makeOfferAnswer() [2/2]

std::unique_ptr< Contents > InviteSession::makeOfferAnswer ( const Contents &  offerAnswer, const Contents *  alternative  )

staticprotected

Definition at line 3291 of file InviteSession.cxx.

message()

void InviteSession::message ( const Contents &  contents )

virtual

sends a message request

Warning

From RFC3428 - The authors recognize that there may be valid reasons to send MESSAGE requests in the context of a dialog. For example, one participant in a voice session may wish to send an IM to another participant, and associate that IM with the session. But implementations SHOULD NOT create dialogs for the primary purpose of associating MESSAGE requests with one another.

Definition at line 1272 of file InviteSession.cxx.

messageCommand()

void InviteSession::messageCommand ( const Contents &  contents )

virtual

Definition at line 1320 of file InviteSession.cxx.

nitComplete()

void InviteSession::nitComplete ( )

protected

Definition at line 1060 of file InviteSession.cxx.

onReadyToSend()

void InviteSession::onReadyToSend ( SipMessage &  msg )

overrideprotectedvirtual

Reimplemented from resip::DialogUsage.

Definition at line 3673 of file InviteSession.cxx.

operator=() [1/2]

InviteSession & resip::InviteSession::operator= ( const InviteSession &  )

delete

operator=() [2/2]

InviteSession & resip::InviteSession::operator= ( InviteSession &&  )

delete

provideAnswer()

void InviteSession::provideAnswer ( const Contents &  answer )

virtual

Similar to provideOffer - called to set the answer to be signaled to the peer.

May result in message being sent synchronously depending on the state.

Reimplemented in resip::ServerInviteSession, and resip::ClientInviteSession.

Definition at line 629 of file InviteSession.cxx.

provideAnswerCommand()

void InviteSession::provideAnswerCommand ( const Contents &  answer )

virtual

Definition at line 718 of file InviteSession.cxx.

provideOffer() [1/2]

void InviteSession::provideOffer ( const Contents &  offer )

virtual

Called to set the offer that will be used in the next message that sends an offer.

If possible, this will synchronously send the appropriate request or response. In some cases, the UAS might have to call accept in order to cause the message to be sent.

Reimplemented in resip::ServerInviteSession, and resip::ClientInviteSession.

Definition at line 591 of file InviteSession.cxx.

provideOffer() [2/2]

void InviteSession::provideOffer ( const Contents &  offer, DialogUsageManager::EncryptionLevel  level, const Contents *  alternative  )

virtual

Reimplemented in resip::ServerInviteSession, and resip::ClientInviteSession.

Definition at line 499 of file InviteSession.cxx.

provideOfferCommand() [1/2]

void InviteSession::provideOfferCommand ( const Contents &  offer )

virtual

Provide asynchronous method access by using command.

Definition at line 623 of file InviteSession.cxx.

provideOfferCommand() [2/2]

void InviteSession::provideOfferCommand ( const Contents &  offer, DialogUsageManager::EncryptionLevel  level, const Contents *  alternative  )

virtual

Definition at line 585 of file InviteSession.cxx.

provideProposedOffer()

void InviteSession::provideProposedOffer ( )

protected

Definition at line 3335 of file InviteSession.cxx.

refer() [1/8]

void InviteSession::refer ( const NameAddr &  referTo, bool  referSub = true  )

virtual

sends a refer request

Definition at line 1003 of file InviteSession.cxx.

refer() [2/8]

void InviteSession::refer ( const NameAddr &  referTo, const CallId &  replaces, bool  referSub = true  )

virtual

Definition at line 1137 of file InviteSession.cxx.

refer() [3/8]

void InviteSession::refer ( const NameAddr &  referTo, const CallId &  replaces, std::unique_ptr< resip::Contents >  contents, bool  referSub = true  )

virtual

Definition at line 1143 of file InviteSession.cxx.

refer() [4/8]

void InviteSession::refer ( const NameAddr &  referTo, const NameAddr &  referredBy, bool  referSub = true  )

virtual

Definition at line 1008 of file InviteSession.cxx.

refer() [5/8]

void InviteSession::refer ( const NameAddr &  referTo, const NameAddr &  referredBy, std::unique_ptr< resip::Contents >  contents, bool  referSub = true  )

virtual

Definition at line 1018 of file InviteSession.cxx.

refer() [6/8]

void InviteSession::refer ( const NameAddr &  referTo, InviteSessionHandle  sessionToReplace, bool  referSub = true  )

virtual

sends a refer request with a replaces header

Definition at line 1114 of file InviteSession.cxx.

refer() [7/8]

void InviteSession::refer ( const NameAddr &  referTo, InviteSessionHandle  sessionToReplace, std::unique_ptr< resip::Contents >  contents, bool  referSub = true  )

virtual

Definition at line 1120 of file InviteSession.cxx.

refer() [8/8]

void InviteSession::refer ( const NameAddr &  referTo, std::unique_ptr< resip::Contents >  contents, bool  referSub = true  )

virtual

Definition at line 1013 of file InviteSession.cxx.

referCommand() [1/2]

void InviteSession::referCommand ( const NameAddr &  referTo, bool  referSub = true  )

virtual

Definition at line 1108 of file InviteSession.cxx.

referCommand() [2/2]

void InviteSession::referCommand ( const NameAddr &  referTo, InviteSessionHandle  sessionToReplace, bool  referSub = true  )

virtual

Definition at line 1214 of file InviteSession.cxx.

referNoSub()

void InviteSession::referNoSub ( const SipMessage &  msg )

protected

Definition at line 3686 of file InviteSession.cxx.

reject() [1/2]

void InviteSession::reject ( int  statusCode, const Contents *  contents, WarningCategory *  warning = 0  )

virtual

Reimplemented in resip::ServerInviteSession, and resip::ClientInviteSession.

Definition at line 896 of file InviteSession.cxx.

reject() [2/2]

void InviteSession::reject ( int  statusCode, WarningCategory *  warning = 0  )

virtual

Rejects an offer at the SIP level.

Can also be used to send a 488 to a reINVITE or UPDATE

Reimplemented in resip::ServerInviteSession, and resip::ClientInviteSession.

Definition at line 890 of file InviteSession.cxx.

rejectCommand() [1/2]

void InviteSession::rejectCommand ( int  statusCode, const Contents *  contents, WarningCategory *  warning = 0  )

virtual

Definition at line 982 of file InviteSession.cxx.

rejectCommand() [2/2]

void InviteSession::rejectCommand ( int  statusCode, WarningCategory *  warning = 0  )

virtual

Asynchronously rejects an offer at the SIP level.

Can also be used to send a 488 to a reINVITE or UPDATE

Definition at line 976 of file InviteSession.cxx.

rejectNIT()

void InviteSession::rejectNIT ( int  statusCode = 488 )

virtual

rejects an INFO or MESSAGE request with an error status code

Definition at line 2634 of file InviteSession.cxx.

rejectNITCommand()

void InviteSession::rejectNITCommand ( int  statusCode = 488 )

virtual

Asynchronously rejects an INFO or MESSAGE request with an error status code.

Definition at line 2680 of file InviteSession.cxx.

rejectReferNoSub()

void InviteSession::rejectReferNoSub ( int  responseCode )

virtual

Definition at line 3710 of file InviteSession.cxx.

requestOffer()

void InviteSession::requestOffer ( )

virtual

Called to request that the far end provide an offer.

This will cause a reinvite with no body to be sent.

Reimplemented in resip::ServerInviteSession.

Definition at line 467 of file InviteSession.cxx.

sendAck()

std::shared_ptr< SipMessage > InviteSession::sendAck ( const Contents *  answer = 0 )

protected

Definition at line 3553 of file InviteSession.cxx.

sendBye()

std::shared_ptr< SipMessage > InviteSession::sendBye ( )

protected

Definition at line 3601 of file InviteSession.cxx.

sessionRefresh()

void InviteSession::sessionRefresh ( )

protected

Definition at line 2828 of file InviteSession.cxx.

sessionTimerSupportedLocalAndPeer()

bool InviteSession::sessionTimerSupportedLocalAndPeer ( ) const

protected

Definition at line 325 of file InviteSession.cxx.

setCurrentLocalOfferAnswer()

void InviteSession::setCurrentLocalOfferAnswer ( const SipMessage &  msg )

protected

Definition at line 3651 of file InviteSession.cxx.

setOfferAnswer() [1/2]

void InviteSession::setOfferAnswer ( SipMessage &  msg, const Contents &  offerAnswer, const Contents *  alternative = 0  )

staticprotected

Definition at line 3308 of file InviteSession.cxx.

setOfferAnswer() [2/2]

void InviteSession::setOfferAnswer ( SipMessage &  msg, const Contents *  offerAnswer  )

staticprotected

Definition at line 3328 of file InviteSession.cxx.

setSessionTimerHeaders()

void InviteSession::setSessionTimerHeaders ( SipMessage &  msg )

protected

Definition at line 2801 of file InviteSession.cxx.

setSessionTimerPreferences()

void InviteSession::setSessionTimerPreferences ( )

protected

Definition at line 2878 of file InviteSession.cxx.

start491Timer()

void InviteSession::start491Timer ( )

protected

Definition at line 2766 of file InviteSession.cxx.

startRetransmit200Timer()

void InviteSession::startRetransmit200Timer ( )

protected

Definition at line 2750 of file InviteSession.cxx.

startSessionTimer()

void InviteSession::startSessionTimer ( )

protected

Definition at line 2939 of file InviteSession.cxx.

startStaleReInviteTimer()

void InviteSession::startStaleReInviteTimer ( )

protected

Definition at line 2789 of file InviteSession.cxx.

storePeerCapabilities()

void InviteSession::storePeerCapabilities ( const SipMessage &  msg )

protected

Definition at line 238 of file InviteSession.cxx.

targetRefresh()

void InviteSession::targetRefresh ( const NameAddr &  localUri )

virtual

will send a reINVITE (current offerAnswer) or UPDATE with new Contact header

currently only supported when in the Connected state, UAC_Early states are allowed by RFC but not yet supported

Definition at line 988 of file InviteSession.cxx.

toData()

Data InviteSession::toData ( State  state )

staticprotected

Definition at line 3106 of file InviteSession.cxx.

toEvent()

InviteSession::Event InviteSession::toEvent ( const SipMessage &  msg, const Contents *  offeranswer  )

protected

Definition at line 3354 of file InviteSession.cxx.

transition()

void InviteSession::transition ( State  target )

protected

Definition at line 3239 of file InviteSession.cxx.

updateMethodSupported()

bool InviteSession::updateMethodSupported ( ) const

protected

Definition at line 313 of file InviteSession.cxx.

Friends And Related Symbol Documentation

Dialog

friend class Dialog

friend

Definition at line 453 of file InviteSession.hxx.

DialogUsageManager

friend class DialogUsageManager

friend

Definition at line 454 of file InviteSession.hxx.

Member Data Documentation

mAcks

AckMap resip::InviteSession::mAcks

protected

Definition at line 450 of file InviteSession.hxx.

mCurrentEncryptionLevel

DialogUsageManager::EncryptionLevel resip::InviteSession::mCurrentEncryptionLevel

protected

Definition at line 439 of file InviteSession.hxx.

mCurrentLocalOfferAnswer

std::unique_ptr<Contents> resip::InviteSession::mCurrentLocalOfferAnswer

protected

Definition at line 398 of file InviteSession.hxx.

mCurrentRemoteOfferAnswer

std::unique_ptr<Contents> resip::InviteSession::mCurrentRemoteOfferAnswer

protected

Definition at line 401 of file InviteSession.hxx.

mCurrentRetransmit200

unsigned long resip::InviteSession::mCurrentRetransmit200

protected

Definition at line 411 of file InviteSession.hxx.

mEndReason

EndReason resip::InviteSession::mEndReason

protected

Definition at line 442 of file InviteSession.hxx.

mInvite200

std::shared_ptr<SipMessage> resip::InviteSession::mInvite200

protected

Definition at line 406 of file InviteSession.hxx.

mLastLocalSessionModification

std::shared_ptr<SipMessage> resip::InviteSession::mLastLocalSessionModification

protected

Definition at line 404 of file InviteSession.hxx.

mLastNitResponse

std::shared_ptr<SipMessage> resip::InviteSession::mLastNitResponse

protected

Definition at line 407 of file InviteSession.hxx.

mLastReferNoSubRequest

SipMessage resip::InviteSession::mLastReferNoSubRequest

protected

Definition at line 409 of file InviteSession.hxx.

mLastRemoteSessionModification

std::shared_ptr<SipMessage> resip::InviteSession::mLastRemoteSessionModification

protected

Definition at line 405 of file InviteSession.hxx.

mLastSentNITRequest

std::shared_ptr<SipMessage> resip::InviteSession::mLastSentNITRequest

protected

Definition at line 437 of file InviteSession.hxx.

mMinSE

uint32_t resip::InviteSession::mMinSE

protected

Definition at line 416 of file InviteSession.hxx.

mNITQueue

std::queue<QueuedNIT*> resip::InviteSession::mNITQueue

protected

Definition at line 434 of file InviteSession.hxx.

mNitState

NitState resip::InviteSession::mNitState

protected

Definition at line 395 of file InviteSession.hxx.

mPeerAllowedEvents

Tokens resip::InviteSession::mPeerAllowedEvents

protected

Definition at line 387 of file InviteSession.hxx.

mPeerPAssertedIdentities

NameAddrs resip::InviteSession::mPeerPAssertedIdentities

protected

Definition at line 389 of file InviteSession.hxx.

mPeerRequiresOptionTags

Tokens resip::InviteSession::mPeerRequiresOptionTags

protected

Definition at line 383 of file InviteSession.hxx.

mPeerSupportedEncodings

Tokens resip::InviteSession::mPeerSupportedEncodings

protected

Definition at line 385 of file InviteSession.hxx.

mPeerSupportedLanguages

Tokens resip::InviteSession::mPeerSupportedLanguages

protected

Definition at line 386 of file InviteSession.hxx.

mPeerSupportedMethods

Tokens resip::InviteSession::mPeerSupportedMethods

protected

Definition at line 381 of file InviteSession.hxx.

mPeerSupportedMimeTypes

Mimes resip::InviteSession::mPeerSupportedMimeTypes

protected

Definition at line 384 of file InviteSession.hxx.

mPeerSupportedOptionTags

Tokens resip::InviteSession::mPeerSupportedOptionTags

protected

Definition at line 382 of file InviteSession.hxx.

mPeerSupportsSessionTimer

bool resip::InviteSession::mPeerSupportsSessionTimer

protected

Definition at line 390 of file InviteSession.hxx.

mPeerUserAgent

Data resip::InviteSession::mPeerUserAgent

protected

Definition at line 388 of file InviteSession.hxx.

mProposedEncryptionLevel

DialogUsageManager::EncryptionLevel resip::InviteSession::mProposedEncryptionLevel

protected

Definition at line 440 of file InviteSession.hxx.

mProposedLocalOfferAnswer

std::unique_ptr<Contents> resip::InviteSession::mProposedLocalOfferAnswer

protected

Definition at line 399 of file InviteSession.hxx.

mProposedRemoteOfferAnswer

std::unique_ptr<Contents> resip::InviteSession::mProposedRemoteOfferAnswer

protected

Definition at line 402 of file InviteSession.hxx.

mReferSub

bool resip::InviteSession::mReferSub

protected

Definition at line 436 of file InviteSession.hxx.

mServerNitState

NitState resip::InviteSession::mServerNitState

protected

Definition at line 396 of file InviteSession.hxx.

mSessionExpirationPending

bool resip::InviteSession::mSessionExpirationPending

protected

Definition at line 421 of file InviteSession.hxx.

mSessionExpirationTimerSeq

unsigned int resip::InviteSession::mSessionExpirationTimerSeq

protected

Definition at line 419 of file InviteSession.hxx.

mSessionInterval

uint32_t resip::InviteSession::mSessionInterval

protected

Definition at line 415 of file InviteSession.hxx.

mSessionRefresher

bool resip::InviteSession::mSessionRefresher

protected

Definition at line 417 of file InviteSession.hxx.

mSessionRefreshReInvite

bool resip::InviteSession::mSessionRefreshReInvite

protected

Definition at line 420 of file InviteSession.hxx.

mSessionRefreshTimerSeq

unsigned int resip::InviteSession::mSessionRefreshTimerSeq

protected

Definition at line 418 of file InviteSession.hxx.

mStaleReInviteTimerSeq

unsigned int resip::InviteSession::mStaleReInviteTimerSeq

protected

Definition at line 412 of file InviteSession.hxx.

mState

State resip::InviteSession::mState

protected

Definition at line 394 of file InviteSession.hxx.

mUserEndReason

Data resip::InviteSession::mUserEndReason

protected

Definition at line 445 of file InviteSession.hxx.

mUserEndReasons

ParserContainer<Token> resip::InviteSession::mUserEndReasons

protected

Definition at line 446 of file InviteSession.hxx.

---

The documentation for this class was generated from the following files:

• resip/dum/InviteSession.hxx
• resip/dum/InviteSession.cxx