CMceSipSession Class Reference
class CMceSipSession : public CMceCsSubSession |
This class represents SIP session
Class provides methods to handle SIP session specifig ITC functions and to receive SIP requests and responses.
Public Member Functions |
---|
| ~CMceSipSession() |
TMceActionSet
| Actions() |
CMceComSession & | ActiveBody() |
void | AddRemoteUriFromResponseL(CSIPResponseElements &) |
CMceComSession * | Body() |
CMceComSession * | BodyCandidate() |
TBool
| CanDispose() |
void | Canceled() |
void | CloseBodyBucket() |
void | CloseMedia(TBool) |
TBool
| Consumes(CSIPDialog &, CSIPServerTransaction &, TBool &) |
void | ContinueHandlingIncomingSessionL() |
void | CreateDialogFrom3XXResponseL() |
CSIPDialogAssocBase * | CreateIncomingDialogL(CSIPServerTransaction &) |
CSIPDialogAssocBase * | CreateOutgoingDialogL(TMceDialogType, CDesC8Array &, CSIPDialog &) |
CSIPDialogAssocBase * | CreateOutgoingDialogL(TMceDialogType, CDesC8Array &) |
CMceState & | CurrentState(TBool) |
CSIPDialogAssocBase * | Dialog() |
void | DiscardInvite() |
void | DoConnectionStateChanged(TBool) |
void | DoErrorOccured(TInt, CSIPTransactionBase &) |
void | DoInitializeIncomingDialogL(CSIPServerTransaction &) |
HBufC8 * | DoServiceL(TMceIds &, TMceItcFunctions) |
void | DoServiceL(TMceIds &, TMceItcFunctions, const TDesC8 &) |
void | DoServiceL(TMceIds &, TMceItcFunctions, TPtr8 &) |
void | DoServiceL(TMceIds &, TMceItcFunctions, CMceMsgBase &) |
TBool
| DoesMediaManagerNeedToNegotiate(CSdpDocument *) |
void | ErrorOccured(TInt) |
void | EventReceived(TMceMccComEvent &) |
CMceSipExtensions & | Extensions() |
TMceFCActionSet
| FCActions() |
void | FCErrorNotify(TInt, const CFCSession *) |
void | FCReceivedData(HBufC8 *, const CFCSession *) |
TBool
| ForceSDPSendingStatus() |
void | ForceUpdateStreamL() |
TInt
| ForkedDialogsCount() |
void | IncrementReceivedSdpCount() |
void | IncrementSentSdpCount() |
void | InviteCompleted(CSIPClientTransaction &) |
void | InviteForkedL(CSIPClientTransaction &, CSIPInviteDialogAssoc *) |
CSIPClientTransaction * | InviteTransaction() |
TBool
| IsNatDisabled() |
TBool
| IsNatSession() |
HBufC8 * | MediaAuthorizationToken() |
void | MediaError(TMceMccComEvent &) |
TBool
| NatSession() |
TInt
| NatState() |
TBool
| NeedToReceive() |
TBool
| NeedToSend(CSdpDocument *) |
CMceSipSession * | NewL(CMceCsSession &, CMceSipConnection &, CMceSipStateMachine &, CSIPProfile &) |
CMceSipSession * | NewLC(CMceCsSession &, CMceSipConnection &, CMceSipStateMachine &, CSIPProfile &) |
CMceSipSession * | NewLC(CMceCsSession &, CMceSipConnection &, CMceSipStateMachine &) |
void | NextState(TUint) |
void | NoPrackReceived(CSIPServerTransaction &) |
CSdpDocument * | Offer() |
void | PrepareIdsL(TMceIds &) |
CSdpDocument * | PrevOffer() |
TMceStateIndex
| PreviousState() |
TInt
| RSeq() |
void | ReCreateOutgoingDialogL() |
TInt
| ReUseDialog() |
void | ReliableFailed(CSIPServerTransaction &, TInt) |
CMceReliableSender & | ReliableSender() |
TMceReturnStatus
| ReserveL() |
void | Reserved(CMceComSession &) |
void | ResetCurrentDialog() |
void | ResetSdpCounts() |
void | SdpCleanup(CSdpDocument *, CSdpDocument *) |
void | ServerInitializedL() |
void | SessionClosed(CMceComSession &) |
void | SessionCreatedL(CMceComSession *) |
void | SetBodyL(CMceComSession *) |
void | SetFirstOffer() |
void | SetMediaAuthorizationToken(HBufC8 *) |
void | SetOffer(CSdpDocument *) |
void | SetPrevOffer(CSdpDocument *) |
void | SetRSeq(TUint) |
void | SetSubState(TSubState) |
void | SetWaitingMediaCallback(TBool) |
void | StartPendingTimerL(TUint) |
void | StartSessionTimerL() |
void | StorePrevOffer() |
TSubState
| SubState() |
void | TimerExpiredL(TMceTimerId, TAny *) |
void | UpdateAccepted() |
TMceReturnStatus
| UpdateMediaL() |
void | UpdateRejected() |
void | Updated(CMceComSession &) |
TBool
| UseFC() |
TBool
| WaitingMediaCallback() |
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() |
| CMceCsSubSession::AcceptDialogTransaction(CSIPServerTransaction &) |
| CMceCsSubSession::AcceptStandAloneTransaction(CSIPServerTransaction &) |
| CMceCsSubSession::AutoEvent() |
| CMceCsSubSession::CMceCsSubSession(TMceCsSessionType,CMceCsSession &,CMceSipConnection &) |
| CMceCsSubSession::CMceCsSubSession(TMceCsSessionType,CMceCsSession &,CMceSipConnection &,CSIPProfile &) |
| CMceCsSubSession::Client()const |
| CMceCsSubSession::ClientExists() |
| CMceCsSubSession::ClientType()const |
| CMceCsSubSession::ConnectionStateChanged(CSIPConnection::TState) |
| CMceCsSubSession::Consumes(CSIPTransactionBase &) |
| CMceCsSubSession::DefaultHeaders(TInt) |
| CMceCsSubSession::DialogId()const |
| CMceCsSubSession::DialogRequestReceived(CSIPServerTransaction *,CSIPDialog &) |
| CMceCsSubSession::DialogResponseReceived(CSIPClientTransaction &) |
| CMceCsSubSession::ErrorOccured(TInt,CSIPTransactionBase &) |
| CMceCsSubSession::FCSession()const |
| CMceCsSubSession::HasInitialInviteTransactionBeenCompleted()const |
| CMceCsSubSession::InitialRequest()const |
| CMceCsSubSession::InitializeIncomingDialogL(CSIPServerTransaction *) |
| CMceCsSubSession::IsOrphan() |
| CMceCsSubSession::IsProfileContactSecureL() |
| CMceCsSubSession::Manager()const |
| CMceCsSubSession::MessageRequestReceived(CSIPServerTransaction *) |
| CMceCsSubSession::MessageResponseReceived(CSIPClientTransaction &) |
| CMceCsSubSession::NextHopL(TInetAddr &) |
| CMceCsSubSession::PendingReceivedRequests() |
| CMceCsSubSession::PendingTransaction(RStringF) |
| CMceCsSubSession::PendingTransactions() |
| CMceCsSubSession::PopClientContent() |
| CMceCsSubSession::PopRequest() |
| CMceCsSubSession::PopResponse() |
| CMceCsSubSession::Profile()const |
| CMceCsSubSession::ProfileConfigured()const |
| CMceCsSubSession::RemoveCompletedRequests(TBool) |
| CMceCsSubSession::RemovePendingTrx(CSIPClientTransaction &) |
| CMceCsSubSession::Request()const |
| CMceCsSubSession::ResetInitialInvite() |
| CMceCsSubSession::Response()const |
| CMceCsSubSession::ResponseReceivedWithinDialog(CSIPClientTransaction &,CSIPDialogAssocBase &) |
| CMceCsSubSession::SIPConnection()const |
| CMceCsSubSession::SendErrorToClient(TMceIds &,TInt) |
| CMceCsSubSession::SendToClient(TMceIds &) |
| CMceCsSubSession::SendToClientL(TMceIds &,HBufC8 *,HBufC8 *) |
| CMceCsSubSession::ServerCore()const |
| CMceCsSubSession::ServiceL(TMceIds &,TMceItcFunctions,const RMessage2 &) |
| CMceCsSubSession::SetAutoEvent(TBool) |
| CMceCsSubSession::SetDialog(TType,CSIPDialogAssocBase *,TUint32) |
| CMceCsSubSession::SetPendingTransactionL(CSIPClientTransaction *) |
| CMceCsSubSession::SetProfile(CSIPProfile &) |
| CMceCsSubSession::StoreAutoEventL(TMceStateTransitionEvent *,CSIPServerTransaction *) |
| CMceCsSubSession::StoreClientContent(HBufC8 *) |
| CMceCsSubSession::StoredAutoEvent() |
| CMceCsSubSession::Type()const |
| CMceCsSubSession::~CMceCsSubSession() |
Constructor & Destructor Documentation
CMceSipSession(CMceCsSession &, CMceSipConnection &, CMceSipStateMachine &, CSIPProfile &)
CMceSipSession(CMceCsSession &, CMceSipConnection &, CMceSipStateMachine &)
Member Functions Documentation
AcceptMethod(RStringF)
Checks if session accepts method of incoming request
ActiveBody()
Returns active session body
AddRemoteUriFromResponseL(CSIPResponseElements &)
Add the URIs in the Contact headers of aResponseElements
AddRemoteUriL(const CUri8 &)
void | AddRemoteUriL | ( | const CUri8 & | aRemoteUri | ) | [private] |
BodyCandidate()
Returns session body candidate
CanDispose()
TBool
| CanDispose | ( | ) | [virtual] |
Returns ETrue, if session can be deleted
Canceled()
Handles situation where incoming INVITE was canceled with the CANCEL
ClearRemoteUri(const TMceStateIndex)
CloseMedia(TBool)
void | CloseMedia | ( | TBool | aDelete = EFalse | ) | |
ConstructL(CMceCsSession &)
Consumes(CSIPDialog &, CSIPServerTransaction &, TBool &)
Returns ETrue, if session will consume the transaction
ContinueHandlingIncomingSessionL()
void | ContinueHandlingIncomingSessionL | ( | ) | |
CreateDialogFrom3XXResponseL()
void | CreateDialogFrom3XXResponseL | ( | ) | |
Create outgoing dialog from 3xx response
CreateIncomingDialogL(CSIPServerTransaction &)
Creates new incoming dialog (association)
CreateOutgoingDialogL(TMceDialogType, CDesC8Array &, CSIPDialog &)
Creates outgoing dialog (association) based on given parameters
CreateOutgoingDialogL(TMceDialogType, CDesC8Array &)
Creates outgoing dialog (association) based on given parameters
CurrentState(TBool)
Parameters
TBool aMarkExit = EFalse | indicates, if current state is marked as exit state |
Dialog()
Returns SIP dialog (assoc)
DoAutoEventL(TMceStateTransitionEvent &)
DoConnectionStateChanged(TBool)
void | DoConnectionStateChanged | ( | TBool | aIsActive | ) | [virtual] |
Handles situation where SIP connection state has changed. If connection state has changed to EInactive or EUnavailable, SIP stack terminates all pending SIP client transactions and no errors are reported back to the client about the terminated transactions.
Parameters
TBool aIsActive | indicates if the current connection is active |
DoCreateOutgoingDialogL(CUri8 *, CSIPToHeader *)
DoErrorOccured(TInt, CSIPTransactionBase &)
Handles situation where an asynchronous error has occured related to a request within an existing dialog.
DoInitializeIncomingDialogL(CSIPServerTransaction &)
Initializes incoming dialog
Parameters
CSIPServerTransaction & aTransaction | server transaction representing a request, which caused dialog creation |
DoServiceL(TMceIds &, TMceItcFunctions)
Executes ITC function called by client.
DoServiceL(TMceIds &, TMceItcFunctions, const TDesC8 &)
Executes ITC function called by client.
Parameters
TMceIds & aIds | set of ids defining ITC call context |
TMceItcFunctions aFunction | ITC function to be executed |
const TDesC8 & aMessage | message context from client |
DoServiceL(TMceIds &, TMceItcFunctions, TPtr8 &)
Executes ITC function called by client.
Parameters
TMceIds & aIds | set of ids defining ITC call context |
TMceItcFunctions aFunction | ITC function to be executed |
TPtr8 & aMessage | message context from client |
DoServiceL(TMceIds &, TMceItcFunctions, CMceMsgBase &)
Executes ITC function called by client.
DoTerminateL()
void | DoTerminateL | ( | ) | [private] |
DoesMediaManagerNeedToNegotiate(CSdpDocument *)
ErrorOccured(TInt)
void | ErrorOccured | ( | TInt | aError | ) | [virtual] |
Called when error has been occured within dialog
ErrorResponseReceived()
void | ErrorResponseReceived | ( | ) | [protected, virtual] |
Called when error response (4XX-7XX) has been received to pending transaction. Response can be obtained by calling Response() method
EventReceived(TMceMccComEvent &)
Callback function to indicate that event has been received
Extensions()
Returns the SIP extensions.
FCActions()
Returns floor control actions set
FCErrorNotify(TInt, const CFCSession *)
An asynchronous error has occurred in the FC related to the given session indicated.
Parameters
TInt aErrCode | |
const CFCSession * aFCSession | The Session which error is received to. |
FCReceivedData(HBufC8 *, const CFCSession *)
A FC message has been received from the network.
Parameters
HBufC8 * aData | The Data received from FCsession specific plugIn The ownership is transferred. |
const CFCSession * aFCSession | The Session which data is received to. |
FindRemoteUri(const CUri8 &)
TInt
| FindRemoteUri | ( | const CUri8 & | aRemoteUri | ) | [private] |
ForceSDPSendingStatus()
TBool
| ForceSDPSendingStatus | ( | ) | |
Returns Status for ForcedSDPSending Flag.
ForkedDialogsCount()
TInt
| ForkedDialogsCount | ( | ) | |
HandleForkedDialogs()
void | HandleForkedDialogs | ( | ) | [private] |
HandleSIPEvent(TMceSipEventCode, CSIPDialog &)
HandleSIPEventErrorL(TMceSipEventCode, TInt)
IncrementReceivedSdpCount()
void | IncrementReceivedSdpCount | ( | ) | |
IncrementSentSdpCount()
void | IncrementSentSdpCount | ( | ) | |
InviteCompleted(CSIPClientTransaction &)
Handles situation where SIP stack has completed UAC core INVITE transaction 64*T1 seconds after the reception of the first 2xx response. No more 2xx responses can be received to the issued single INVITE.
InviteForkedL(CSIPClientTransaction &, CSIPInviteDialogAssoc *)
Invite has been received multiple replies and thus stack has creted new dialog for others
InviteTransaction()
Returns pending invite transaction
IsNatDisabled()
TBool
| IsNatDisabled | ( | ) | const [virtual] |
Check if the NAT has been disabled.
IsSipDialogConfirmed()
TBool
| IsSipDialogConfirmed | ( | ) | const [private] |
Returns dialog confirmation status
LocalErrorOccured(TMceStateIndex, TInt)
MediaAuthorizationToken()
HBufC8 * | MediaAuthorizationToken | ( | ) | const |
Returns the media authorization token. Ownership is not transfered.
MediaError(TMceMccComEvent &)
Callback function to indicate about error
NatSession()
TBool
| NatSession | ( | ) | const [virtual] |
Method used to check if sip session is a Nat sip sesssion.
NatState()
TInt
| NatState | ( | ) | const [virtual] |
Returns Nat sip session sub state.
NeedToReceive()
Returns whether a SDP is expected to be received
NeedToSend(CSdpDocument *)
Tells whether SDP to be sent to network.
NewL(CMceCsSession &, CMceSipConnection &, CMceSipStateMachine &, CSIPProfile &)
NewLC(CMceCsSession &, CMceSipConnection &, CMceSipStateMachine &, CSIPProfile &)
NewLC(CMceCsSession &, CMceSipConnection &, CMceSipStateMachine &)
NextState(TUint)
void | NextState | ( | TUint | aNextStateId | ) | |
Parameters
TUint aNextStateId | next state id |
NoPrackReceived(CSIPServerTransaction &)
Callback Function, this will be called when reliable sender, retransmission timer expires, i.e. reliable sender has sent transaction for 64T1 and has not got the corresponding PRACK.
Offer()
Returns last offer (or answer) issued to session
PrepareIdsL(TMceIds &)
void | PrepareIdsL | ( | TMceIds & | aIds | ) | const |
Prepares ITC callback context
Parameters
TMceIds & aIds | set of ids defining ITC callback context |
PrevOffer()
Returns one before last offer (or answer) issued to session
PrevOfferSafeDelete()
void | PrevOfferSafeDelete | ( | ) | [protected] |
PreviousState()
Returns the previous state of sip session
ProvisionalResponseReceived()
void | ProvisionalResponseReceived | ( | ) | [protected, virtual] |
Called when response (1XX) has been received to pending transaction. Response can be obtained by calling Response() method
ReCreateOutgoingDialogL()
void | ReCreateOutgoingDialogL | ( | ) | |
Re-Create an outgoing dialog
RedirectionResponseReceived()
void | RedirectionResponseReceived | ( | ) | [protected, virtual] |
Called when response (3XX) has been received to pending transaction. Response can be obtained by calling Response() method
ReliableFailed(CSIPServerTransaction &, TInt)
Callback Function indicates reliable sender has failed. This may be called when a transaction is in progress and UA tries to send another reliable response.
RequestReceived(TBool, CSIPDialog &)
void | RequestReceived | ( | TBool | aInsideDialog, |
| CSIPDialog & | aDialog |
| ) | [protected, virtual] |
Called when request has been received. Request can be obtained by calling Request() method
Parameters
TBool aInsideDialog | tells whether request was received inside dialog |
CSIPDialog & aDialog | SIP Dialog to which request belongs |
ReserveL()
Resource Reservation Status
Reserved(CMceComSession &)
Callback function to indicate that network resource reservation is now ready
ResponseReceived()
void | ResponseReceived | ( | ) | [protected, virtual] |
Called when response (2XX) has been received to pending transaction. Response can be obtained by calling Response() method
SdpCleanup(CSdpDocument *, CSdpDocument *)
Change currently used sdp
SessionClosed(CMceComSession &)
Callback function to indicate MCC session was stopped
SessionCreatedL(CMceComSession *)
Callback function to indicate about new media session due fork
SetBodyL(CMceComSession *)
SetMediaAuthorizationToken(HBufC8 *)
void | SetMediaAuthorizationToken | ( | HBufC8 * | aToken | ) | |
Sets the media authorization token. Ownership is transfered. aToken the media authorization token
SetPrevOffer(CSdpDocument *)
SetRSeq(TUint)
Sets the RSeq Value. aRSeq RSeq Value
SetWaitingMediaCallback(TBool)
void | SetWaitingMediaCallback | ( | TBool | aWaiting | ) | |
Sets the boolean value whether the session is waiting for a media callback
Parameters
TBool aWaiting | the value to be set |
StandAloneRequestReceived()
void | StandAloneRequestReceived | ( | ) | [protected, virtual] |
Called when stand-alone request has been received. Request can be obtained by calling Request() method
StandAloneResponseReceived(TMceSipResponseType)
Called when stand-alone response (any) has been received to pending transaction. Response can be obtained by calling Response() method
StartPendingTimerL(TUint)
void | StartPendingTimerL | ( | TUint | aInterval | ) | |
Parameters
TUint aInterval | interval in milli seconds |
StorePrevOffer()
void | StorePrevOffer | ( | ) | [virtual] |
SubState()
Returns substate of session
Terminate()
TBool
| Terminate | ( | ) | [protected, virtual] |
Handles situation where session must be forcefully terminated
TimerExpiredL(TMceTimerId, TAny *)
Callback function to indicate about expiration of session timer. RFC 4028
UpdateAccepted()
Causes pending update to be accepted
UpdateRejected()
Causes pending update to be rejected
Updated(CMceComSession &)
Callback function to indicate MCC session is updated.
UseFC()
Returns truth value, is FC in use or not. Set to ETrue, when initializing FC for MO sessions and when updating FC for MT sessions.
WaitingMediaCallback()
TBool
| WaitingMediaCallback | ( | ) | const |
Returns as a boolean value whether the session is waiting for a media callback
Member Enumerations Documentation
Enum TSubState
Enumerators
ENone | |
EOffering | |
EAnswering | |
EUpdating | |
ERefreshing | |
Member Data Documentation
RPointerArray< CMceComSession > iBodyBucket
CMceState * iCurrentState
CMceSipExtensions * iExtensions
CSdpDocument * iFirstOffer
TBool
iForceSDPSending
TBool
| iForceSDPSending | [protected] |
RPointerArray< CSIPInviteDialogAssoc > iForkedDialogs
HBufC8 * iMediaAuthorizationToken
HBufC8 * | iMediaAuthorizationToken | [private] |
TBool
iNatSession
TBool
| iNatSession | [protected] |
CMceComSession * iNewBodyCandidate
TMceTimerId
iPendingTimer
CSdpDocument * iPrevOffer
TUint
iPreviousState
TUint
| iPreviousState | [private] |
TInt
iReceivedSdpCount
TInt
| iReceivedSdpCount | [private] |
CMceReliableSender * iReliableSender
RPointerArray< CUri8 > iRemoteUri
TInt
iSentSdpCount
TInt
| iSentSdpCount | [private] |
CMceSipStateMachine * iStateMachine
TBool
iWaitingMediaCallback
TBool
| iWaitingMediaCallback | [private] |
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.