Symbian^3 Application Developer Library >

CMceOutSession Class Reference

class CMceOutSession : public CMceSession

Class for mobile originated MCE sessions.

CMceOutSession represents outgoing invitation to remote terminal to join in a session.

The characteristics of the session are defined by user of this class by attaching media streams into the session. Theses charactereistics are turned by MCE server into SDP and attached into sent invitation request.

After the session has been succesfylly established, it can be later updated and must be finally terminated.

If for any reason instance of this class is deleted while in established state, session is automatically terminated by MCE server.

mceclient.lib

Inherits from

Public Member Functions
~CMceOutSession ()
void AddStreamL ( CMceMediaStream *)
IMPORT_C void CancelL ()
IMPORT_C void EstablishL ( TUint32 , CDesC8Array *, HBufC8 *, HBufC8 *, CDesC8Array *)
IMPORT_C CMceOutSession * NewL ( CMceManager &, CSIPProfile &, const TDesC8 &, HBufC8 *)
IMPORT_C CMceOutSession * NewL ( CMceManager &, TUint32 , const TDesC8 &, const TDesC8 &, CDesC8Array *)
IMPORT_C CMceOutSession * NewL ( CMceEvent &)
IMPORT_C CMceOutSession * NewL ( CMceRefer &)
CMceOutSession * NewL ()
TBool StreamInitializeCondition ( CMceMediaStream &)
Protected Member Functions
CMceOutSession ( CMceManager *, TUint32 )
void ConstructL (const TDesC8 &, HBufC8 *)
void ConstructL (const TDesC8 &, const TDesC8 &, TUint32 )
void ConstructL (const TDesC8 &, const TDesC8 &, TUint32 , CDesC8Array *)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CMceSession::AddBundleL(CMceStreamBundle *)
CMceSession::AssociatedEventsL()const
CMceSession::AssociatedRefersL()const
CMceSession::BaseFactory()
CMceSession::Bundles()const
CMceSession::CMceSession(CMceManager *,TUint32)
CMceSession::ConnectionActive()const
CMceSession::ConstructL(TBool)
CMceSession::ControlPathSecurityLevel()const
CMceSession::DialogId()const
CMceSession::DoAddStreamL(CMceMediaStream *)
CMceSession::ErrorOccuredL(TInt)
CMceSession::EventReceivedL(TMceIds &)
CMceSession::EventReceivedL(TMceIds &,CMceMsgBase &)
CMceSession::EventReceivedL(TMceIds &,CMceMsgBase &,HBufC8 *)
CMceSession::ExternalizeFlatL(RWriteStream &)
CMceSession::ExternalizeL(MMceComSerializationContext &)
CMceSession::FCErrorOccurred(TInt)
CMceSession::FCMessageReceived(HBufC8 *)
CMceSession::Factory()
CMceSession::GetModifierL(TMceSessionModifier,TUint &)const
CMceSession::GetSIPParams(CDesC8Array *&,HBufC8 *&,CDesC8Array *&)
CMceSession::ITCSender()const
CMceSession::Id()const
CMceSession::IncomingUpdateL(CMceInSession *,HBufC8 *)
CMceSession::InitializeL(TBool,TBool)
CMceSession::InternalizeFlatL(RReadStream &)
CMceSession::InternalizeL(MMceComSerializationContext &)
CMceSession::IsZombie()
CMceSession::Manager()const
CMceSession::Originator()const
CMceSession::PrepareForITC(TMceIds &)
CMceSession::Profile()const
CMceSession::Recipient()const
CMceSession::RemoveBundleL(CMceStreamBundle &)
CMceSession::RemoveStreamL(CMceMediaStream &)
CMceSession::SIPParamsCleanup(TAny *)
CMceSession::SendITCEventL(TUint8)
CMceSession::SendRequestL(const TDesC8 &,CDesC8Array *,HBufC8 *,HBufC8 *)
CMceSession::SendResponseL(TMceTransactionId,const TDesC8 &,TUint32,CDesC8Array *,HBufC8 *,HBufC8 *)
CMceSession::SerializationId()const
CMceSession::ServiceType()const
CMceSession::SessionSDPLinesL()
CMceSession::SessionTimer()const
CMceSession::SetFCObserver(MMceFcMsgObserver *)
CMceSession::SetModifierL(TMceSessionModifier,TUint)
CMceSession::SetSIPParams(CDesC8Array *,HBufC8 *,CDesC8Array *)
CMceSession::SetServiceTypeL(TUint32)
CMceSession::SetSessionSDPLinesL(CDesC8Array *)
CMceSession::SetZombie(CMceInSession &)
CMceSession::State()const
CMceSession::Streams()const
CMceSession::SynchronizeL(TMceIds &)
CMceSession::TerminateL(CDesC8Array *,HBufC8 *,HBufC8 *)
CMceSession::Type()const
CMceSession::UpdateL(TUint32,CDesC8Array *,HBufC8 *,HBufC8 *,CDesC8Array *)
CMceSession::~CMceSession()
Inherited Enumerations
CMceSession:TControlPathSecurityLevel
CMceSession:TReason
CMceSession:TState
Inherited Attributes
CMceSession::iFCObserver
CMceSession::iFlatData
CMceSession::iManager
CMceSession::iMediaStreams
CMceSession::iProfileId
CMceSession::iReceiver
CMceSession::iSender

