This class is one of two main classes of concern to an application using the UserAgent library. More...

#include <ConversationManager.hxx>

Inheritance diagram for recon::ConversationManager:

Public Types
enum	ParticipantType { ParticipantType_Local , ParticipantType_Remote , ParticipantType_MediaResource , ParticipantType_RemoteIMPager , ParticipantType_RemoteIMSession }

enum	ParticipantForkSelectMode { ForkSelectAutomatic , ForkSelectManual , ForkSelectAutomaticEx }

enum	AutoHoldMode { AutoHoldDisabled , AutoHoldEnabled , AutoHoldBroadcastOnly }

enum	RedirectSuccessCondition { RedirectSuccessOnTrying , RedirectSuccessOnRinging , RedirectSuccessOnConnected }

Public Types inherited from resip::InviteSessionHandler
enum	TerminatedReason { Error , Timeout , Replaced , LocalBye , RemoteBye , LocalCancel , RemoteCancel , Rejected , Referred }
	called when an dialog enters the terminated state - this can happen after getting a BYE, Cancel, or 4xx,5xx,6xx response - or the session times out More...

Public Member Functions
	ConversationManager (std::shared_ptr< MediaStackAdapter > mediaStackAdapter, std::shared_ptr< resip::ConfigParse > configParse=std::shared_ptr< resip::ConfigParse >())

virtual	~ConversationManager ()

virtual ConversationHandle	createConversation (AutoHoldMode autoHoldMode=AutoHoldEnabled)
	Create a new empty Conversation to which participants can be added.

virtual void	destroyConversation (ConversationHandle convHandle)
	Destroys an existing Conversation, and ends all participants that solely belong to this conversation.

virtual void	joinConversation (ConversationHandle sourceConvHandle, ConversationHandle destConvHandle)
	Joins all participants from source conversation into destination conversation and destroys source conversation.

virtual ParticipantHandle	createRemoteParticipant (ConversationHandle convHandle, const resip::NameAddr &destination, ParticipantForkSelectMode forkSelectMode=ForkSelectAutomatic, const std::shared_ptr< ConversationProfile > &conversationProfile=nullptr, const std::multimap< resip::Data, resip::Data > &extraHeaders=std::multimap< resip::Data, resip::Data >())
	Creates a new remote participant in the specified conversation that is attempted to be reached at the specified address.

virtual ParticipantHandle	createRemoteIMPagerParticipant (const resip::NameAddr &destination, const std::shared_ptr< ConversationProfile > &conversationProfile=nullptr)
	Creates a new remote IM participant that will be attempted to be reached when sendIMToParticipant is called.

virtual ParticipantHandle	createRemoteIMSessionParticipant (const resip::NameAddr &destination, ParticipantForkSelectMode forkSelectMode=ForkSelectAutomatic, const std::shared_ptr< ConversationProfile > &callerProfile=nullptr, const std::multimap< resip::Data, resip::Data > &extraHeaders=std::multimap< resip::Data, resip::Data >())
	Creates a new remote IM participant that will attempted to be reached immediately at the specified address.

virtual ParticipantHandle	createMediaResourceParticipant (ConversationHandle convHandle, const resip::Uri &mediaUrl, const std::shared_ptr< resip::Data > &playAudioBuffer=std::shared_ptr< resip::Data >(), void *recordingCircularBuffer=0)
	Creates a new media resource participant in the specified conversation.

virtual ParticipantHandle	createLocalParticipant ()
	Creates a new local participant in the specified conversation (if supported).

virtual void	destroyParticipant (ParticipantHandle partHandle)
	Ends connections to the participant and removes it from all active conversations.

virtual void	addParticipant (ConversationHandle convHandle, ParticipantHandle partHandle)
	Adds the specified participant to the specified conversation.

virtual void	removeParticipant (ConversationHandle convHandle, ParticipantHandle partHandle)
	Removed the specified participant from the specified conversation.

virtual void	moveParticipant (ParticipantHandle partHandle, ConversationHandle sourceConvHandle, ConversationHandle destConvHandle)
	Removed the specified participant from the specified conversation.

virtual void	modifyParticipantContribution (ConversationHandle convHandle, ParticipantHandle partHandle, unsigned int inputGain, unsigned int outputGain)
	Modifies how the participant contributes to the particular conversation.

virtual void	modifyParticipantRecordChannel (ParticipantHandle partHandle, unsigned int channelNum)
	If the participant is mixed to a multi-channel recording resource, then this controls if a participants audio is mixed into channel 1 or channel 2.

virtual void	outputBridgeMatrix (ConversationHandle convHandle=0)
	Logs a multiline representation of the current state of the mixing matrix.

virtual void	alertParticipant (ParticipantHandle partHandle, bool earlyFlag=true)
	Signal to the participant that it should provide ringback.

virtual void	answerParticipant (ParticipantHandle partHandle)
	Signal to the participant that the call is answered.

virtual void	rejectParticipant (ParticipantHandle partHandle, unsigned int rejectCode)
	Rejects an incoming remote participant with the specified code.

virtual void	redirectParticipant (ParticipantHandle partHandle, const resip::NameAddr &destination, unsigned int redirectCode=302, RedirectSuccessCondition successCondition=RedirectSuccessOnConnected)
	Redirects the participant to another endpoint.

virtual void	redirectToParticipant (ParticipantHandle partHandle, ParticipantHandle destPartHandle, RedirectSuccessCondition successCondition=RedirectSuccessOnConnected)
	This is used for attended transfer scenarios where both participants are no longer managed by the conversation manager - for SIP this will send a REFER with embedded Replaces header.

virtual void	holdParticipant (ParticipantHandle partHandle, bool hold)
	Manually puts a paricipant on hold, or takes off hold without needing to move it in and out of any conversations.

virtual void	sendIMToParticipant (ParticipantHandle partHandle, std::unique_ptr< resip::Contents > contents)
	Sends a MESSAGE with specified Contents to RemoteParticipant, RemoteIMPagerParticipant, or a RemoteIMSessionParticipant.

virtual void	addBufferToMediaResourceCache (const resip::Data &name, const resip::Data &buffer, int type)
	This function is used to add a chunk of memory to a media/prompt cache.

virtual bool	getBufferFromMediaResourceCache (const resip::Data &name, resip::Data *buffer, int type)
	This function is used to retrieve a chunk of memory from the media/prompt cache.

virtual void	requestKeyframe (ParticipantHandle partHandle, std::chrono::duration< double > durationMs)

virtual void	requestKeyframeFromPeer (ParticipantHandle partHandle, std::chrono::duration< double > durationMs)

virtual void	requestKeyframeFromPeerRecurring (ParticipantHandle partHandle, std::chrono::duration< double > interval)

virtual void	startApplicationTimer (unsigned int timerId, unsigned int timerData1, unsigned int timerData2, unsigned int durationMs)
	This function is used to start a timer on behalf of recon based application.

virtual void	startApplicationTimer (unsigned int timerId, unsigned int timerData1, unsigned int timerData2, std::chrono::duration< double > duration)
	This function is used to start a timer on behalf of recon based application.

virtual void	onApplicationTimer (unsigned int timerId, unsigned int timerData1, unsigned int timerData2)

virtual void	onIncomingParticipant (ParticipantHandle partHandle, const resip::SipMessage &msg, bool autoAnswer, ConversationProfile &conversationProfile)=0
	Notifies an application about a new remote participant that is attempting to contact it.

virtual void	onIncomingIMPagerParticipant (ParticipantHandle partHandle, const resip::SipMessage &msg, ConversationProfile &conversationProfile)
	Notifies an application about a new remote IM pager mode participant that has sent a message.

virtual void	onIncomingIMSessionParticipant (ParticipantHandle partHandle, const resip::SipMessage &msg, bool autoAnswer, ConversationProfile &conversationProfile)
	Notifies an application about a new remote IM session mode participant that has sent an INVITE.

virtual bool	onReceiveIMFromParticipant (ParticipantHandle partHandle, const resip::SipMessage &msg)
	Notifies an application about a subsequent message from remote and existing IM participant.

virtual void	onParticipantSendIMFailure (ParticipantHandle partHandle, const resip::SipMessage &status, std::unique_ptr< resip::Contents > contents)
	Notifies an application that a send IM call has failed.

virtual void	onRequestOutgoingParticipant (ParticipantHandle partHandle, const resip::SipMessage &msg, ConversationProfile &conversationProfile)=0
	Notifies an application about a new remote participant that is trying to be contacted.

virtual void	onParticipantTerminated (ParticipantHandle partHandle, unsigned int statusCode)=0
	Notifies an application about a disconnect by a remote participant.

virtual void	onParticipantTerminated (ParticipantHandle partHandle, unsigned int statusCode, const resip::Data &reason)
	Notifies an application about a disconnect by a remote participant.

virtual void	onConversationDestroyed (ConversationHandle convHandle)=0
	Notifies an application when a conversation has been destroyed.

virtual void	onParticipantDestroyed (ParticipantHandle partHandle)=0
	Notifies an application when a Participant has been destroyed.

virtual void	onParticipantDestroyed (ParticipantHandle partHandle, ParticipantType partType)
	Notifies an application when a Participant has been destroyed.

virtual void	onRelatedConversation (ConversationHandle relatedConvHandle, ParticipantHandle relatedPartHandle, ConversationHandle origConvHandle, ParticipantHandle origPartHandle)=0
	Notifies an applications that a outbound remote participant request has forked.

virtual void	onParticipantProceeding (ParticipantHandle partHandle, const resip::SipMessage &msg)
	Notifies an application that a remote participant call attempt is proceeding at the first hop.

virtual void	onParticipantAlerting (ParticipantHandle partHandle, const resip::SipMessage &msg)=0
	Notifies an application that a remote participant call attempt is alerting the remote party.

virtual void	onParticipantConnected (ParticipantHandle partHandle, const resip::SipMessage &msg)=0
	Notifies an application that a remote participant call attempt is now connected.

virtual void	onParticipantConnectedConfirmed (ParticipantHandle partHandle, const resip::SipMessage &msg)
	Notifies an application that an inbound remote participant call now fully connected after answering (ie: ACK was received).

