1 /*

     2 * Copyright (c) 2007 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 *

    16 */

    17 

    18 

    19 

    20 #ifndef M_ICECHECKLISTOBSERVER_H

    21 #define M_ICECHECKLISTOBSERVER_H

    22 

    23 

    24 #include <e32base.h>

    25 #include "natfwconnectivityapidefs.h"

    26 

    27 class CIceCheckList;

    28 class CNATFWCandidatePair;

    29 

    30 /**

    31  *  Obsever interface for the client of ICE check list.

    32  *

    33  *  @lib icecandidatehandler.dll

    34  *  @since S60 v3.2

    35  */

    36 class MIceChecklistObserver

    37     {

    38 

    39 public:

    40 

    41     /**

    42      * Indicates that check list has completed successfully.

    43      * Ownership of selected pairs is transferred.

    44      *

    45      * @since   S60 v3.2

    46      * @param   aChecklist      The checklist which was completed

    47      * @param   aSelectedPairs  The selected pairs for components

    48      */

    49     virtual void ChecklistCompletedL( 

    50         const CIceCheckList& aChecklist, 

    51         const RPointerArray<CNATFWCandidatePair>& aSelectedPairs ) = 0;

    52 

    53     /**

    54      * Indicates that check list has completed unsuccessfully.

    55      *

    56      * @since   S60 v3.2

    57      * @param   aChecklist      The checklist which was completed

    58      * @param   aFailedComps    The failed components

    59      * @param   aErrCode        The completion code

    60      */

    61     virtual void ChecklistCompletedL( 

    62         const CIceCheckList& aChecklist,

    63         const RArray<TUint>& aFailedComps,

    64         TInt aErrCode ) = 0;

    65 

    66     /**

    67      * Indicates that those checks in other checklists, which have same

    68      * foundation could be now unfrozen as an optimization.

    69      *

    70      * @since   S60 v3.2

    71      * @param   aChecklist      The checklist reporting event

    72      * @param   aFoundation     The foundation

    73      */

    74     virtual void ComponentsHaveValidPairsL( 

    75         const CIceCheckList& aChecklist, const TDesC8& aFoundation ) = 0;

    76     

    77     /**

    78      * Called when check list has detected role conflict between peers and

    79      * local peer needs to change it's role.

    80      * 

    81      * @since   S60 v3.2

    82      * @param   aDesiredRole    Desired role

    83      */

    84     virtual void RoleChangeNeeded( TNATFWIceRole aDesiredRole ) = 0;

    85     };

    86 

    87 

    88 #endif // M_ICECHECKLISTOBSERVER_H