Siperr.H
/** SIP message was malformed */ const TInt KErrSIPMalformedMessage = -17700; /** Invalid SIP response received from registrar*/ const TInt KErrSIPInvalidRegistrarResponse = -17701; /** SIP Request pending */ const TInt KErrSIPRequestPending = -17702; /** The action cannot be performed in the current transaction state */ const TInt KErrSIPInvalidTransactionState = -17703; /** Not allowed in dialogs current state */ const TInt KErrSIPInvalidDialogState = -17704; /** Invalid request in SIP dialog */ const TInt KErrSIPInvalidDialogRequest = -17705; /** Invalid response in SIP dialog */ const TInt KErrSIPInvalidDialogResponse = -17706; /** Sending a SIP message failed. For example ICMP error occured */ const TInt KErrSIPTransportFailure = -17707; /** No ACK was received after sending a 2xx response */ const TInt KErrSIPNoAckReceived = -17708; /** Not allowed in registration's current state */ const TInt KErrSIPInvalidRegistrationState = -17709; /** The contact given did not contain user part */ const TInt KErrSIPInvalidContact = -17710; /** Object can't access a resource, since that has been deleted by user. The user is expected to delete this object as it can no longer be used. */ const TInt KErrSIPResourceNotAvailable = -17711; /** DNS query for the remote address failed */ const TInt KErrSIPResolvingFailure = -17712; /** Authentication with a server failed */ const TInt KErrSIPForbidden = -17713; /** Maximum number of allowed SigComp compartments exceeded */ const TInt KErrSIPMaxCompartmentsInUse = -17714; /** Refresh initiated client transaction was terminated with a 3xx, 4xx, 5xx or 6xx response.*/ const TInt KErrSIPTerminatedWithResponse = -17715; /** Provided SIP outbound proxy is not responding*/ const TInt KErrSIPOutboundProxyNotResponding = -17716; /** The URI type is not allowed in some field of the particular SIP message. Note that this does not mean that the URI type is forbidden in general. For example Contact-header of an INVITE must always contain a SIP-URI. Any other types are rejected with this error code. */ const TInt KErrSIPInvalidURIType = -17717;
sipdefs.H
/** SIP minimum value for the expiration in seconds*/ const TUint KSIPMinExpirationValue=60;
sipconnection.H
/** Connection states */
enum TState
{
/** Connection initializing */
EInit=1,
/** Connection active */
EActive,
/** Connection suspended */
ESuspended,
/** Connection is inactive */
EInactive,
/** Connection is permanently unavailable */
EUnavailable
};
sipdialog.H
/** Dialog states */
enum TState
{
/** Initiliazed state */
EInit,
/** Early state */
EEarly,
/** Confirmed state */
EConfirmed,
/** Terminated state */
ETerminated
};
sipcrkeys.H
const TUid KCRUidSIP = { 0x101FED88 };
// Transaction timer T1 defined in RFC 3261
const TUint32 KSIPTransactionTimerT1 = 0x01;
// Transaction timer T2 defined in RFC 3261
const TUint32 KSIPTransactionTimerT2 = 0x02;
// Transaction timer T4 defined in RFC 3261
const TUint32 KSIPTransactionTimerT4 = 0x03;
siptransactionbase.H
/** SIP transaction state */
enum TState
{
/** Trying state */
ETrying,
/** Calling state */
ECalling,
/** Proceeding state */
EProceeding,
/** Completed state */
ECompleted,
/** Confirmed state */
EConfirmed,
/** Terminated state */
ETerminated
};
class CSIP:
IMPORT_C ~CSIP() IMPORT_C CSIPConnection* Connection(TUint32 aIapId) const IMPORT_C TBool IsSigCompSupportedL() const IMPORT_C HBufC8* NegotiatedSecurityMechanismL(const TDesC8& aHop) IMPORT_C static CSIP* NewL(const TUid& aUid, MSIPObserver& aObserver) IMPORT_C static CSIP* NewLC(const TUid& aUid, MSIPObserver& aObserver)
class CSIPClientTransaction:
IMPORT_C ~CSIPClientTransaction() IMPORT_C virtual TBool CancelAllowed() const IMPORT_C CSIPClientTransaction* CancelL() IMPORT_C const CSIPRefresh* Refresh() const IMPORT_C const CSIPResponseElements* ResponseElements() const
class CSIPConnection:
IMPORT_C ~CSIPConnection() IMPORT_C void GetLocalAddrL(TInetAddr& aAddr) const IMPORT_C CSIPClientTransaction* FetchRegistrationsL(CSIPRequestElements* aElements) IMPORT_C TUint32 IapId() const IMPORT_C static CSIPConnection* NewL(CSIP& aSIP, TUint32 aIapId, MSIPConnectionObserver& aObserver) IMPORT_C static CSIPConnection* NewLC(CSIP& aSIP, TUint32 aIapId, MSIPConnectionObserver& aObserver) IMPORT_C CSIPClientTransaction* SendRequestL(CSIPRequestElements* aElements) IMPORT_C CSIPClientTransaction* SendRequestL(CSIPRequestElements* aElements, CSIPRefresh& aRefresh) IMPORT_C CSIPClientTransaction* SendRequestL(CSIPRequestElements* aElements, const MSIPRegistrationContext& aContext) IMPORT_C CSIPClientTransaction* SendRequestL(CSIPRequestElements* aElements, const MSIPRegistrationContext& aContext, CSIPRefresh& aRefresh) IMPORT_C void SetOptL(TUint aOptionName, TUint aOptionLevel, const TDesC8& aOption=KNullDesC8) IMPORT_C void SetOptL(TUint aOptionName, TUint aOptionLevel, TInt aOption) IMPORT_C CSIP* SIP() IMPORT_C const CSIP* SIP()const IMPORT_C TState State() const
class CSIPDialog:
IMPORT_C const CSIPCallIDHeader& CallIdL() const IMPORT_C CSIPConnection* Connection() IMPORT_C const CSIPConnection* Connection() const IMPORT_C const CSIPFromHeader& FromHeader() const IMPORT_C TBool IsAssociated(const CSIPDialogAssocBase& aDialogAssoc) const IMPORT_C TBool operator==(const CSIPDialog& aDialog) const IMPORT_C const MSIPRegistrationContext* RegistrationContext() const IMPORT_C const CUri8& RemoteURI() const IMPORT_C const RPointerArray<CSIPDialogAssocBase>& SIPDialogAssociations() const IMPORT_C CSIPDialog::TState State() const IMPORT_C const CSIPToHeader& ToHeader() const
class CSIPDialogAssocBase:
IMPORT_C CSIPDialog& Dialog() IMPORT_C const CSIPDialog& Dialog()const IMPORT_C TBool IsNonTargetRefreshRequest(RStringF aMethod) const IMPORT_C virtual CSIPClientTransaction* SendNonTargetRefreshRequestL(RStringF aMethod, CSIPMessageElements* aElements) IMPORT_C RStringF Type() const
class CSIPInviteDialogAssoc:
IMPORT_C ~CSIPInviteDialogAssoc() IMPORT_C static CSIPInviteDialogAssoc* NewL(CSIPDialog& aSIPDialog) IMPORT_C static CSIPInviteDialogAssoc* NewL(CSIPServerTransaction& aTransaction) IMPORT_C static CSIPInviteDialogAssoc* NewL(CSIPConnection& aConnection, CSIPFromHeader* aFrom, CUri8* aRemoteUri, CSIPToHeader* aTo=0, CSIPContactHeader* aContact=0) IMPORT_C static CSIPInviteDialogAssoc* NewL(CSIPConnection& aConnection, CUri8* aRemoteUri = 0, const MSIPRegistrationContext& aContext, CSIPFromHeader* aFrom = 0, CSIPToHeader* aTo=0, CSIPContactHeader* aContact = 0) IMPORT_C static CSIPInviteDialogAssoc* NewLC(CSIPDialog& aSIPDialog) IMPORT_C static CSIPInviteDialogAssoc* NewLC(CSIPServerTransaction& aTransaction) IMPORT_C static CSIPInviteDialogAssoc* NewLC(CSIPConnection& aConnection, CSIPFromHeader* aFrom, CUri8* aRemoteUri, CSIPToHeader* aTo=0, CSIPContactHeader* aContact=0) IMPORT_C static CSIPInviteDialogAssoc* NewLC(CSIPConnection& aConnection, CUri8* aRemoteUri = 0, const MSIPRegistrationContext& aContext, CSIPFromHeader* aFrom = 0, CSIPToHeader* aTo=0, CSIPContactHeader* aContact = 0) IMPORT_C void SendAckL(const CSIPClientTransaction& aTransaction, CSIPMessageElements* aElements=0) IMPORT_C CSIPClientTransaction* SendByeL(CSIPMessageElements* aElements=0) IMPORT_C CSIPClientTransaction* SendInviteL(CSIPMessageElements* aElements=0) IMPORT_C CSIPClientTransaction* SendPrackL(CSIPMessageElements* aElements=0) IMPORT_C CSIPClientTransaction* SendUpdateL(CSIPMessageElements* aElements=0)
class CSIPMessageElements:
IMPORT_C ~CSIPMessageElements() IMPORT_C const TDesC8& Content() const IMPORT_C const CSIPContentTypeHeader* ContentType() const IMPORT_C HBufC8* ExtractContent() IMPORT_C static CSIPMessageElements* NewL() IMPORT_C static CSIPMessageElements* NewLC() IMPORT_C void SetContentL(HBufC8* aContent, CSIPContentTypeHeader* aContentType) IMPORT_C void SetUserHeadersL(RPointerArray<CSIPHeaderBase>& aHeaders) IMPORT_C const RPointerArray<CSIPHeaderBase>& UserHeaders() const
class CSIPNotifyDialogAssoc:
IMPORT_C ~CSIPNotifyDialogAssoc() IMPORT_C const CSIPEventHeader& Event() const IMPORT_C static CSIPNotifyDialogAssoc* NewL(CSIPServerTransaction& aTransaction, CSIPEventHeader* aEvent, CSIPSubscriptionStateHeader* aState) IMPORT_C static CSIPNotifyDialogAssoc* NewLC(CSIPServerTransaction& aTransaction, CSIPEventHeader* aEvent, CSIPSubscriptionStateHeader* aState) IMPORT_C CSIPClientTransaction* SendNotifyL(CSIPMessageElements* aElements=0) IMPORT_C CSIPSubscriptionStateHeader& SubscriptionState() IMPORT_C const CSIPSubscriptionStateHeader& SubscriptionState() const
class CSIPreferDialogAssoc:
IMPORT_C ~CSIPReferDialogAssoc() IMPORT_C static CSIPReferDialogAssoc* NewL(CSIPDialog& aDialog, CSIPReferToHeader* aReferTo) IMPORT_C static CSIPReferDialogAssoc* NewL(CSIPConnection& aConnection, CSIPFromHeader* aFrom, CUri8* aRemoteUri, CSIPReferToHeader* aReferTo, CSIPToHeader* aTo=0, CSIPContactHeader* aContact=0) IMPORT_C static CSIPReferDialogAssoc* NewL(CSIPConnection& aConnection, CUri8* aRemoteUri, const MSIPRegistrationContext& aContext, CSIPReferToHeader* aReferTo, CSIPFromHeader* aFrom, CSIPToHeader* aTo=0, CSIPContactHeader* aContact=0) IMPORT_C static CSIPReferDialogAssoc* NewLC(CSIPDialog& aDialog, CSIPReferToHeader* aReferTo) IMPORT_C static CSIPReferDialogAssoc* NewLC(CSIPConnection& aConnection, CSIPFromHeader* aFrom, CUri8* aRemoteUri, CSIPReferToHeader* aReferTo, CSIPToHeader* aTo=0, CSIPContactHeader* aContact=0) IMPORT_C static CSIPReferDialogAssoc* NewLC(CSIPConnection& aConnection, CUri8* aRemoteUri, const MSIPRegistrationContext& aContext, CSIPReferToHeader* aReferTo, CSIPFromHeader* aFrom, CSIPToHeader* aTo=0, CSIPContactHeader* aContact=0) IMPORT_C const CSIPReferToHeader& ReferTo() const IMPORT_C CSIPClientTransaction* SendReferL(CSIPMessageElements* aElements=0)
class CSIPRefresh:
IMPORT_C ~CSIPRefresh() IMPORT_C TUint IntervalL() const IMPORT_C TBool IsStandAlone() const IMPORT_C static CSIPRefresh* NewL() IMPORT_C static CSIPRefresh* NewLC() IMPORT_C TBool operator==(const CSIPRefresh& aRefresh) const IMPORT_C void SetIntervalL(TUint aInterval) IMPORT_C const CSIPClientTransaction* SIPTransaction() const IMPORT_C CSIPRefresh::TState State() const IMPORT_C CSIPClientTransaction* TerminateL(CSIPMessageElements* aElements=0) IMPORT_C CSIPClientTransaction* UpdateL(CSIPMessageElements* aElements=0)
class CSIPRegistrationBinding:
IMPORT_C ~CSIPRegistrationBinding() IMPORT_C const CSIPToHeader& Aor() const IMPORT_C CSIPConnection* Connection() IMPORT_C const CSIPConnection* Connection()const IMPORT_C CSIPContactHeader& ContactHeader() IMPORT_C const CSIPContactHeader& ContactHeader() const IMPORT_C TUint32 ContextId() const IMPORT_C CSIPClientTransaction* DeregisterL(CSIPMessageElements* aElements=0) IMPORT_C TBool IsContextActive() const IMPORT_C static CSIPRegistrationBinding* NewL(CSIPConnection& aConnection, CSIPToHeader* aAor, CSIPContactHeader* aContact, CSIPRefresh* aRefresh=0, CSIPRouteHeader* aOutboundProxy=0, CUri8* aRemoteUri=0, CSIPFromHeader* aFrom=0) IMPORT_C static CSIPRegistrationBinding* NewLC(CSIPConnection& aConnection, CSIPToHeader* aAor, CSIPContactHeader* aContact, CSIPRefresh* aRefresh=0, CSIPRouteHeader* aOutboundProxy=0, CUri8* aRemoteUri=0, CSIPFromHeader* aFrom=0) IMPORT_C TBool operator==(const CSIPRegistrationBinding& aRegistration) const IMPORT_C const CSIPRouteHeader* OutboundProxy() const IMPORT_C CSIPClientTransaction* RegisterL(CSIPMessageElements* aElements=0) IMPORT_C void SetOutboundProxyL(CSIPRouteHeader* aOutboundProxy) IMPORT_C const CSIPRefresh* SIPRefresh() const IMPORT_C CSIPRefresh* SIPRefresh() IMPORT_C CSIPClientTransaction* UpdateL(CSIPMessageElements* aElements) IMPORT_C CSIPClientTransaction* UpdateL(TUint aExpirationValue, CSIPMessageElements* aElements=0)
class CSIPRequestElements:
IMPORT_C ~CSIPRequestElements() IMPORT_C const CSIPFromHeader* FromHeader() const IMPORT_C const CSIPMessageElements& MessageElements() const IMPORT_C CSIPMessageElements& MessageElements() IMPORT_C RStringF Method() const IMPORT_C static CSIPRequestElements* NewL(CUri8* aRemoteUri) IMPORT_C static CSIPRequestElements* NewLC(CUri8* aRemoteUri) IMPORT_C const CUri8& RemoteUri() const IMPORT_C void SetFromHeaderL(CSIPFromHeader* aFrom) IMPORT_C void SetMethodL(RStringF aMethod) IMPORT_C void SetRemoteUriL(CUri8* aRemoteUri) IMPORT_C void SetToHeaderL(CSIPToHeader* aTo) IMPORT_C const CSIPToHeader* ToHeader() const
class CSIPResponseElements:
IMPORT_C ~CSIPResponseElements() IMPORT_C const CSIPCSeqHeader* CSeqHeader() const IMPORT_C const CSIPFromHeader* FromHeader() const IMPORT_C CSIPMessageElements& MessageElements() IMPORT_C CSIPMessageElements& MessageElements() IMPORT_C const CSIPMessageElements& MessageElements() const IMPORT_C static CSIPResponseElements* NewL(TUint aStatusCode, RStringF aReasonPhrase) IMPORT_C static CSIPResponseElements* NewLC(TUint aStatusCode, RStringF aReasonPhrase) IMPORT_C RStringF ReasonPhrase() const IMPORT_C void SetReasonPhraseL(RStringF aReasonPhrase) IMPORT_C void SetStatusCodeL(TUint aStatusCode) IMPORT_C TUint StatusCodeL() IMPORT_C const CSIPToHeader* ToHeader() const
class CSIPServerTransaction:
IMPORT_C ~CSIPServerTransaction() IMPORT_C const CSIPRequestElements* RequestElements() const IMPORT_C TBool ResponseAllowed() const IMPORT_C void SendResponseL(CSIPResponseElements *aElements)
class CSIPSubscribeDialogAssoc:
IMPORT_C ~CSIPSubscribeDialogAssoc() IMPORT_C const CSIPEventHeader& Event() const IMPORT_C static CSIPSubscribeDialogAssoc* NewL(CSIPDialog& aDialog, CSIPEventHeader* aEvent) IMPORT_C static CSIPSubscribeDialogAssoc* NewL(CSIPConnection& aConnection, CSIPFromHeader* aFrom, CUri8* aRemoteUri, CSIPEventHeader* aEvent, CSIPToHeader* aTo=0, CSIPContactHeader* aContact=0) IMPORT_C static CSIPSubscribeDialogAssoc* NewL(CSIPConnection& aConnection, CUri8* aRemoteUri, const MSIPRegistrationContext& aContext, CSIPEventHeader* aEvent, CSIPFromHeader* aFrom = 0, CSIPToHeader* aTo = 0, CSIPContactHeader* aContact = 0) IMPORT_C static CSIPSubscribeDialogAssoc* NewLC(CSIPDialog& aDialog, CSIPEventHeader* aEvent) IMPORT_C static CSIPSubscribeDialogAssoc* NewLC(CSIPConnection& aConnection, CSIPFromHeader* aFrom, CUri8* aRemoteUri, CSIPEventHeader* aEvent, CSIPToHeader* aTo=0, CSIPContactHeader* aContact=0) IMPORT_C static CSIPSubscribeDialogAssoc* NewLC(CSIPConnection& aConnection, CUri8* aRemoteUri, const MSIPRegistrationContext& aContext, CSIPEventHeader* aEvent, CSIPFromHeader* aFrom = 0, CSIPToHeader* aTo = 0, CSIPContactHeader* aContact = 0) IMPORT_C CSIPClientTransaction* SendSubscribeL(CSIPMessageElements* aElements=0, CSIPRefresh* aRefresh=0) IMPORT_C CSIPClientTransaction* SendUnsubscribeL(CSIPMessageElements* aElements=0) IMPORT_C const CSIPRefresh* SIPRefresh() const IMPORT_C CSIPClientTransaction* UpdateL(CSIPMessageElements* aElements)
class CSIPTransactionBase:
IMPORT_C TBool IsSIPClientTransaction() const IMPORT_C TBool operator==(const CSIPTransactionBase& aTransaction) const IMPORT_C CSIPTransactionBase::TState StateL() IMPORT_C RStringF Type() const
class CSIPHttpDigest:
IMPORT_C ~CSIPHttpDigest() IMPORT_C TInt IgnoreChallenge(const TDesC8& aRealm) IMPORT_C static CSIPHttpDigest* NewL(CSIP& aSIP, MSIPHttpDigestChallengeObserver& aObserver) IMPORT_C static CSIPHttpDigest* NewLC(CSIP& aSIP, MSIPHttpDigestChallengeObserver& aObserver) IMPORT_C TInt RemoveCredentials(const TDesC8& aRealm) IMPORT_C TInt RemoveCredentials() IMPORT_C void SetCredentialsL(const TDesC8& aOutboundProxy, const TDesC8& aRealm, const TDesC8& aUsername, const TDesC8& aPasswd) IMPORT_C void SetCredentialsL(const TDesC8& aRealm, const TDesC8& aUsername, const TDesC8& aPasswd) IMPORT_C void SetObserver(MSIPHttpDigestChallengeObserver& aObserver)
class MSIPConnectionObserver:
virtual void ConnectionStateChanged(CSIPConnection::TState aState) = 0 virtual void ErrorOccured (TInt aError, CSIPTransactionBase& aTransaction) = 0 virtual void ErrorOccured(TInt aError, CSIPClientTransaction& aTransaction, CSIPRegistrationBinding& aRegistration) = 0 virtual void ErrorOccured(TInt aError, CSIPTransactionBase& aTransaction, CSIPDialogAssocBase& aDialogAssoc) = 0 virtual void ErrorOccured(TInt aError, CSIPRefresh& aSIPRefresh) = 0 virtual void ErrorOccured(TInt aError, CSIPRegistrationBinding& aRegistration) = 0 virtual void ErrorOccured(TInt aError, CSIPDialogAssocBase& aDialogAssoc) = 0 virtual void IncomingResponse(CSIPClientTransaction& aTransaction) = 0 virtual void IncomingResponse(CSIPClientTransaction& aTransaction, CSIPDialogAssocBase& aDialogAssoc) = 0 virtual void IncomingResponse(CSIPClientTransaction& aTransaction, CSIPInviteDialogAssoc* aDialogAssoc) = 0 virtual void IncomingResponse(CSIPClientTransaction& aTransaction, CSIPRegistrationBinding& aRegistration) = 0 virtual void IncomingRequest(CSIPServerTransaction* aTransaction) = 0 virtual void IncomingRequest(CSIPServerTransaction* aTransaction, CSIPDialog& aDialog) = 0 virtual void InviteCanceled(CSIPClientTransaction& aTransaction) = 0 virtual void InviteCompleted(CSIPClientTransaction& aTransaction) = 0
class MSIPHttpDigestChallengeObserver:
virtual void ChallengeReceived(const TDesC8& aRealm) = 0
class MSIPObserver:
virtual void IncomingRequest(TUint32 aIapId, CSIPServerTransaction* aTransaction) = 0 virtual void TimedOut(CSIPServerTransaction& aTransaction) = 0
class MSIPRegistrationContext:
virtual ~MSIPRegistrationContext()
virtual TUint32 ContextId() const = 0
virtual TBool IsContextActive() const = 0