contentpublishingsrv/contentharvester/contentharvesterclient/inc/contentharvesterclient.h
changeset 73 4bc7b118b3df
parent 66 32469d7d46ff
child 80 397d00875918
child 81 5ef31a21fdd5
equal deleted inserted replaced
66:32469d7d46ff 73:4bc7b118b3df
     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 #ifndef C_CONTENTHARVESTERCLIENT_H
       
    20 #define C_CONTENTHARVESTERCLIENT_H
       
    21 
       
    22 // INCLUDES
       
    23 #include <e32base.h>
       
    24 
       
    25 // FORWARD DECLARATIONS
       
    26 
       
    27 
       
    28 // CLASS DECLARATION
       
    29 
       
    30 /**
       
    31  * @brief Client-side interface to CP Active Data Server
       
    32  *
       
    33  * This class provides the client-side interface to the active data server session,
       
    34  * it just passes requests to the server.
       
    35  *
       
    36  * @lib contentharvesterclient.lib
       
    37  * @since S60 v3.1
       
    38  */
       
    39 class RContentHarvesterClient : public RSessionBase
       
    40     {
       
    41 public:
       
    42 
       
    43     /**
       
    44      * Construct the object.
       
    45      */
       
    46     IMPORT_C RContentHarvesterClient();
       
    47 
       
    48     /**
       
    49      * Connects to the server and create a session.
       
    50      * When the server is not running, the function starts the server.
       
    51      * @return error code
       
    52      */
       
    53     IMPORT_C TInt Connect();
       
    54 
       
    55     /**
       
    56      * Triggers updating process of Active Data Server, 
       
    57      * the function returns right after the server receives the request 
       
    58      * (it isn't information about the whole update process.) 
       
    59      * @return error code
       
    60      */
       
    61     IMPORT_C TInt Update();
       
    62 
       
    63     /**
       
    64      * Triggers stop process on server	
       
    65      * @return error code
       
    66      */
       
    67     IMPORT_C TInt Stop();
       
    68 
       
    69     /**
       
    70      * Returns the version number
       
    71      * @return the version
       
    72      */
       
    73     TVersion Version() const;
       
    74     };
       
    75 
       
    76 #endif // C_CONTENTHARVESTERCLIENT_H
       
    77 // End of File