Constructor & Destructor Documentation

CMceOutSession(CMceManager *, TUint32)

CMceOutSession ( CMceManager * aManager,
TUint32 aProfileId
) [protected]

C++ default constructor.

Parameters

CMceManager * aManager
TUint32 aProfileId

~CMceOutSession()

IMPORT_C ~CMceOutSession ( )

Destructor.

Member Functions Documentation

AddStreamL(CMceMediaStream *)

void AddStreamL ( CMceMediaStream * aMediaStream ) [virtual]
Adds media stream into session.
Pre-condition
State() == CMceSession::EIdle || State() == CMceSession::EIncoming || State() == CMceSession::EEstablished
aMediaStream != 0

Parameters

CMceMediaStream * aMediaStream

CancelL()

IMPORT_C void CancelL ( )
Cancels a previously initialized MO session.
Pre-condition
State() == CMceSession::EOffering
Post-condition
State() == CMceSession::ECancelling

ConstructL(const TDesC8 &, HBufC8 *)

void ConstructL ( const TDesC8 & aRecipient,
HBufC8 * aOriginator
) [protected]

second-phase constructor

Parameters

const TDesC8 & aRecipient
HBufC8 * aOriginator

ConstructL(const TDesC8 &, const TDesC8 &, TUint32)

void ConstructL ( const TDesC8 & aRecipient,
const TDesC8 & aOriginator,
TUint32 aDialogId
) [protected]

second-phase constructor

Parameters

const TDesC8 & aRecipient
const TDesC8 & aOriginator
TUint32 aDialogId

ConstructL(const TDesC8 &, const TDesC8 &, TUint32, CDesC8Array *)

void ConstructL ( const TDesC8 & aRecipient,
const TDesC8 & aOriginator,
TUint32 aIAPId,
CDesC8Array * aContactParameters
) [protected]

second-phase constructor

Parameters

const TDesC8 & aRecipient
const TDesC8 & aOriginator
TUint32 aIAPId
CDesC8Array * aContactParameters

EstablishL(TUint32, CDesC8Array *, HBufC8 *, HBufC8 *, CDesC8Array *)

IMPORT_C void EstablishL ( TUint32 aTimeout = 0,
CDesC8Array * aHeaders = 0,
HBufC8 * aContentType = 0,
HBufC8 * aContent = 0,
CDesC8Array * aContentHeaders = 0
)
Establishes a SIP session with the recipient. The streams in the stream array are offered in the SDP codec negotiation.
Pre-condition
State() == CMceSession::EIdle
Post-condition
State() == CMceSession::EOffering

Parameters

TUint32 aTimeout = 0
CDesC8Array * aHeaders = 0
HBufC8 * aContentType = 0
HBufC8 * aContent = 0
CDesC8Array * aContentHeaders = 0

NewL(CMceManager &, CSIPProfile &, const TDesC8 &, HBufC8 *)

IMPORT_C CMceOutSession * NewL ( CMceManager & aManager,
CSIPProfile & aProfile,
const TDesC8 & aRecipient,
HBufC8 * aOriginator = 0
) [static]

Two-phased constructor. Should be used when session is established into new logical connection to remote terminal.

Parameters

CMceManager & aManager
CSIPProfile & aProfile
const TDesC8 & aRecipient
HBufC8 * aOriginator = 0

NewL(CMceManager &, TUint32, const TDesC8 &, const TDesC8 &, CDesC8Array *)

IMPORT_C CMceOutSession * NewL ( CMceManager & aManager,
TUint32 aIAPId,
const TDesC8 & aOriginator,
const TDesC8 & aRecipient,
CDesC8Array * aContactParameters = 0
) [static]

Two-phased constructor. Should be used when session is established into new logical connection to remote terminal.

Parameters

CMceManager & aManager
TUint32 aIAPId
const TDesC8 & aOriginator
const TDesC8 & aRecipient
CDesC8Array * aContactParameters = 0

NewL(CMceEvent &)

IMPORT_C CMceOutSession * NewL ( CMceEvent & aEvent ) [static]

Two-phased constructor. Should be used when session is associated to existing event. This guarantees that session is established with same remote terminal with the event.

Parameters

CMceEvent & aEvent

NewL(CMceRefer &)

IMPORT_C CMceOutSession * NewL ( CMceRefer & aRefer ) [static]

Two-phased constructor. Should be used when session is associated to existing refer. This guarantees that session is established with same remote terminal with the refer.

Parameters

CMceRefer & aRefer

NewL()

CMceOutSession * NewL ( ) [static]

Two-phased constructor. For temporary use only.

StreamInitializeCondition(CMceMediaStream &)

TBool StreamInitializeCondition ( CMceMediaStream & aMediaStream ) const [virtual]

Checks if the stream should be initialized.

Parameters

CMceMediaStream & aMediaStream media stream

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.