virtual void	onParticipantRedirectSuccess (ParticipantHandle partHandle)=0
	Notifies an application that a redirect request has succeeded.

virtual void	onParticipantRedirectFailure (ParticipantHandle partHandle, unsigned int statusCode)=0
	Notifies an application that a redirect request has failed.

virtual void	onDtmfEvent (ParticipantHandle partHandle, int dtmf, int duration, bool up)=0
	Notifies an application when an RFC2833 DTMF event is received from a particular remote participant.

virtual void	onParticipantRequestedHold (ParticipantHandle partHandle, bool held)=0

virtual void	onParticipantVoiceActivity (recon::ParticipantHandle partHandle, bool on, bool inbound)
	Notifies an application when voice activity is detected to on or off from a remote participant.

virtual void	onMediaResourceParticipantFailed (ParticipantHandle partHandle)
	Notifies an application about a failure in a media resource participant.

virtual RemoteParticipant *	createAppropriateRemoteParticipantInstance (resip::DialogUsageManager &dum, RemoteParticipantDialogSet &rpds)

virtual RemoteParticipant *	createAppropriateRemoteParticipantInstance (ParticipantHandle partHandle, resip::DialogUsageManager &dum, RemoteParticipantDialogSet &rpds)

virtual RemoteParticipantDialogSet *	createRemoteIMSessionParticipantDialogSetInstance (ConversationManager::ParticipantForkSelectMode forkSelectMode=ConversationManager::ForkSelectAutomatic, std::shared_ptr< ConversationProfile > conversationProfile=nullptr)

virtual void	setMediaStackAdapter (std::shared_ptr< MediaStackAdapter > mediaStackAdapter)

MediaStackAdapter &	getMediaStackAdapter ()

std::shared_ptr< resip::ConfigParse >	getConfig ()

bool	sendKeyframesAtStart () const

Public Member Functions inherited from resip::InviteSessionHandler
	InviteSessionHandler (bool genericOfferAnswer=false)

virtual	~InviteSessionHandler ()

virtual bool	isGenericOfferAnswer ()

virtual void	onEarlyMedia (ClientInviteSessionHandle, const SipMessage &, const Contents &)

virtual void	onPrack (ServerInviteSessionHandle, const SipMessage &msg)
	called when PRACK is received for a reliable provisional answer (UAS)

virtual void	terminate (ClientInviteSessionHandle h)
	called when an early dialog decides it wants to terminate the dialog.

virtual void	onReadyToSend (InviteSessionHandle, SipMessage &msg)
	called to allow app to adorn a message. default is to send immediately

virtual void	onAnswer (InviteSessionHandle, const SipMessage &msg, const Contents &)

virtual void	onOffer (InviteSessionHandle, const SipMessage &msg, const Contents &)

virtual void	onRemoteAnswerChanged (InviteSessionHandle, const SipMessage &msg, const Contents &)

virtual void	onAckReceived (InviteSessionHandle, const SipMessage &msg)
	called when ACK is received

virtual void	onAckNotReceived (InviteSessionHandle)
	default behaviour is to send a BYE to end the dialog

virtual void	onStaleReInviteTimeout (InviteSessionHandle h)
	UAC gets no final response within the stale re-invite timeout (default is 40 seconds).

virtual void	onIllegalNegotiation (InviteSessionHandle, const SipMessage &msg)
	will be called if reINVITE or UPDATE in dialog fails

virtual void	onSessionExpired (InviteSessionHandle)
	will be called if Session-Timers are used and Session Timer expires default behaviour is to send a BYE to send the dialog

virtual void	onFlowTerminated (InviteSessionHandle)
	Called when a TCP or TLS flow to the server has terminated.

Public Member Functions inherited from resip::DialogSetHandler
virtual	~DialogSetHandler ()

Public Member Functions inherited from resip::OutOfDialogHandler
virtual	~OutOfDialogHandler ()

Public Member Functions inherited from resip::ClientSubscriptionHandler
virtual	~ClientSubscriptionHandler ()

virtual void	onReadyToSend (ClientSubscriptionHandle, SipMessage &msg)
	called to allow app to adorn a message.

virtual void	onNotifyNotReceived (ClientSubscriptionHandle)

virtual void	onFlowTerminated (ClientSubscriptionHandle)
	Called when a TCP or TLS flow to the server has terminated.

Public Member Functions inherited from resip::ServerSubscriptionHandler
virtual	~ServerSubscriptionHandler ()

virtual void	onPublished (ServerSubscriptionHandle associated, ServerPublicationHandle publication, const Contents contents, const SecurityAttributes attrs)

virtual void	onNotifyAccepted (ServerSubscriptionHandle, const SipMessage &msg)

virtual void	onFlowTerminated (ServerSubscriptionHandle)
	Called when a TCP or TLS flow to the server has terminated.

virtual void	getExpires (const SipMessage &msg, uint32_t &expires, int &errorResponseCode)
	Default behavior is to use the expires value in the SipMessage, if it exists.

virtual bool	hasMinExpires () const

virtual uint32_t	getMinExpires () const

virtual bool	hasMaxExpires () const

virtual uint32_t	getMaxExpires () const

const Mimes &	getSupportedMimeTypes () const

Public Member Functions inherited from resip::RedirectHandler
virtual	~RedirectHandler ()

Public Member Functions inherited from resip::ClientPagerMessageHandler
virtual	~ClientPagerMessageHandler ()

Public Member Functions inherited from resip::ServerPagerMessageHandler
virtual	~ServerPagerMessageHandler ()

Static Public Member Functions
static const char *	participantTypeToString (ParticipantType partType)

Protected Member Functions
virtual void	onNewSession (resip::ClientInviteSessionHandle h, resip::InviteSession::OfferAnswerType oat, const resip::SipMessage &msg)
	called when an initial INVITE or the intial response to an outoing invite

virtual void	onNewSession (resip::ServerInviteSessionHandle h, resip::InviteSession::OfferAnswerType oat, const resip::SipMessage &msg)

virtual void	onFailure (resip::ClientInviteSessionHandle h, const resip::SipMessage &msg)
	Received a failure response from UAS.

virtual void	onEarlyMedia (resip::ClientInviteSessionHandle, const resip::SipMessage &, const resip::SdpContents &)
	called when an in-dialog provisional response is received that contains a body

virtual void	onProvisional (resip::ClientInviteSessionHandle, const resip::SipMessage &msg)
	called when dialog enters the Early state - typically after getting 18x

virtual void	onConnected (resip::ClientInviteSessionHandle h, const resip::SipMessage &msg)
	called when a dialog initiated as a UAC enters the connected state

virtual void	onConnected (resip::InviteSessionHandle, const resip::SipMessage &msg)
	called when a dialog initiated as a UAS enters the connected state

virtual void	onConnectedConfirmed (resip::InviteSessionHandle, const resip::SipMessage &msg)
	called when ACK (with out an answer) is received for initial invite (UAS)

virtual void	onStaleCallTimeout (resip::ClientInviteSessionHandle)
	UAC gets no final response within the stale call timeout (default is 3 minutes).

virtual void	onTerminated (resip::InviteSessionHandle h, resip::InviteSessionHandler::TerminatedReason reason, const resip::SipMessage *msg)

virtual void	onRedirected (resip::ClientInviteSessionHandle, const resip::SipMessage &msg)
	called when a 3xx with valid targets is encountered in an early dialog This is different then getting a 3xx in onTerminated, as another request will be attempted, so the DialogSet will not be destroyed.

virtual void	onAnswer (resip::InviteSessionHandle, const resip::SipMessage &msg, const resip::SdpContents &)
	called when an answer is received - has nothing to do with user answering the call

virtual void	onOffer (resip::InviteSessionHandle handle, const resip::SipMessage &msg, const resip::SdpContents &offer)
	called when an offer is received - must send an answer soon after this

virtual void	onOfferRequired (resip::InviteSessionHandle, const resip::SipMessage &msg)
	called when an Invite w/out offer is sent, or any other context which requires an offer from the user

virtual void	onOfferRejected (resip::InviteSessionHandle, const resip::SipMessage *msg)
	called if an offer in a UPDATE or re-INVITE was rejected - not real useful.

virtual void	onOfferRequestRejected (resip::InviteSessionHandle, const resip::SipMessage &msg)
	Called when an error response is received for a reinvite-nobody request (via requestOffer)

virtual void	onRemoteSdpChanged (resip::InviteSessionHandle, const resip::SipMessage &msg, const resip::SdpContents &sdp)
	called when a modified body is received in a 2xx response to a session-timer reINVITE.

virtual void	onInfo (resip::InviteSessionHandle, const resip::SipMessage &msg)
	called when INFO message is received the application must call acceptNIT() or rejectNIT() once it is ready for another message.

virtual void	onInfoSuccess (resip::InviteSessionHandle, const resip::SipMessage &msg)
	called when response to INFO message is received

virtual void	onInfoFailure (resip::InviteSessionHandle, const resip::SipMessage &msg)

virtual void	onRefer (resip::InviteSessionHandle, resip::ServerSubscriptionHandle, const resip::SipMessage &msg)
	called when an REFER message is received.

virtual void	onReferAccepted (resip::InviteSessionHandle, resip::ClientSubscriptionHandle, const resip::SipMessage &msg)
	called when an REFER message receives an accepted response

virtual void	onReferRejected (resip::InviteSessionHandle, const resip::SipMessage &msg)
	called when an REFER message receives a failure response

virtual void	onReferNoSub (resip::InviteSessionHandle, const resip::SipMessage &msg)

virtual void	onMessage (resip::InviteSessionHandle, const resip::SipMessage &msg)
	called when MESSAGE message is received

virtual void	onMessageSuccess (resip::InviteSessionHandle, const resip::SipMessage &msg)
	called when response to MESSAGE message is received

virtual void	onMessageFailure (resip::InviteSessionHandle, const resip::SipMessage &msg)

virtual void	onForkDestroyed (resip::ClientInviteSessionHandle)
	called when a fork that was created through a 1xx never receives a 2xx because another fork answered and this fork was canceled by a proxy.

virtual void	onTrying (resip::AppDialogSetHandle, const resip::SipMessage &msg)

virtual void	onNonDialogCreatingProvisional (resip::AppDialogSetHandle, const resip::SipMessage &msg)

