S60 3rd Edition SDK for Symbian OS
Example Applications Guide

CSIPExSIPStateBase Class Reference

#include <SIPExSIPStateBase.h>

Inheritance diagram for CSIPExSIPStateBase:

CSIPExSIPClientEstablishingState CSIPExSIPClientOfferingState CSIPExSIPEstablishedState CSIPExSIPIdleState CSIPExSIPServerEstablishingState CSIPExSIPServerOfferingState CSIPExSIPTerminatingState List of all members.

Public Member Functions

virtual ~CSIPExSIPStateBase ()
virtual void SendInviteL (CSIPExSIPEngine &aEngine, const TDesC8 &aSipUri)
virtual void CancelInviteL (CSIPExSIPEngine &aEngine)
virtual void AcceptInviteL (CSIPExSIPEngine &aEngine)
virtual void DeclineInviteL (CSIPExSIPEngine &aEngine)
virtual void EndSessionL (CSIPExSIPEngine &aEngine)
virtual void ResponseReceivedL (CSIPExSIPEngine &aEngine, CSIPClientTransaction &aTransaction)
virtual void AckReceivedL (CSIPExSIPEngine &aEngine, CSIPServerTransaction &aTransaction)
virtual void ByeReceivedL (CSIPExSIPEngine &aEngine, CSIPServerTransaction &aTransaction)
virtual void CancelReceivedL (CSIPExSIPEngine &aEngine, CSIPClientTransaction &aTransaction)
virtual void InviteReceivedL (CSIPExSIPEngine &aEngine, CSIPServerTransaction *aTransaction)
virtual void ErrorOccured (CSIPExSIPEngine &aEngine, TInt aError)

Protected Member Functions

 CSIPExSIPStateBase ()

Detailed Description

SIP state base; provides function default implementation, common error handling and function for getting state name.

Function will leave with KErrTotalLossOfPrecision in case of invalid state.

Definition at line 44 of file SIPExSIPStateBase.h.

Constructor & Destructor Documentation

CSIPExSIPStateBase::~CSIPExSIPStateBase (   )  [virtual]
 

Destructor

Definition at line 35 of file SIPExSIPStateBase.cpp.

00036         {
00037         }

CSIPExSIPStateBase::CSIPExSIPStateBase (   )  [protected]
 

C++ default constructor.

Parameters:
aName a state name

Definition at line 27 of file SIPExSIPStateBase.cpp.

00028         {
00029         }

Member Function Documentation

void CSIPExSIPStateBase::SendInviteL (  CSIPExSIPEngine &  aEngine,
const TDesC8 &  aSipUri
)  [virtual]
 

SendInviteL Sends an INVITE to peer.

Parameters:
aEngine Reference to SIP Engine.
aSipUri uri of recipient.

Reimplemented in CSIPExSIPIdleState.

Definition at line 43 of file SIPExSIPStateBase.cpp.

00046         {
00047         //User::Leave( KErrTotalLossOfPrecision );
00048         }

void CSIPExSIPStateBase::CancelInviteL (  CSIPExSIPEngine &  aEngine  )  [virtual]
 

CancelInviteL Cancel an INVITE sent previously.

Parameters:
aEngine Reference to Engine object.

Reimplemented in CSIPExSIPClientEstablishingState, and CSIPExSIPClientOfferingState.

Definition at line 54 of file SIPExSIPStateBase.cpp.

00056         {
00057         //User::Leave( KErrTotalLossOfPrecision );
00058         }

void CSIPExSIPStateBase::AcceptInviteL (  CSIPExSIPEngine &  aEngine  )  [virtual]
 

AcceptInviteL Send 200 (OK) as response to an INVITE received from peer.

Parameters:
aEngine Reference to Engine object.

Reimplemented in CSIPExSIPServerOfferingState.

Definition at line 65 of file SIPExSIPStateBase.cpp.

00067         {
00068         //User::Leave( KErrTotalLossOfPrecision );
00069         }

void CSIPExSIPStateBase::DeclineInviteL (  CSIPExSIPEngine &  aEngine  )  [virtual]
 

DeclineInviteL Send 486 (Busy Here) as response to an INVITE received from peer.

