epoc32/include/mw/siphttpdigestchallengeobserver.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:
    15 * Name        : siphttpdigestchallengeobserver.h
    16 * Part of     : SIP Client
    17 * Interface   : SDK API, SIP Client API
    18 * Version     : 1.0
    19 *
    20 */
    21 
    22 
    23 
    24 #ifndef MSIPHTTPDIGESTCHALLENGEOBSERVER_H
    25 #define MSIPHTTPDIGESTCHALLENGEOBSERVER_H
    26 
    27 // FORWARD DECLARATIONS
    28 
    29 // CLASS DECLARATION
    30 
    31 /**
    32 * @publishedAll
    33 * @released
    34 *
    35 * The user must implement this interface if it intends to
    36 * provide HTTP Digest credentials upon received challenges
    37 * from the SIP servers on the signaling path.
    38 * The user should provide credentials or ignore the challenge
    39 * using functions defined in TSIPHttpDigest class.
    40 *
    41 * MSIPHttpDigestChallengeObserver class is compliant with RFC 2543
    42 * where Proxy use to forward only one challenge when it receives 
    43 * multiple challenges on forking the request. Applications are 
    44 * encouraged to use MSIPHttpDigestChallengeObserver2 class which
    45 * provides interface to extract multiple challenges.
    46 * MSIPHttpDigestChallengeObserver2 class is compliant to RFC 3261
    47 *  @lib n/a
    48 */
    49 class MSIPHttpDigestChallengeObserver
    50 	{
    51     public: // New functions
    52 		/**
    53 		* SIP request resulted in 401/407 response that contains
    54 		* a challenge.
    55 		*
    56 		* @param aRealm a realm for which the challenge was received
    57 		*/
    58 		virtual void ChallengeReceived(const TDesC8& aRealm) = 0;
    59 	};
    60 
    61 #endif