virtual void	onUpdatePending (resip::ClientSubscriptionHandle h, const resip::SipMessage &notify, bool outOfOrder)

virtual void	onUpdateActive (resip::ClientSubscriptionHandle h, const resip::SipMessage &notify, bool outOfOrder)

virtual void	onUpdateExtension (resip::ClientSubscriptionHandle, const resip::SipMessage &notify, bool outOfOrder)

virtual void	onTerminated (resip::ClientSubscriptionHandle h, const resip::SipMessage *notify)

virtual void	onNewSubscription (resip::ClientSubscriptionHandle h, const resip::SipMessage &notify)

virtual int	onRequestRetry (resip::ClientSubscriptionHandle h, int retryMinimum, const resip::SipMessage &notify)

virtual void	onNewSubscription (resip::ServerSubscriptionHandle, const resip::SipMessage &sub)

virtual void	onNewSubscriptionFromRefer (resip::ServerSubscriptionHandle, const resip::SipMessage &sub)

virtual void	onRefresh (resip::ServerSubscriptionHandle, const resip::SipMessage &sub)

virtual void	onTerminated (resip::ServerSubscriptionHandle)

virtual void	onReadyToSend (resip::ServerSubscriptionHandle, resip::SipMessage &)

virtual void	onNotifyRejected (resip::ServerSubscriptionHandle, const resip::SipMessage &msg)

virtual void	onError (resip::ServerSubscriptionHandle, const resip::SipMessage &msg)

virtual void	onExpiredByClient (resip::ServerSubscriptionHandle, const resip::SipMessage &sub, resip::SipMessage &notify)

virtual void	onExpired (resip::ServerSubscriptionHandle, resip::SipMessage &notify)

virtual bool	hasDefaultExpires () const
	dcm! – a bit clunky, but really want these objects to not have state

virtual uint32_t	getDefaultExpires () const

virtual void	onSuccess (resip::ClientOutOfDialogReqHandle, const resip::SipMessage &response)

virtual void	onFailure (resip::ClientOutOfDialogReqHandle, const resip::SipMessage &response)

virtual void	onReceivedRequest (resip::ServerOutOfDialogReqHandle, const resip::SipMessage &request)

virtual void	onRedirectReceived (resip::AppDialogSetHandle, const resip::SipMessage &response)

virtual bool	onTryingNextTarget (resip::AppDialogSetHandle, const resip::SipMessage &request)

virtual void	onSuccess (resip::ClientPagerMessageHandle, const resip::SipMessage &status)

virtual void	onFailure (resip::ClientPagerMessageHandle, const resip::SipMessage &status, std::unique_ptr< resip::Contents > contents)
	kh!

virtual void	onMessageArrived (resip::ServerPagerMessageHandle, const resip::SipMessage &message)

UserAgent *	getUserAgent ()

ParticipantHandle	getNewParticipantHandle ()

void	post (resip::Message *message)

void	post (resip::ApplicationMessage &message, std::chrono::duration< double > duration=std::chrono::milliseconds::zero())

virtual void	setUserAgent (UserAgent *userAgent)

std::shared_ptr< BridgeMixer > &	getBridgeMixer ()

ConversationHandle	getNewConversationHandle ()

Conversation *	getConversation (ConversationHandle convHandle)

std::set< ConversationHandle >	getConversationHandles () const

std::set< ParticipantHandle >	getParticipantHandlesByType (ParticipantType participantType) const

bool	isShuttingDown ()

bool	remoteParticipantInitialHold ()

const std::vector< int > &	keyframeIntervals () const

Friends
class	MediaStackAdapter

class	DefaultDialogSet

class	Subscription

class	UserAgentShutdownCmd

class	Conversation

class	SipXConversation

class	OutputBridgeMixWeightsCmd

class	Participant

class	RemoteParticipant

class	RemoteIMPagerParticipant

class	SipXRemoteParticipant

class	RemoteIMSessionParticipant

class	UserAgent

class	DtmfEvent

class	MediaEvent

class	RemoteParticipantDialogSet

class	SipXRemoteParticipantDialogSet

class	MediaResourceParticipant

class	SipXMediaResourceParticipant

class	LocalParticipant

class	BridgeMixer

class	SipXMediaInterface

class	MediaResourceParticipantDeleterCmd

class	CreateConversationCmd

class	DestroyConversationCmd

class	JoinConversationCmd

class	CreateRemoteParticipantCmd

class	CreateMediaResourceParticipantCmd

class	CreateLocalParticipantCmd

class	DestroyParticipantCmd

class	AddParticipantCmd

class	RemoveParticipantCmd

class	MoveParticipantCmd

class	ModifyParticipantContributionCmd

class	ModifyParticipantRecordChannelCmd

class	AlertParticipantCmd

class	AnswerParticipantCmd

class	RejectParticipantCmd

class	RedirectParticipantCmd

class	RedirectToParticipantCmd

class	HoldParticipantCmd

class	CreateRemoteIMPagerParticipantCmd

class	SendIMToParticipantCmd

class	RequestKeyframeCmd

class	RequestKeyframeFromPeerCmd

class	RequestKeyframeFromPeerRecurringCmd

class	MediaStreamReadyEvent

class	MediaStreamErrorEvent

Detailed Description

This class is one of two main classes of concern to an application using the UserAgent library.

This class should be subclassed by the application and the ConversationManager handlers should be implemented by it.

This class is responsible for handling tasks that are directly related to managing Conversations. All non-conversation handling is done via the UserAgent class.

This class handles tasks such as: -Creation and destruction of Conversations -Participant management and creation -Placing and receiving calls -Playing audio and/or tones into a conversation -Managing local audio properties

Author: Scott Godin (sgodin AT SipSpectrum DOT com)

Definition at line 63 of file ConversationManager.hxx.

Member Enumeration Documentation

◆ AutoHoldMode

enum recon::ConversationManager::AutoHoldMode

Enumerator
AutoHoldDisabled
AutoHoldEnabled
AutoHoldBroadcastOnly

Definition at line 109 of file ConversationManager.hxx.

◆ ParticipantForkSelectMode

enum recon::ConversationManager::ParticipantForkSelectMode

Enumerator
ForkSelectAutomatic
ForkSelectManual
ForkSelectAutomaticEx

Definition at line 88 of file ConversationManager.hxx.

◆ ParticipantType

enum recon::ConversationManager::ParticipantType

Enumerator
ParticipantType_Local
ParticipantType_Remote
ParticipantType_MediaResource
ParticipantType_RemoteIMPager
ParticipantType_RemoteIMSession

Definition at line 78 of file ConversationManager.hxx.

◆ RedirectSuccessCondition

enum recon::ConversationManager::RedirectSuccessCondition

Enumerator
RedirectSuccessOnTrying
RedirectSuccessOnRinging
RedirectSuccessOnConnected

Definition at line 125 of file ConversationManager.hxx.

Constructor & Destructor Documentation

◆ ConversationManager()

ConversationManager::ConversationManager	(	std::shared_ptr< MediaStackAdapter >	mediaStackAdapter,
		std::shared_ptr< resip::ConfigParse >	configParse = `std::shared_ptr<resip::ConfigParse>()`
	)

Definition at line 37 of file ConversationManager.cxx.

◆ ~ConversationManager()

ConversationManager::~ConversationManager ( )

virtual

Definition at line 56 of file ConversationManager.cxx.

Member Function Documentation

◆ addBufferToMediaResourceCache()

void ConversationManager::addBufferToMediaResourceCache	(	const resip::Data &	name,
		const resip::Data &	buffer,
		int	type
	)

virtual

This function is used to add a chunk of memory to a media/prompt cache.

Cached prompts can later be played back via createMediaParticipant. Expected format is 1-channel 16-bit 8Khz linear PCM (Assuming sipX and
the media framework running at 8Khz). Note: The caller is free to dispose of the memory upon return.

Parameters

name	name of the cached item - used for playback
buffer	Data object containing the media
type	Type of media that is being added. (RAW_PCM_16 = 0)

Definition at line 475 of file ConversationManager.cxx.

◆ addParticipant()

void ConversationManager::addParticipant	(	ConversationHandle	convHandle,
		ParticipantHandle	partHandle
	)

virtual

Adds the specified participant to the specified conversation.

Parameters

convHandle	Handle of the conversation to add to
partHandle	Handle of the participant to add

Note: When running in sipXConversationMediaInterfaceMode you can only add a non-local participant to multiple conversations if they share the same media interface.

Definition at line 237 of file ConversationManager.cxx.

◆ alertParticipant()

void ConversationManager::alertParticipant	(	ParticipantHandle	partHandle,
		bool	earlyFlag = `true`
	)

virtual

Signal to the participant that it should provide ringback.

Only applicable to RemoteParticipants. For SIP this causes a 180 to be sent. The early flag indicates if we are sending early media or not. (ie. For SIP - SDP in 180).

Parameters

partHandle	Handle of the participant to alert
earlyFlag	Set to true to send early media

Definition at line 279 of file ConversationManager.cxx.

◆ answerParticipant()

void ConversationManager::answerParticipant ( ParticipantHandle partHandle )

virtual

Signal to the participant that the call is answered.

Only applicable to RemoteParticipants. For SIP this causes a 200 to be sent.

Parameters

partHandle Handle of the participant to answer

Definition at line 286 of file ConversationManager.cxx.

◆ createAppropriateRemoteParticipantInstance() [1/2]

RemoteParticipant * ConversationManager::createAppropriateRemoteParticipantInstance	(	ParticipantHandle	partHandle,
		resip::DialogUsageManager &	dum,
		RemoteParticipantDialogSet &	rpds
	)

virtual

Definition at line 555 of file ConversationManager.cxx.

◆ createAppropriateRemoteParticipantInstance() [2/2]

RemoteParticipant * ConversationManager::createAppropriateRemoteParticipantInstance	(	resip::DialogUsageManager &	dum,
		RemoteParticipantDialogSet &	rpds
	)

virtual

Definition at line 540 of file ConversationManager.cxx.

◆ createConversation()

ConversationHandle ConversationManager::createConversation ( AutoHoldMode autoHoldMode = AutoHoldEnabled )

