1 /*

     2 * Copyright (c) 2006 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:    SIMPLE engine connection

    15 *

    16 */

    17 

    18 

    19 

    20 

    21 #ifndef M_simpleconnection_H

    22 #define M_simpleconnection_H

    23 

    24 #include <e32std.h>

    25 

    26 /**

    27  *  MSimpleConnection

    28  *

    29  *  SIMPLE engine connection

    30  *

    31  *  @lib simpleengine

    32  *  @since S60 v3.2

    33  */

    34 

    35 class MSimpleConnection

    36     {

    37 

    38 public:

    39 

    40 enum TSimpleState

    41     {

    42     /** Connection initializing */

    43     EIdle=1,

    44     /** Connection active */

    45     EActive,

    46     /** Connection suspended */

    47     ESuspend,

    48     /** Connection is inactive */

    49     EInactive,

    50     /** Connection is permanently unavailable */

    51     EUnavailable

    52     };

    53 

    54     /**

    55      * Destroy this entity

    56      *

    57      * @since S60 3.2

    58      */

    59     virtual void Close() = 0;

    60 

    61     /**

    62 		 * Login using default SIP Profile settings and SIMPLE Engine default values

    63 		 * instead of given Presence Settings     

    64      * This method is meant mainly for testing purposes.

    65      * Leaves KErrAlreadyExists if this MSimpleConnection

    66      *        entity is already logged in.

    67      * @since S60 3.2

    68      * @return operation id

    69      */

    70     virtual TInt LoginL() = 0;

    71 

    72     /**

    73      * Login using specified Presence Settings

    74      * Leaves KErrAlreadyExists if this MSimpleConnection

    75      *        entity is already logged in.

    76      * Leaves KErrNotFound if specified settings

    77      *        are not found.

    78      * @since S60 3.2

    79      * @param aId Presence Settings id

    80      * @return operation id

    81      */

    82     virtual TInt LoginL( TInt aId ) = 0;

    83 

    84     /**

    85      * Getter for the connection staus.

    86      *

    87      * @since S60 3.2

    88      * @return connection staus

    89      */

    90     virtual TSimpleState ConnectionStatus() = 0;

    91     

    92     /**

    93      * Current SIP identity accessor

    94      *

    95      * @since S60 3.2     

    96      * @return SIP identity

    97      */

    98     virtual TPtrC8 CurrentSIPIdentityL() = 0;    

    99 

   100     };

   101 

   102 #endif

   103 

   104 // End of File