OpalSIPIMContext Class Reference

#include <sipim.h>

Inheritance diagram for OpalSIPIMContext:

Public Member Functions
	OpalSIPIMContext ()
virtual SentStatus	SendCompositionIndication (bool active=true)
Public Member Functions inherited from OpalConnectionIMContext
	OpalConnectionIMContext ()
Public Member Functions inherited from OpalIMContext
	OpalIMContext ()
	~OpalIMContext ()
virtual SentStatus	Send (OpalIM *message)
virtual void	OnMessageSent (const MessageSentInfo &info)
void	SetMessageSentNotifier (const MessageSentNotifier &notifier)
	Set the notifier for the OnMessageSent() function. More...
void	SetIncomingIMNotifier (const IncomingIMNotifier &notifier)
	Set the notifier for the OnIncomingMessage() function. More...
virtual void	OnCompositionIndicationChanged (const PString &state)
void	SetCompositionIndicationChangedNotifier (const CompositionIndicationChangedNotifier &notifier)
	Set the notifier for the OnIncomingMessage() function. More...
virtual bool	CheckContentType (const PString &contentType) const
virtual PStringArray	GetContentTypes () const
PString	GetID () const
void	SetID (const PString &id)
PString	GetKey () const
PString	GetLocalURL () const
PString	GetRemoteURL () const
PStringOptions &	GetAttributes ()
	< Get the attributes for this presentity. More...
const PStringOptions &	GetAttributes () const
virtual bool	OnNewIncomingIM ()
virtual bool	AddIncomingIM (OpalIM *message)
OpalIM *	GetIncomingMessage ()
virtual void	InternalOnMessageSent (const MessageSentInfo &info)
void	ResetLastUsed ()

Static Public Member Functions
static void	PopulateParams (SIPMessage::Params &params, OpalIM &message)
Static Public Member Functions inherited from OpalIMContext
static PSafePtr< OpalIMContext >	Create (OpalManager &manager, const PURL &localURL, const PURL &remoteURL)
static PSafePtr< OpalIMContext >	Create (OpalManager &manager, PSafePtr< OpalConnection > conn)
static PSafePtr< OpalIMContext >	Create (OpalManager &manager, PSafePtr< OpalPresentity > presentity, const PURL &remoteURL)
static PString	CreateKey (const PString &from, const PString &to)

Protected Member Functions
virtual SentStatus	InternalSendOutsideCall (OpalIM *message)
virtual SentStatus	InternalSendInsideCall (OpalIM *message)
virtual SentStatus	OnIncomingIM (OpalIM &message)
void	OnCompositionIndicationTimeout ()
void	ResetTimers (OpalIM &message)
	PDECLARE_NOTIFIER (PTimer, OpalSIPIMContext, OnRxCompositionTimerExpire)
	PDECLARE_NOTIFIER (PTimer, OpalSIPIMContext, OnTxCompositionTimerExpire)
	PDECLARE_NOTIFIER (PTimer, OpalSIPIMContext, OnTxIdleTimerExpire)
Protected Member Functions inherited from OpalIMContext
virtual SentStatus	InternalSend ()

Protected Attributes
PTimer	m_rxCompositionTimeout
PTimer	m_txCompositionTimeout
PTimer	m_txIdleTimeout
RFC4103Context	m_rfc4103Context
Protected Attributes inherited from OpalIMContext
PMutex	m_notificationMutex
IncomingIMNotifier	m_incomingMessageNotifier
MessageSentNotifier	m_messageSentNotifier
CompositionIndicationChangedNotifier	m_compositionIndicationChangedNotifier
OpalManager *	m_manager
PStringOptions	m_attributes
PSafePtr< OpalConnection >	m_connection
PSafePtr< OpalPresentity >	m_presentity
PMutex	m_incomingMessagesMutex
PQueue< OpalIM >	m_incomingMessages
PMutex	m_outgoingMessagesMutex
OpalIM *	m_currentOutgoingMessage
PQueue< OpalIM >	m_outgoingMessages
PMutex	m_lastUsedMutex
PTime	m_lastUsed

Additional Inherited Members
Public Types inherited from OpalIMContext
enum	SentStatus {   SentOK, SentPending, SentAccepted, SentUnacceptableContent,   SentInvalidContent, SentConnectionClosed, SentNoTransport, SentNoAnswer,   SentDestinationUnknown, SentFailedGeneric }
typedef PNotifierTemplate< const MessageSentInfo & >	MessageSentNotifier
typedef PNotifierTemplate< const OpalIM & >	IncomingIMNotifier
typedef PNotifierTemplate< const PString & >	CompositionIndicationChangedNotifier

Constructor & Destructor Documentation

OpalSIPIMContext()

OpalSIPIMContext::OpalSIPIMContext

(

)

Member Function Documentation

InternalSendInsideCall()

virtual SentStatus OpalSIPIMContext::InternalSendInsideCall ( OpalIM *  message )

protectedvirtual

Reimplemented from OpalIMContext.

InternalSendOutsideCall()

virtual SentStatus OpalSIPIMContext::InternalSendOutsideCall ( OpalIM *  message )

protectedvirtual

Reimplemented from OpalIMContext.

OnCompositionIndicationTimeout()

void OpalSIPIMContext::OnCompositionIndicationTimeout ( )

protectedvirtual

Reimplemented from OpalIMContext.

OnIncomingIM()

virtual SentStatus OpalSIPIMContext::OnIncomingIM ( OpalIM &  message )

protectedvirtual

Called when an incoming message arrives for this context Default implementation calls IncomingIMNotifier, if set, else returns true

Reimplemented from OpalIMContext.

PDECLARE_NOTIFIER() [1/3]

OpalSIPIMContext::PDECLARE_NOTIFIER ( PTimer  , OpalSIPIMContext  , OnRxCompositionTimerExpire    )

protected

PDECLARE_NOTIFIER() [2/3]

OpalSIPIMContext::PDECLARE_NOTIFIER ( PTimer  , OpalSIPIMContext  , OnTxCompositionTimerExpire    )

protected

PDECLARE_NOTIFIER() [3/3]

OpalSIPIMContext::PDECLARE_NOTIFIER ( PTimer  , OpalSIPIMContext  , OnTxIdleTimerExpire    )

protected

PopulateParams()

static void OpalSIPIMContext::PopulateParams ( SIPMessage::Params &  params, OpalIM &  message  )

static

ResetTimers()

void OpalSIPIMContext::ResetTimers ( OpalIM &  message )

protected

SendCompositionIndication()

virtual SentStatus OpalSIPIMContext::SendCompositionIndication ( bool  active = true )

virtual

Reimplemented from OpalIMContext.

Field Documentation

m_rfc4103Context

RFC4103Context OpalSIPIMContext::m_rfc4103Context

protected

m_rxCompositionTimeout

PTimer OpalSIPIMContext::m_rxCompositionTimeout

protected

m_txCompositionTimeout

PTimer OpalSIPIMContext::m_txCompositionTimeout

protected

m_txIdleTimeout

PTimer OpalSIPIMContext::m_txIdleTimeout

protected

---

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

• sipim.h