virtual

Create a new empty Conversation to which participants can be added.

Parameters

autoHoldMode - enum specifying one of the following: AutoHoldDisabled - Never auto hold, only hold if holdParticipant API is used AutoHoldEnabled - Default. Automatically put a RemoteParticipant on-hold if there are no other participants in the conversation with them. AutoHoldBroadcastOnly - Use this if you are broadcasting media to all participants and don't need to receive any inbound media. All participants in the conversation will be SIP held and will receive media from an added MediaParticipant. Remote offers with inactive will be responded with sendonly as well. This option is useful for implementing music on hold servers.

Returns: A handle to the newly created conversation.

Definition at line 137 of file ConversationManager.cxx.

◆ createLocalParticipant()

ParticipantHandle ConversationManager::createLocalParticipant ( )

virtual

Creates a new local participant in the specified conversation (if supported).

A local participant is a representation of the local source (speaker) and sink (microphone). The local participant is generally only created once and is added to conversations in which the local speaker and/or microphone should be involved.

Returns: A handle to the newly created local participant

Definition at line 210 of file ConversationManager.cxx.

◆ createMediaResourceParticipant()

ParticipantHandle ConversationManager::createMediaResourceParticipant	(	ConversationHandle	convHandle,
		const resip::Uri &	mediaUrl,
		const std::shared_ptr< resip::Data > &	playAudioBuffer = `std::shared_ptr<resip::Data>()`,
		void *	recordingCircularBuffer = `0`
	)

virtual

Creates a new media resource participant in the specified conversation.

Media is played from a source specified by the url and may be a local audio file or built-in tone. The URL can contain parameters that specify properties of the media playback, such as number of repeats.

Media Urls are of the following format: tone:<tone> - Tones can be any DTMF digit 0-9,*,#,A-D or a special tone: dialtone, busy, fastbusy, ringback, ring, backspace, callwaiting, holding, or loudfastbusy file:<filepath> - If filename only, then reads from application directory (Use | instead of : for drive specifier) cache:<cache-name> - You can play from a memory buffer/cache any items you have added with the addBufferToMediaResourceCache api. record:<filepath> - Single channel recorder. If filename only, then writes to application directory. Use | instead of : for drive specifier. ;append parameter specifies to append to an existing recording record:circularbuffer - Single channel recorded audio is written to provided media specific CircularBuffer record-mc:<filepath> - Multichannel recorder. If filename only, then writes to application directory. Use | instead of : for drive specifier. ;append parameter specifies to append to an existing recording ;numchannels parameter specifies either 1 or 2 channels of recording record-mc:circularbuffer - Multichannel recorded audio is written to provided media specific CircularBuffer. ;numchannels parameter specifies either 1 or 2 channels of recording buffer:<type> - For sipXtapi the only allowed type is RAW_PCM_16, the sampling rate is expected to be 8khz.

other optional parameters are: [;duration=<milliseconds>][;repeat][silencetime=<milliseconds>][;format=<recording_format>][;startoffset=<milliseconds>]

'duration' parameter will automatically stop playback if file is longer than duration. For recording, parameter specifies max recording length in Ms
'repeat' parameter only makes sense for file and cache playback scheme's
'silencetime' parameter specifies ms of silence to end recording
'format' parameter only makes sense for recording scheme's. Possible values: WAV_PCM16, WAV_MULAW, WAV_ALAW, WAV_GSM, OGG_OPUS
'startoffset' parameter specifies an offset, in milliseconds, that the file or buffer will start playing from.
Note
audio files may be AU, WAV or RAW formats. Audiofiles should be 16bit mono, 8khz, PCM to avoid runtime conversion.

http referenced audio files must be WAV files, 16 or 8bit, 8Khz, Mono.
Sample mediaUrls: tone:0 - play DTMF tone 0 until participant is destroyed tone:1;duration=1000 - play DTMF tone 1 for 1000ms, then automatically destroy participant tone:ringback - play special tone "Ringback" to conversation until participant is manually destroyed file:ringback.wav - play the file ringback.wav until completed (automatically destroyed) or participant is manually destroyed file:ringback.wav;duration=1000 - play the file ringback.wav for 1000ms (or until completed, if shorter), then automatically destroy participant file:ringback.wav;repeat - play the file ringback.wav, repeating when complete until participant is destroyed file:hi.wav;repeat;duration=9000 - play the file hi.wav for 9000ms, repeating as required, then automatically destroy the participant file:music.wav;startoffset=2500 - play the file music.wav starting 2.5 seconds into the file, until completed or participant is manually destroyed cache:welcomeprompt - plays a prompt from the media cache with key/name "welcomeprompt" record:recording.wav - records all participants audio mixed together in a WAV file of type WAV_PCM16, must be manually destroyed record:recording.ogg;format=OGG_OPUS - records all participants audio mixed together in an Opus encoded OGG file, must be manually destroyed record:recording.wav;duration=30000;silencetime=5000 - records all participants audio mixed togehter in a WAV file, for up to 5 mins, stop automatically when voice is missing for 5 seconds record:circularbuffer;format=WAV_PCM16 - records all participants audio mixed together as PCM16 in the provided ciruclar buffer (no WAV header is generated). Must be manually destroyed. record-mc:circularbuffer;format=WAV_PCM16;numchannels=2 - records all parties in the left channel unless they have channel 2 recording enabled via the modifyParticipantRecordChannel API, then they are mixed into the right channel. Use PCM16 format and output to the provided ciruclar buffer (no WAV header is generated). Must be manually destroyed. buffer:RAW_PCM_16;repeat - plays the audio from the provided playAudioBuffer parameter, repeating when complete until participant is destroyed

Parameters

convHandle	Handle of the conversation to create the MediaParticipant in
mediaUrl	Url of media to play. See above.
playAudioBuffer	- Shared_ptr to a data object containing the raw audio buffer to play out. Only provide this parameter if using buffer: as the mediaUrl scheme
recordingCircularBuffer	- a pointer to media stack specific circular buffer implementation to pass to the recorder. Audio can be read from the circular buffer as it is being recorded. For sipXtapi, this implementation is of type utl\CircularBufferPtr.h

Returns: A handle to the newly created media participant

Definition at line 198 of file ConversationManager.cxx.

◆ createRemoteIMPagerParticipant()

ParticipantHandle ConversationManager::createRemoteIMPagerParticipant	(	const resip::NameAddr &	destination,
		const std::shared_ptr< ConversationProfile > &	conversationProfile = `nullptr`
	)

virtual

Creates a new remote IM participant that will be attempted to be reached when sendIMToParticipant is called.

This IM Participant will use Pager Mode IM sending. ie: Out-of-dialog SIP MESSAGE requests. Uses the specified conversation profile.

Parameters

destination	Uri of the remote IM participant
conversationProfile	- a specific ConversationProfile to use for this session

Returns: A handle to the newly created remote IM participant

Definition at line 174 of file ConversationManager.cxx.

◆ createRemoteIMSessionParticipant()

ParticipantHandle ConversationManager::createRemoteIMSessionParticipant	(	const resip::NameAddr &	destination,
		ParticipantForkSelectMode	forkSelectMode = `ForkSelectAutomatic`,
		const std::shared_ptr< ConversationProfile > &	callerProfile = `nullptr`,
		const std::multimap< resip::Data, resip::Data > &	extraHeaders = `std::multimap<resip::Data, resip::Data>()`
	)

virtual

Creates a new remote IM participant that will attempted to be reached immediately at the specified address.

This IM Partcipant will use an INVITE session with m=message specifier in the SDP. ForkSelectMode can be set to either automatic or manual. When ForkSelectMode is set to auto the conversation manager will automatically dispose of any related conversations that were created, due to forking.

Parameters

destination	Uri of the remote participant to reach
forkSelectMode	Determines behavior if forking occurs
conversationProfile	- a specific ConversationProfile to use for this session
extraHeaders	- a multimap of header names and values to add to the resulting INVITE request

Returns: A handle to the newly created remote participant

Definition at line 186 of file ConversationManager.cxx.

◆ createRemoteIMSessionParticipantDialogSetInstance()

RemoteParticipantDialogSet * ConversationManager::createRemoteIMSessionParticipantDialogSetInstance	(	ConversationManager::ParticipantForkSelectMode	forkSelectMode = `ConversationManager::ForkSelectAutomatic`,
		std::shared_ptr< ConversationProfile >	conversationProfile = `nullptr`
	)

virtual

Definition at line 570 of file ConversationManager.cxx.

◆ createRemoteParticipant()

ParticipantHandle ConversationManager::createRemoteParticipant	(	ConversationHandle	convHandle,
		const resip::NameAddr &	destination,
		ParticipantForkSelectMode	forkSelectMode = `ForkSelectAutomatic`,
		const std::shared_ptr< ConversationProfile > &	conversationProfile = `nullptr`,
		const std::multimap< resip::Data, resip::Data > &	extraHeaders = `std::multimap<resip::Data, resip::Data>()`
	)

virtual

Creates a new remote participant in the specified conversation that is attempted to be reached at the specified address.

For SIP the address is a URI. ForkSelectMode can be set to either automatic or manual. When ForkSelectMode is set to auto the conversation manager will automatically dispose of any related conversations that were created, due to forking.

Parameters

convHandle	Handle of the conversation to create the RemoteParticipant in
destination	Uri of the remote participant to reach
forkSelectMode	Determines behavior if forking occurs
conversationProfile	- a specific ConversationProfile to use for this session
extraHeaders	- a multimap of header names and values to add to the resulting INVITE request

Returns: A handle to the newly created remote participant

Definition at line 162 of file ConversationManager.cxx.

◆ destroyConversation()

void ConversationManager::destroyConversation ( ConversationHandle convHandle )

virtual

Destroys an existing Conversation, and ends all participants that solely belong to this conversation.

Parameters

handle Handle of conversation to destroy

Definition at line 148 of file ConversationManager.cxx.

◆ destroyParticipant()

void ConversationManager::destroyParticipant ( ParticipantHandle partHandle )

virtual

Ends connections to the participant and removes it from all active conversations.

Parameters

partHandle Handle of the participant to destroy

Definition at line 230 of file ConversationManager.cxx.

