harvester/blacklistserver/inc/blacklistsession.h
changeset 0 c53acadfccc6
equal deleted inserted replaced
-1:000000000000 0:c53acadfccc6
       
     1 /*
       
     2 * Copyright (c) 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 *
       
    16 */
       
    17 #ifndef __SESSION_H__
       
    18 #define __SESSION_H__
       
    19 
       
    20 // SYSTEM INCLUDE
       
    21 #include <e32base.h>
       
    22 
       
    23 // FORWARD DECLERATIONS
       
    24 class CBlacklistServer;
       
    25 
       
    26 /*!
       
    27   @class CBlacklistSession
       
    28   @discussion An instance of the CBlacklistSession object 
       
    29   */
       
    30 class CBlacklistSession : public CSession2
       
    31     {
       
    32     public:
       
    33 
       
    34         /*!
       
    35         @function CBlacklistSession
       
    36         @discussion standard C++ constructor.
       
    37         */
       
    38         CBlacklistSession();
       
    39         
       
    40         /*!
       
    41         @function CreateL
       
    42         @discussion Adds session to server.
       
    43         */
       
    44         void CreateL();
       
    45 
       
    46     private: // private functions
       
    47  
       
    48          /*!
       
    49         @function LoadBlacklistDataL
       
    50         @discussion forward request to server to load blacklist.
       
    51         @param aMessage, contains service request.
       
    52         */
       
    53         void LoadBlacklistDataL( const RMessage2& aMessage ); 
       
    54         
       
    55          /*!
       
    56         @function AddL
       
    57         @discussion forward request to server to add item to blacklist.
       
    58         @param aMessage, contains added item's data.
       
    59         */
       
    60         void AddL( const RMessage2& aMessage );
       
    61         
       
    62          /*!
       
    63         @function RemoveL
       
    64         @discussion forward request to server to remove item from blacklist.
       
    65         @param aMessage, contains removed item's data.
       
    66         */
       
    67         void RemoveL( const RMessage2& aMessage );  
       
    68         
       
    69          /*!
       
    70         @function RemoveFromDBL
       
    71         @discussion forward request to server to remove item from database.
       
    72         @param aMessage, contains removed item's data.
       
    73         */
       
    74         void RemoveFromDBL( const RMessage2& aMessage );
       
    75         
       
    76          /*!
       
    77         @function CloseDB
       
    78         @discussion forward request to server to close database.
       
    79         @param aMessage, empty, not used.
       
    80         */
       
    81         void CloseDB( const RMessage2& aMessage );  
       
    82         
       
    83          /*!
       
    84         @function ~CBlacklistSession
       
    85         @discussion standard C++ destructor. Send request to server to remove session.
       
    86         */
       
    87         ~CBlacklistSession();
       
    88 
       
    89          /*!
       
    90         @function Server
       
    91         @discussion factory function.
       
    92         @result returns reference to server.
       
    93         */
       
    94         CBlacklistServer& Server();
       
    95         
       
    96          /*!
       
    97         @function ServiceL
       
    98         @discussion handles service requests.
       
    99         @param aMessage, contains service request.
       
   100         */
       
   101         void ServiceL( const RMessage2& aMessage );
       
   102     };
       
   103 
       
   104 #endif