Parameters:
aEngine Reference to Engine object.

Reimplemented in CSIPExSIPServerOfferingState.

Definition at line 76 of file SIPExSIPStateBase.cpp.

00078         {
00079         //User::Leave( KErrTotalLossOfPrecision );
00080         }

void CSIPExSIPStateBase::EndSessionL (  CSIPExSIPEngine &  aEngine  )  [virtual]
 

EndSessionL Send BYE in an established session.

Parameters:
aEngine Reference to Engine object.

Reimplemented in CSIPExSIPEstablishedState.

Definition at line 88 of file SIPExSIPStateBase.cpp.

00089         {
00090         //User::Leave( KErrTotalLossOfPrecision );
00091         }

void CSIPExSIPStateBase::ResponseReceivedL (  CSIPExSIPEngine &  aEngine,
CSIPClientTransaction &  aTransaction
)  [virtual]
 

ResponseReceivedL A SIP response has been received from the network.

Parameters:
aEngine Reference to Engine object.
aTransaction Contains response elements.

Reimplemented in CSIPExSIPClientEstablishingState, CSIPExSIPClientOfferingState, CSIPExSIPEstablishedState, and CSIPExSIPTerminatingState.

Definition at line 98 of file SIPExSIPStateBase.cpp.

00101         {
00102         //User::Leave( KErrTotalLossOfPrecision );
00103         }

void CSIPExSIPStateBase::AckReceivedL (  CSIPExSIPEngine &  aEngine,
CSIPServerTransaction &  aTransaction
)  [virtual]
 

AckReceivedL ACK has been received.

Parameters:
aEngine Reference to Engine object.
aTransaction Contains response elements.

Reimplemented in CSIPExSIPEstablishedState, and CSIPExSIPServerEstablishingState.

Definition at line 110 of file SIPExSIPStateBase.cpp.

00113         {
00114         //User::Leave( KErrTotalLossOfPrecision );
00115         }

void CSIPExSIPStateBase::ByeReceivedL (  CSIPExSIPEngine &  aEngine,
CSIPServerTransaction &  aTransaction
)  [virtual]
 

ByeReceivedL BYE has been received.

Parameters:
aEngine Reference to Engine object.
aTransaction Contains response elements.

Reimplemented in CSIPExSIPEstablishedState, CSIPExSIPServerEstablishingState, and CSIPExSIPServerOfferingState.

Definition at line 122 of file SIPExSIPStateBase.cpp.

00125         {
00126         //User::Leave( KErrTotalLossOfPrecision );
00127         }

void CSIPExSIPStateBase::CancelReceivedL (  CSIPExSIPEngine &  aEngine,
CSIPClientTransaction &  aTransaction
)  [virtual]
 

CancelReceivedL CANCEL has been received.

Parameters:
aEngine Reference to Engine object.
aTransaction Contains response elements.

Reimplemented in CSIPExSIPServerEstablishingState, and CSIPExSIPServerOfferingState.

Definition at line 134 of file SIPExSIPStateBase.cpp.

00137         {
00138         //User::Leave( KErrTotalLossOfPrecision );
00139         }

void CSIPExSIPStateBase::InviteReceivedL (  CSIPExSIPEngine &  aEngine,
CSIPServerTransaction *  aTransaction
)  [virtual]
 

InviteReceivedL INVITE has been received.

Parameters:
aEngine Reference to Engine object.
aTransaction Contains response elements. The ownership is transferred.

Reimplemented in CSIPExSIPIdleState.

Definition at line 146 of file SIPExSIPStateBase.cpp.

00149         {
00150         //User::Leave( KErrTotalLossOfPrecision );
00151         }

void CSIPExSIPStateBase::ErrorOccured (  CSIPExSIPEngine &  aEngine,
TInt  aError
)  [virtual]
 

An asynchronous error has occured related to a periodical refresh that relates to a registration.

Parameters:
aEngine Reference to Engine object.
aError error code
aSIPRegistration associated registration

Definition at line 159 of file SIPExSIPStateBase.cpp.

00162         {
00163         }

© Nokia 2006

Back to top