◆ getBridgeMixer()

std::shared_ptr< BridgeMixer > & recon::ConversationManager::getBridgeMixer ( )

inlineprotected

Definition at line 853 of file ConversationManager.hxx.

◆ getBufferFromMediaResourceCache()

bool ConversationManager::getBufferFromMediaResourceCache	(	const resip::Data &	name,
		resip::Data **	buffer,
		int *	type
	)

virtual

This function is used to retrieve a chunk of memory from the media/prompt cache.

This method is also called internally. So appliations wishing to provide their own cache logic can override this method.

Parameters

name	name of the cached item - used for playback
buffer	A pointer to Data object pointer object containing the media
type	A pointer to the Type of media from the cache. (Currently always: RAW_PCM_16 = 0)

Definition at line 481 of file ConversationManager.cxx.

◆ getConfig()

std::shared_ptr< resip::ConfigParse > recon::ConversationManager::getConfig ( )

inline

Definition at line 763 of file ConversationManager.hxx.

◆ getConversation()

Conversation * ConversationManager::getConversation ( ConversationHandle convHandle )

protected

Definition at line 441 of file ConversationManager.cxx.

◆ getConversationHandles()

std::set< ConversationHandle > ConversationManager::getConversationHandles ( ) const

protected

Definition at line 455 of file ConversationManager.cxx.

◆ getDefaultExpires()

uint32_t ConversationManager::getDefaultExpires ( ) const

protectedvirtual

Reimplemented from resip::ServerSubscriptionHandler.

Definition at line 938 of file ConversationManager.cxx.

◆ getMediaStackAdapter()

MediaStackAdapter & recon::ConversationManager::getMediaStackAdapter ( )

inline

Definition at line 761 of file ConversationManager.hxx.

◆ getNewConversationHandle()

ConversationHandle ConversationManager::getNewConversationHandle ( )

protected

Definition at line 342 of file ConversationManager.cxx.

◆ getNewParticipantHandle()

ParticipantHandle ConversationManager::getNewParticipantHandle ( )

protected

Definition at line 366 of file ConversationManager.cxx.

◆ getParticipantHandlesByType()

std::set< ParticipantHandle > ConversationManager::getParticipantHandlesByType ( ParticipantType participantType ) const

protected

Definition at line 462 of file ConversationManager.cxx.

◆ getUserAgent()

UserAgent * recon::ConversationManager::getUserAgent ( )

inlineprotected

Definition at line 843 of file ConversationManager.hxx.

◆ hasDefaultExpires()

bool ConversationManager::hasDefaultExpires ( ) const

protectedvirtual

dcm! – a bit clunky, but really want these objects to not have state

Reimplemented from resip::ServerSubscriptionHandler.

Definition at line 932 of file ConversationManager.cxx.

◆ holdParticipant()

void ConversationManager::holdParticipant	(	ParticipantHandle	partHandle,
		bool	hold
	)

virtual

Manually puts a paricipant on hold, or takes off hold without needing to move it in and out of any conversations.

Parameters

partHandle	Handle of the participant to redirect
hold	true to put the remote participant on hold, false to unhold

Definition at line 314 of file ConversationManager.cxx.

◆ isShuttingDown()

bool recon::ConversationManager::isShuttingDown ( )

inlineprotected

Definition at line 861 of file ConversationManager.hxx.

◆ joinConversation()

void ConversationManager::joinConversation	(	ConversationHandle	sourceConvHandle,
		ConversationHandle	destConvHandle
	)

virtual

Joins all participants from source conversation into destination conversation and destroys source conversation.

Parameters

sourceConvHandle	Handle of source conversation
destConvHandle	Handle of destination conversation

Definition at line 155 of file ConversationManager.cxx.

◆ keyframeIntervals()

const std::vector< int > & recon::ConversationManager::keyframeIntervals ( ) const

inlineprotected

Definition at line 864 of file ConversationManager.hxx.

◆ modifyParticipantContribution()

void ConversationManager::modifyParticipantContribution	(	ConversationHandle	convHandle,
		ParticipantHandle	partHandle,
		unsigned int	inputGain,
		unsigned int	outputGain
	)

virtual

Modifies how the participant contributes to the particular conversation.

The send and receive gain can be set to a number between 0 and 100.

Parameters

convHandle	Handle of the conversation to apply modification to
partHandle	Handle of the participant to modify

Definition at line 258 of file ConversationManager.cxx.

◆ modifyParticipantRecordChannel()

void ConversationManager::modifyParticipantRecordChannel	(	ParticipantHandle	partHandle,
		unsigned int	channelNum
	)

virtual

If the participant is mixed to a multi-channel recording resource, then this controls if a participants audio is mixed into channel 1 or channel 2.

By default participants mix to channel 1 (left). Set to 2 to have participants audio is mixed to the right/secondary channel of the recording.

Parameters

partHandle	Handle of the participant to modify
channelNum	The channel number to mix audio to. 1 (default) or 2.

Definition at line 265 of file ConversationManager.cxx.

◆ moveParticipant()

void ConversationManager::moveParticipant	(	ParticipantHandle	partHandle,
		ConversationHandle	sourceConvHandle,
		ConversationHandle	destConvHandle
	)

virtual

Removed the specified participant from the specified conversation.

The participants media to/from the conversation is stopped. If the participant no longer exists in any conversation, then they are destroyed. For a remote participant this means the call will be released.

Parameters

partHandle	Handle of the participant to move
sourceConvHandle	Handle of the conversation to move from
destConvHandle	Handle of the conversation to move to

Note: When running in sipXConversationMediaInterfaceMode you can only move a non-local participant between conversations if they share the same media interface.

Definition at line 251 of file ConversationManager.cxx.

◆ onAnswer()

void ConversationManager::onAnswer	(	resip::InviteSessionHandle	,
		const resip::SipMessage &	msg,
		const resip::SdpContents &
	)

protectedvirtual

called when an answer is received - has nothing to do with user answering the call

Implements resip::InviteSessionHandler.

Definition at line 652 of file ConversationManager.cxx.

◆ onApplicationTimer()

virtual void recon::ConversationManager::onApplicationTimer	(	unsigned int	timerId,
		unsigned int	timerData1,
		unsigned int	timerData2
	)

inlinevirtual

Definition at line 526 of file ConversationManager.hxx.

◆ onConnected() [1/2]

void ConversationManager::onConnected	(	resip::ClientInviteSessionHandle	,
		const resip::SipMessage &	msg
	)

protectedvirtual

called when a dialog initiated as a UAC enters the connected state

Implements resip::InviteSessionHandler.

Definition at line 616 of file ConversationManager.cxx.

◆ onConnected() [2/2]

void ConversationManager::onConnected	(	resip::InviteSessionHandle	,
		const resip::SipMessage &	msg
	)

protectedvirtual

called when a dialog initiated as a UAS enters the connected state

Implements resip::InviteSessionHandler.

Definition at line 622 of file ConversationManager.cxx.

◆ onConnectedConfirmed()

void ConversationManager::onConnectedConfirmed	(	resip::InviteSessionHandle	handle,
		const resip::SipMessage &	msg
	)

protectedvirtual

called when ACK (with out an answer) is received for initial invite (UAS)

Reimplemented from resip::InviteSessionHandler.

Definition at line 628 of file ConversationManager.cxx.

◆ onConversationDestroyed()

virtual void recon::ConversationManager::onConversationDestroyed ( ConversationHandle convHandle )

pure virtual

Notifies an application when a conversation has been destroyed.

This is useful for tracking conversations that get created when forking occurs, and are destroyed when forked call is answered or ended.

Parameters

convHandle Handle of the destroyed conversation

Implemented in mohparkserver::Server.

◆ onDtmfEvent()

virtual void recon::ConversationManager::onDtmfEvent	(	ParticipantHandle	partHandle,
		int	dtmf,
		int	duration,
		bool	up
	)

pure virtual

Notifies an application when an RFC2833 DTMF event is received from a particular remote participant.

Parameters

partHandle	Handle of the participant that received the digit
dtmf	Integer representation of the DTMF tone received (from RFC2833 event codes)
duration	Duration (in milliseconds) of the DTMF tone received
up	Set to true if the DTMF key is up (otherwise down)

Implemented in mohparkserver::Server.

◆ onEarlyMedia()

void ConversationManager::onEarlyMedia	(	resip::ClientInviteSessionHandle	,
		const resip::SipMessage &	,
		const resip::SdpContents &
	)

protectedvirtual

called when an in-dialog provisional response is received that contains a body

Implements resip::InviteSessionHandler.

Definition at line 604 of file ConversationManager.cxx.

◆ onError()

void ConversationManager::onError	(	resip::ServerSubscriptionHandle	,
		const resip::SipMessage &	msg
	)

protectedvirtual

Reimplemented from resip::ServerSubscriptionHandler.

Definition at line 914 of file ConversationManager.cxx.

◆ onExpired()

void ConversationManager::onExpired	(	resip::ServerSubscriptionHandle	,
		resip::SipMessage &	notify
	)

protectedvirtual

Reimplemented from resip::ServerSubscriptionHandler.

Definition at line 926 of file ConversationManager.cxx.

◆ onExpiredByClient()

void ConversationManager::onExpiredByClient	(	resip::ServerSubscriptionHandle	,
		const resip::SipMessage &	sub,
		resip::SipMessage &	notify
	)

protectedvirtual

Reimplemented from resip::ServerSubscriptionHandler.

Definition at line 920 of file ConversationManager.cxx.

◆ onFailure() [1/3]

void ConversationManager::onFailure	(	resip::ClientInviteSessionHandle	,
		const resip::SipMessage &	msg
	)

protectedvirtual

Received a failure response from UAS.

Implements resip::InviteSessionHandler.

Definition at line 598 of file ConversationManager.cxx.

◆ onFailure() [2/3]

void ConversationManager::onFailure	(	resip::ClientOutOfDialogReqHandle	,
		const resip::SipMessage &	response
	)

protectedvirtual

Implements resip::OutOfDialogHandler.

Definition at line 953 of file ConversationManager.cxx.

◆ onFailure() [3/3]

void ConversationManager::onFailure	(	resip::ClientPagerMessageHandle	,
		const resip::SipMessage &	status,
		std::unique_ptr< resip::Contents >	contents
	)

