pressrv_plat/watcher_info_api/inc/msimplewinfowatcher.h
changeset 0 c8caa15ef882
equal deleted inserted replaced
-1:000000000000 0:c8caa15ef882
       
     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 watcher info subscriber
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #ifndef M_simplewinfowatcher_H
       
    22 #define M_simplewinfowatcher_H
       
    23 
       
    24 #include <e32std.h>
       
    25 
       
    26 // FORWARD DECLARATION
       
    27 class MSimpleFilterDocument;
       
    28 class MSimpleWinfo;
       
    29 
       
    30 /**
       
    31  *  MSimpleWinfoWatcher
       
    32  *
       
    33  *  SIMPLE Engine watcher info subscriber
       
    34  *
       
    35  *  @lib simpleengine
       
    36  *  @since S60 3.2
       
    37  */
       
    38 
       
    39 class MSimpleWinfoWatcher
       
    40     {
       
    41 
       
    42 public:
       
    43 
       
    44     /**
       
    45      * Destroy this entity
       
    46      *
       
    47      * @since S60 3.2
       
    48      */
       
    49     virtual void Close() = 0;
       
    50 
       
    51     /**
       
    52      * Getter for the SIMPLE engine connection.
       
    53      *
       
    54      * @since S60 3.2
       
    55      * @return the connection.
       
    56      */
       
    57     virtual const MSimpleConnection& Connection() = 0;
       
    58 
       
    59     /**
       
    60      * Subscribe watcher info.
       
    61      *
       
    62      * @since S60 3.2
       
    63      * @param aFilter filter data, may be null and then you'll get all
       
    64      * the changes in WINFO.
       
    65      * @return operation id     
       
    66      */
       
    67     virtual TInt SubscribeWatcherListL( MSimpleFilterDocument* aFilter ) = 0;
       
    68 
       
    69     /**
       
    70      * Unsubscribe.
       
    71      * Leaves with KErrNotFound if there is no active subscription.
       
    72      *
       
    73      * @since S60 3.2
       
    74      * @return operation id
       
    75      */
       
    76     virtual TInt UnsubscribeL( ) = 0;
       
    77 
       
    78     /**
       
    79      * SIP Status code accessor.
       
    80      * Get the status of the last completed request.
       
    81      * Refer to RFC3261, RFC3265, RFC3903.
       
    82      *
       
    83      * @since S60 3.2
       
    84      * @return SIP status, 0 if not available
       
    85      */
       
    86     virtual TUint SIPStatus() = 0;
       
    87 
       
    88     /**
       
    89      * SIP Retry-after header value accessor.
       
    90      * Get the SIP retry-fater header value of the last completed request.
       
    91      * Refer to RFC3261, RFC3265, RFC3903.     
       
    92      *
       
    93      * @since S60 3.2
       
    94      * @return retry-after value in seconds, 0 if not available
       
    95      */
       
    96     virtual TUint SIPRetryAfter() = 0;
       
    97     };
       
    98 
       
    99 #endif
       
   100 
       
   101 // End of File