protectedvirtual

kh!

Implements resip::ClientPagerMessageHandler.

Definition at line 1075 of file ConversationManager.cxx.

◆ onForkDestroyed()

void ConversationManager::onForkDestroyed ( resip::ClientInviteSessionHandle )

protectedvirtual

called when a fork that was created through a 1xx never receives a 2xx because another fork answered and this fork was canceled by a proxy.

Implements resip::InviteSessionHandler.

Definition at line 748 of file ConversationManager.cxx.

◆ onIncomingIMPagerParticipant()

virtual void recon::ConversationManager::onIncomingIMPagerParticipant	(	ParticipantHandle	partHandle,
		const resip::SipMessage &	msg,
		ConversationProfile &	conversationProfile
	)

inlinevirtual

Notifies an application about a new remote IM pager mode participant that has sent a message.

Parameters

partHandle	Handle of the new incoming IM participant
msg	Includes information about the sender such as name and address, and the body of the initial IM message. Note: If answerParticpant is called then the same message will be sent to the app again in a call to onReceiveIMFromParticipant. Content processing should be done in the onReceiveIMFromParticipant callback.

Definition at line 555 of file ConversationManager.hxx.

◆ onIncomingIMSessionParticipant()

virtual void recon::ConversationManager::onIncomingIMSessionParticipant	(	ParticipantHandle	partHandle,
		const resip::SipMessage &	msg,
		bool	autoAnswer,
		ConversationProfile &	conversationProfile
	)

inlinevirtual

Notifies an application about a new remote IM session mode participant that has sent an INVITE.

Parameters

partHandle	Handle of the new incoming IM participant
msg	Includes information about the sender such as name and address
autoAnswer	Set to true if auto answer has been requested

Definition at line 564 of file ConversationManager.hxx.

◆ onIncomingParticipant()

virtual void recon::ConversationManager::onIncomingParticipant	(	ParticipantHandle	partHandle,
		const resip::SipMessage &	msg,
		bool	autoAnswer,
		ConversationProfile &	conversationProfile
	)

pure virtual

Notifies an application about a new remote participant that is attempting to contact it.

Parameters

partHandle	Handle of the new incoming participant
msg	Includes information about the caller such as name and address
autoAnswer	Set to true if auto answer has been requested

Implemented in mohparkserver::Server.

◆ onInfo()

void ConversationManager::onInfo	(	resip::InviteSessionHandle	,
		const resip::SipMessage &	msg
	)

protectedvirtual

called when INFO message is received the application must call acceptNIT() or rejectNIT() once it is ready for another message.

Implements resip::InviteSessionHandler.

Definition at line 688 of file ConversationManager.cxx.

◆ onInfoFailure()

void ConversationManager::onInfoFailure	(	resip::InviteSessionHandle	h,
		const resip::SipMessage &	msg
	)

protectedvirtual

Implements resip::InviteSessionHandler.

Definition at line 700 of file ConversationManager.cxx.

◆ onInfoSuccess()

void ConversationManager::onInfoSuccess	(	resip::InviteSessionHandle	,
		const resip::SipMessage &	msg
	)

protectedvirtual

called when response to INFO message is received

Implements resip::InviteSessionHandler.

Definition at line 694 of file ConversationManager.cxx.

◆ onMediaResourceParticipantFailed()

virtual void recon::ConversationManager::onMediaResourceParticipantFailed ( ParticipantHandle partHandle )

inlinevirtual

Notifies an application about a failure in a media resource participant.

Parameters

partHandle	Handle of the participant that terminated
statusCode	The status Code for the failure.

Definition at line 752 of file ConversationManager.hxx.

◆ onMessage()

void ConversationManager::onMessage	(	resip::InviteSessionHandle	,
		const resip::SipMessage &	msg
	)

protectedvirtual

called when MESSAGE message is received

Implements resip::InviteSessionHandler.

Definition at line 730 of file ConversationManager.cxx.

◆ onMessageArrived()

void ConversationManager::onMessageArrived	(	resip::ServerPagerMessageHandle	h,
		const resip::SipMessage &	message
	)

protectedvirtual

Implements resip::ServerPagerMessageHandler.

Definition at line 1085 of file ConversationManager.cxx.

◆ onMessageFailure()

void ConversationManager::onMessageFailure	(	resip::InviteSessionHandle	h,
		const resip::SipMessage &	msg
	)

protectedvirtual

Implements resip::InviteSessionHandler.

Definition at line 742 of file ConversationManager.cxx.

◆ onMessageSuccess()

void ConversationManager::onMessageSuccess	(	resip::InviteSessionHandle	,
		const resip::SipMessage &	msg
	)

protectedvirtual

called when response to MESSAGE message is received

Implements resip::InviteSessionHandler.

Definition at line 736 of file ConversationManager.cxx.

◆ onNewSession() [1/2]

void ConversationManager::onNewSession	(	resip::ClientInviteSessionHandle	,
		resip::InviteSession::OfferAnswerType	oat,
		const resip::SipMessage &	msg
	)

protectedvirtual

called when an initial INVITE or the intial response to an outoing invite

Implements resip::InviteSessionHandler.

Definition at line 586 of file ConversationManager.cxx.

◆ onNewSession() [2/2]

void ConversationManager::onNewSession	(	resip::ServerInviteSessionHandle	h,
		resip::InviteSession::OfferAnswerType	oat,
		const resip::SipMessage &	msg
	)

protectedvirtual

Implements resip::InviteSessionHandler.

Definition at line 592 of file ConversationManager.cxx.

◆ onNewSubscription() [1/2]

void ConversationManager::onNewSubscription	(	resip::ClientSubscriptionHandle	h,
		const resip::SipMessage &	notify
	)

protectedvirtual

Implements resip::ClientSubscriptionHandler.

Definition at line 812 of file ConversationManager.cxx.

◆ onNewSubscription() [2/2]

void ConversationManager::onNewSubscription	(	resip::ServerSubscriptionHandle	,
		const resip::SipMessage &	sub
	)

protectedvirtual

Implements resip::ServerSubscriptionHandler.

Definition at line 827 of file ConversationManager.cxx.

◆ onNewSubscriptionFromRefer()

void ConversationManager::onNewSubscriptionFromRefer	(	resip::ServerSubscriptionHandle	ss,
		const resip::SipMessage &	sub
	)

protectedvirtual

Reimplemented from resip::ServerSubscriptionHandler.

Definition at line 833 of file ConversationManager.cxx.

◆ onNonDialogCreatingProvisional()

void ConversationManager::onNonDialogCreatingProvisional	(	resip::AppDialogSetHandle	h,
		const resip::SipMessage &	msg
	)

protectedvirtual

Implements resip::DialogSetHandler.

Definition at line 771 of file ConversationManager.cxx.

◆ onNotifyRejected()

void ConversationManager::onNotifyRejected	(	resip::ServerSubscriptionHandle	,
		const resip::SipMessage &	msg
	)

protectedvirtual

Reimplemented from resip::ServerSubscriptionHandler.

Definition at line 908 of file ConversationManager.cxx.

◆ onOffer()

void ConversationManager::onOffer	(	resip::InviteSessionHandle	,
		const resip::SipMessage &	msg,
		const resip::SdpContents &
	)

protectedvirtual

called when an offer is received - must send an answer soon after this

Implements resip::InviteSessionHandler.

Definition at line 658 of file ConversationManager.cxx.

◆ onOfferRejected()

void ConversationManager::onOfferRejected	(	resip::InviteSessionHandle	,
		const resip::SipMessage *	msg
	)

protectedvirtual

called if an offer in a UPDATE or re-INVITE was rejected - not real useful.

A SipMessage is provided if one is available

Implements resip::InviteSessionHandler.

Definition at line 670 of file ConversationManager.cxx.

◆ onOfferRequestRejected()

void ConversationManager::onOfferRequestRejected	(	resip::InviteSessionHandle	,
		const resip::SipMessage &	msg
	)

protectedvirtual

Called when an error response is received for a reinvite-nobody request (via requestOffer)

Reimplemented from resip::InviteSessionHandler.

Definition at line 676 of file ConversationManager.cxx.

◆ onOfferRequired()

void ConversationManager::onOfferRequired	(	resip::InviteSessionHandle	,
		const resip::SipMessage &	msg
	)

protectedvirtual

called when an Invite w/out offer is sent, or any other context which requires an offer from the user

Implements resip::InviteSessionHandler.

Definition at line 664 of file ConversationManager.cxx.

◆ onParticipantAlerting()

virtual void recon::ConversationManager::onParticipantAlerting	(	ParticipantHandle	partHandle,
		const resip::SipMessage &	msg
	)

pure virtual

Notifies an application that a remote participant call attempt is alerting the remote party.

Parameters

partHandle	Handle of the participant that is alerting
msg	SIP message that caused the alerting

Implemented in mohparkserver::Server.

◆ onParticipantConnected()

virtual void recon::ConversationManager::onParticipantConnected	(	ParticipantHandle	partHandle,
		const resip::SipMessage &	msg
	)

pure virtual

Notifies an application that a remote participant call attempt is now connected.

Parameters

partHandle	Handle of the participant that is connected
msg	SIP message that caused the connection

Implemented in mohparkserver::Server.

◆ onParticipantConnectedConfirmed()

virtual void recon::ConversationManager::onParticipantConnectedConfirmed	(	ParticipantHandle	partHandle,
		const resip::SipMessage &	msg
	)

inlinevirtual

Notifies an application that an inbound remote participant call now fully connected after answering (ie: ACK was received).

Parameters

partHandle	Handle of the participant that is connected confirmed
msg	SIP message that caused the connection

Definition at line 706 of file ConversationManager.hxx.

◆ onParticipantDestroyed() [1/2]

virtual void recon::ConversationManager::onParticipantDestroyed ( ParticipantHandle partHandle )

pure virtual

Notifies an application when a Participant has been destroyed.

This is useful for tracking when audio playback via MediaResourceParticipants has stopped.

Parameters

partHandle Handle of the destroyed participant

Implemented in mohparkserver::Server.

◆ onParticipantDestroyed() [2/2]

virtual void recon::ConversationManager::onParticipantDestroyed	(	ParticipantHandle	partHandle,
		ParticipantType	partType
	)

inlinevirtual

Notifies an application when a Participant has been destroyed.

This is useful for tracking when audio playback via MediaResourceParticipants has stopped.

If you override this version of the callback, then the version above will not be called, and you can implement it with an empty body. Implemented this way, so that we don't break ABI for existing applications.

Parameters

partHandle	Handle of the destroyed participant
partType	The type of participant being destroyed.

Definition at line 654 of file ConversationManager.hxx.

◆ onParticipantProceeding()

virtual void recon::ConversationManager::onParticipantProceeding	(	ParticipantHandle	partHandle,
		const resip::SipMessage &	msg
	)

inlinevirtual

Notifies an application that a remote participant call attempt is proceeding at the first hop.

ie: SIP 100/trying

Parameters

partHandle	Handle of the participant that is alerting
msg	SIP message that caused the proceeding

Reimplemented in mohparkserver::Server.

Definition at line 679 of file ConversationManager.hxx.

◆ onParticipantRedirectFailure()

virtual void recon::ConversationManager::onParticipantRedirectFailure	(	ParticipantHandle	partHandle,
		unsigned int	statusCode
	)

pure virtual

Notifies an application that a redirect request has failed.

Indicates blind transfer or attended transfer status.

Parameters

partHandle Handle of the participant that was redirected

Implemented in mohparkserver::Server.

◆ onParticipantRedirectSuccess()

virtual void recon::ConversationManager::onParticipantRedirectSuccess ( ParticipantHandle partHandle )

pure virtual

Notifies an application that a redirect request has succeeded.

Indicates blind transfer or attended transfer status.

Parameters

partHandle Handle of the participant that was redirected

Implemented in mohparkserver::Server.

◆ onParticipantRequestedHold()

virtual void recon::ConversationManager::onParticipantRequestedHold	(	ParticipantHandle	partHandle,
		bool	held
	)

pure virtual

Implemented in mohparkserver::Server.

◆ onParticipantSendIMFailure()

virtual void recon::ConversationManager::onParticipantSendIMFailure	(	ParticipantHandle	partHandle,
		const resip::SipMessage &	status,
		std::unique_ptr< resip::Contents >	contents
	)

inlinevirtual

Notifies an application that a send IM call has failed.

Parameters

partHandle	Handle of the participant that had the failure. Can be a message from an IM relay if application returns true from onReceiveIMFromParticipant.
status	The SIP message indicating the failure status.
contents	The contents of the message that failed to send.

Definition at line 586 of file ConversationManager.hxx.

◆ onParticipantTerminated() [1/2]

virtual void recon::ConversationManager::onParticipantTerminated	(	ParticipantHandle	partHandle,
		unsigned int	statusCode
	)

pure virtual

Notifies an application about a disconnect by a remote participant.

For SIP this could be a BYE or a CANCEL request.

Parameters

partHandle	Handle of the participant that terminated
statusCode	The status Code for the termination.

Implemented in mohparkserver::Server.

◆ onParticipantTerminated() [2/2]

virtual void recon::ConversationManager::onParticipantTerminated	(	ParticipantHandle	partHandle,
		unsigned int	statusCode,
		const resip::Data &	reason
	)

inlinevirtual

Notifies an application about a disconnect by a remote participant.

For SIP this could be a BYE or a CANCEL request.

If you override this version of the callback, then the version above will not be called, and you can implement it with an empty body. Implemented this way, so that we don't break ABI for existing applications.

Parameters

partHandle	Handle of the participant that terminated
statusCode	The status Code for the termination.
reason	The reason for the termination, if available, can be the reason header from a received BYE message (if present)

Definition at line 622 of file ConversationManager.hxx.

◆ onParticipantVoiceActivity()

virtual void recon::ConversationManager::onParticipantVoiceActivity	(	recon::ParticipantHandle	partHandle,
		bool	on,
		bool	inbound
	)

inlinevirtual

Notifies an application when voice activity is detected to on or off from a remote participant.

Parameters

partHandle	Handle of the remote participant, -1 if local mic or speaker
on	true if voice is detected, false when voice detection has stopped
inbound	true if this event if for an inbound RTP stream, false for outbound RTP streams

Definition at line 744 of file ConversationManager.hxx.

◆ onProvisional()

void ConversationManager::onProvisional	(	resip::ClientInviteSessionHandle	,
		const resip::SipMessage &
	)

protectedvirtual

called when dialog enters the Early state - typically after getting 18x

Implements resip::InviteSessionHandler.

Definition at line 610 of file ConversationManager.cxx.

◆ onReadyToSend()

void ConversationManager::onReadyToSend	(	resip::ServerSubscriptionHandle	,
		resip::SipMessage &
	)

protectedvirtual

Reimplemented from resip::ServerSubscriptionHandler.

Definition at line 903 of file ConversationManager.cxx.

◆ onReceivedRequest()

void ConversationManager::onReceivedRequest	(	resip::ServerOutOfDialogReqHandle	ood,
		const resip::SipMessage &	request
	)

protectedvirtual

Implements resip::OutOfDialogHandler.

Definition at line 959 of file ConversationManager.cxx.

◆ onReceiveIMFromParticipant()

virtual bool recon::ConversationManager::onReceiveIMFromParticipant	(	ParticipantHandle	partHandle,
		const resip::SipMessage &	msg
	)

inlinevirtual

Notifies an application about a subsequent message from remote and existing IM participant.

Parameters

partHandle	Handle of the remote IM participant that sent the message
msg	Includes information about the sender such as name and address, and the body of the IM message

Returns: bool indicating if message should be relayed to other appropriate participants in any conversations this participant belongs to.

Definition at line 575 of file ConversationManager.hxx.

◆ onRedirected()

void ConversationManager::onRedirected	(	resip::ClientInviteSessionHandle	,
		const resip::SipMessage &	msg
	)

protectedvirtual

called when a 3xx with valid targets is encountered in an early dialog
This is different then getting a 3xx in onTerminated, as another request will be attempted, so the DialogSet will not be destroyed.

Basically an onTermintated that conveys more information. checking for 3xx respones in onTerminated will not work as there may be no valid targets.

Implements resip::InviteSessionHandler.

Definition at line 646 of file ConversationManager.cxx.

◆ onRedirectReceived()

void ConversationManager::onRedirectReceived	(	resip::AppDialogSetHandle	,
		const resip::SipMessage &	response
	)

protectedvirtual

Implements resip::RedirectHandler.

Definition at line 1051 of file ConversationManager.cxx.

◆ onRefer()

void ConversationManager::onRefer	(	resip::InviteSessionHandle	,
		resip::ServerSubscriptionHandle	,
		const resip::SipMessage &	msg
	)

protectedvirtual

called when an REFER message is received.

The refer is accepted or rejected using the server subscription. If the offer is accepted, DialogUsageManager::makeInviteSessionFromRefer can be used to create an InviteSession that will send notify messages using the ServerSubscription

Implements resip::InviteSessionHandler.

Definition at line 706 of file ConversationManager.cxx.

◆ onReferAccepted()

void ConversationManager::onReferAccepted	(	resip::InviteSessionHandle	,
		resip::ClientSubscriptionHandle	,
		const resip::SipMessage &	msg
	)

protectedvirtual

called when an REFER message receives an accepted response

Implements resip::InviteSessionHandler.

Definition at line 712 of file ConversationManager.cxx.

◆ onReferNoSub()

void ConversationManager::onReferNoSub	(	resip::InviteSessionHandle	h,
		const resip::SipMessage &	msg
	)

protectedvirtual

Implements resip::InviteSessionHandler.

Definition at line 724 of file ConversationManager.cxx.

◆ onReferRejected()

void ConversationManager::onReferRejected	(	resip::InviteSessionHandle	,
		const resip::SipMessage &	msg
	)

protectedvirtual

called when an REFER message receives a failure response

Implements resip::InviteSessionHandler.

Definition at line 718 of file ConversationManager.cxx.

◆ onRefresh()

void ConversationManager::onRefresh	(	resip::ServerSubscriptionHandle	,
		const resip::SipMessage &	sub
	)

protectedvirtual

Reimplemented from resip::ServerSubscriptionHandler.

Definition at line 891 of file ConversationManager.cxx.

◆ onRelatedConversation()

virtual void recon::ConversationManager::onRelatedConversation	(	ConversationHandle	relatedConvHandle,
		ParticipantHandle	relatedPartHandle,
		ConversationHandle	origConvHandle,
		ParticipantHandle	origPartHandle
	)

pure virtual

Notifies an applications that a outbound remote participant request has forked.

A new Related Conversation and Participant are created.
Both new handles and original handles are conveyed to the application so it can track related conversations.

Parameters

relatedConvHandle	Handle of newly created related conversation
relatedPartHandle	Handle of the newly created related participant
origConvHandle	Handle of the conversation that contained the participant that forked
origParticipant	Handle of the participant that forked

Implemented in mohparkserver::Server.

◆ onRemoteSdpChanged()

void ConversationManager::onRemoteSdpChanged	(	resip::InviteSessionHandle	,
		const resip::SipMessage &	msg,
		const resip::SdpContents &
	)

protectedvirtual

called when a modified body is received in a 2xx response to a session-timer reINVITE.

Under normal circumstances where the response body is unchanged from current remote body no handler is called

Reimplemented from resip::InviteSessionHandler.

Definition at line 682 of file ConversationManager.cxx.

◆ onRequestOutgoingParticipant()

virtual void recon::ConversationManager::onRequestOutgoingParticipant	(	ParticipantHandle	partHandle,
		const resip::SipMessage &	msg,
		ConversationProfile &	conversationProfile
	)

pure virtual

Notifies an application about a new remote participant that is trying to be contacted.

This event is required to notify the application if a call request has been initiated by a signaling mechanism other than the application, such as an out-of-dialog REFER request.

Parameters

partHandle	Handle of the new remote participant
msg	Includes information about the destination requested to be attempted

Implemented in mohparkserver::Server.

◆ onRequestRetry()

int ConversationManager::onRequestRetry	(	resip::ClientSubscriptionHandle	h,
		int	retryMinimum,
		const resip::SipMessage &	notify
	)

protectedvirtual

Implements resip::ClientSubscriptionHandler.

Definition at line 818 of file ConversationManager.cxx.

◆ onStaleCallTimeout()

void ConversationManager::onStaleCallTimeout ( resip::ClientInviteSessionHandle h )

protectedvirtual

UAC gets no final response within the stale call timeout (default is 3 minutes).

This is just a notification. After the notification is called, the InviteSession will then call InviteSessionHandler::terminate()

Reimplemented from resip::InviteSessionHandler.

Definition at line 634 of file ConversationManager.cxx.

◆ onSuccess() [1/2]

void ConversationManager::onSuccess	(	resip::ClientOutOfDialogReqHandle	,
		const resip::SipMessage &	response
	)

protectedvirtual

Implements resip::OutOfDialogHandler.

Definition at line 947 of file ConversationManager.cxx.

◆ onSuccess() [2/2]

void ConversationManager::onSuccess	(	resip::ClientPagerMessageHandle	h,
		const resip::SipMessage &	status
	)

protectedvirtual

Implements resip::ClientPagerMessageHandler.

Definition at line 1069 of file ConversationManager.cxx.

◆ onTerminated() [1/3]

void ConversationManager::onTerminated	(	resip::ClientSubscriptionHandle	h,
		const resip::SipMessage *	notify
	)

protectedvirtual

Implements resip::ClientSubscriptionHandler.

Definition at line 806 of file ConversationManager.cxx.

◆ onTerminated() [2/3]

void ConversationManager::onTerminated	(	resip::InviteSessionHandle	h,
		resip::InviteSessionHandler::TerminatedReason	reason,
		const resip::SipMessage *	msg
	)

protectedvirtual

Implements resip::InviteSessionHandler.

Definition at line 640 of file ConversationManager.cxx.

◆ onTerminated() [3/3]

void ConversationManager::onTerminated ( resip::ServerSubscriptionHandle )

protectedvirtual

Implements resip::ServerSubscriptionHandler.

Definition at line 897 of file ConversationManager.cxx.

◆ onTrying()

void ConversationManager::onTrying	(	resip::AppDialogSetHandle	h,
		const resip::SipMessage &	msg
	)

protectedvirtual

Implements resip::DialogSetHandler.

Definition at line 757 of file ConversationManager.cxx.

◆ onTryingNextTarget()

bool ConversationManager::onTryingNextTarget	(	resip::AppDialogSetHandle	,
		const resip::SipMessage &	request
	)

protectedvirtual

Implements resip::RedirectHandler.

Definition at line 1057 of file ConversationManager.cxx.

◆ onUpdateActive()

void ConversationManager::onUpdateActive	(	resip::ClientSubscriptionHandle	h,
		const resip::SipMessage &	notify,
		bool	outOfOrder
	)

protectedvirtual

Implements resip::ClientSubscriptionHandler.

Definition at line 794 of file ConversationManager.cxx.

◆ onUpdateExtension()

void ConversationManager::onUpdateExtension	(	resip::ClientSubscriptionHandle	h,
		const resip::SipMessage &	notify,
		bool	outOfOrder
	)

protectedvirtual

Implements resip::ClientSubscriptionHandler.

Definition at line 800 of file ConversationManager.cxx.

◆ onUpdatePending()

void ConversationManager::onUpdatePending	(	resip::ClientSubscriptionHandle	h,
		const resip::SipMessage &	notify,
		bool	outOfOrder
	)

protectedvirtual

Implements resip::ClientSubscriptionHandler.

Definition at line 788 of file ConversationManager.cxx.

◆ outputBridgeMatrix()

void ConversationManager::outputBridgeMatrix ( ConversationHandle convHandle = 0 )

virtual

Logs a multiline representation of the current state of the mixing matrix.

Parameters

convHandle - if sipXGlobalMediaInterfaceMode is used then 0 is the only valid value. Otherwise you must specify a specific conversation to view.

Definition at line 272 of file ConversationManager.cxx.

◆ participantTypeToString()

const char * ConversationManager::participantTypeToString ( ConversationManager::ParticipantType partType )

static

Definition at line 67 of file ConversationManager.cxx.

◆ post() [1/2]

void ConversationManager::post	(	resip::ApplicationMessage &	message,
		std::chrono::duration< double >	duration = `std::chrono::milliseconds::zero()`
	)

protected

Definition at line 400 of file ConversationManager.cxx.

◆ post() [2/2]

void ConversationManager::post ( resip::Message * message )

protected

Definition at line 391 of file ConversationManager.cxx.

◆ redirectParticipant()

void ConversationManager::redirectParticipant	(	ParticipantHandle	partHandle,
		const resip::NameAddr &	destination,
		unsigned int	redirectCode = `302`,
		RedirectSuccessCondition	successCondition = `RedirectSuccessOnConnected`
	)

virtual

Redirects the participant to another endpoint.

For SIP this would either be a 302 response or would initiate blind transfer (REFER) request, depending on the state.

Parameters

partHandle	Handle of the participant to redirect
destination	Uri of destination to redirect to
redirectCode	Only used if call isn't answered yet, must be >= 300 and <= 399.
successCondition	Only used if call is answered and REFER is sent Specifies when an onParticipantRedirectSuccess is generated

Definition at line 300 of file ConversationManager.cxx.

◆ redirectToParticipant()

void ConversationManager::redirectToParticipant	(	ParticipantHandle	partHandle,
		ParticipantHandle	destPartHandle,
		RedirectSuccessCondition	successCondition = `RedirectSuccessOnConnected`
	)

virtual

This is used for attended transfer scenarios where both participants are no longer managed by the conversation manager - for SIP this will send a REFER with embedded Replaces header.

Note: Replaces option cannot be used with early dialogs in SIP.

Parameters

partHandle	Handle of the participant to redirect
destPartHandle	Handle ot the participant to redirect to
successCondition	Specifies when an onParticipantRedirectSuccess is generated

Definition at line 307 of file ConversationManager.cxx.

◆ rejectParticipant()

void ConversationManager::rejectParticipant	(	ParticipantHandle	partHandle,
		unsigned int	rejectCode
	)

virtual

Rejects an incoming remote participant with the specified code.

Can also be used to reject an outbound participant request (due to REFER).

Parameters

partHandle	Handle of the participant to reject
rejectCode	Code sent to remote participant for rejection

Definition at line 293 of file ConversationManager.cxx.

◆ remoteParticipantInitialHold()

bool recon::ConversationManager::remoteParticipantInitialHold ( )

inlineprotected

Definition at line 863 of file ConversationManager.hxx.

◆ removeParticipant()

void ConversationManager::removeParticipant	(	ConversationHandle	convHandle,
		ParticipantHandle	partHandle
	)

virtual

Removed the specified participant from the specified conversation.

The participants media to/from the conversation is stopped. If the participant no longer exists in any conversation, then they are destroyed. For a remote participant this means the call will be released.

Parameters

convHandle	Handle of the conversation to remove from
partHandle	Handle of the participant to remove

Definition at line 244 of file ConversationManager.cxx.

◆ requestKeyframe()

void ConversationManager::requestKeyframe	(	ParticipantHandle	partHandle,
		std::chrono::duration< double >	durationMs
	)

virtual

Definition at line 487 of file ConversationManager.cxx.

◆ requestKeyframeFromPeer()

void ConversationManager::requestKeyframeFromPeer	(	ParticipantHandle	partHandle,
		std::chrono::duration< double >	durationMs
	)

virtual

Definition at line 494 of file ConversationManager.cxx.

◆ requestKeyframeFromPeerRecurring()

void ConversationManager::requestKeyframeFromPeerRecurring	(	ParticipantHandle	partHandle,
		std::chrono::duration< double >	interval
	)

virtual

Definition at line 501 of file ConversationManager.cxx.

◆ sendIMToParticipant()

void ConversationManager::sendIMToParticipant	(	ParticipantHandle	partHandle,
		std::unique_ptr< resip::Contents >	contents
	)

virtual

Sends a MESSAGE with specified Contents to RemoteParticipant, RemoteIMPagerParticipant, or a RemoteIMSessionParticipant.

Parameters

partHandle	Handle of the participant to send to
contents	Body of SIP MESSAGE request to send

Definition at line 321 of file ConversationManager.cxx.

◆ sendKeyframesAtStart()

bool recon::ConversationManager::sendKeyframesAtStart ( ) const

inline

Definition at line 765 of file ConversationManager.hxx.

◆ setMediaStackAdapter()

void ConversationManager::setMediaStackAdapter ( std::shared_ptr< MediaStackAdapter > mediaStackAdapter )

virtual

Definition at line 576 of file ConversationManager.cxx.

◆ setUserAgent()

void ConversationManager::setUserAgent ( UserAgent * userAgent )

protectedvirtual

Definition at line 87 of file ConversationManager.cxx.

◆ startApplicationTimer() [1/2]

void ConversationManager::startApplicationTimer	(	unsigned int	timerId,
		unsigned int	timerData1,
		unsigned int	timerData2,
		std::chrono::duration< double >	duration
	)

virtual

This function is used to start a timer on behalf of recon based application.

The onApplicationTimer callback will get called when the timer expires. Note: You cannot stop a running timer, so you may want to use a sequence number as the timer data and ignore timers when they fire, if they should be cancelled.

Parameters

timerId	Application specified id for this timer instance returned in callback
timerData1	Application specified generic data returned in callback
timerData2	Application specified generic data returned in callback

Definition at line 335 of file ConversationManager.cxx.

◆ startApplicationTimer() [2/2]

void ConversationManager::startApplicationTimer	(	unsigned int	timerId,
		unsigned int	timerData1,
		unsigned int	timerData2,
		unsigned int	durationMs
	)

virtual

This function is used to start a timer on behalf of recon based application.

The onApplicationTimer callback will get called when the timer expires. Note: You cannot stop a running timer, so you may want to use a sequence number as the timer data and ignore timers when they fire, if they should be cancelled.

Parameters

timerId	Application specified id for this timer instance returned in callback
timerData1	Application specified generic data returned in callback
timerData2	Application specified generic data returned in callback

Definition at line 328 of file ConversationManager.cxx.