utilities/serviceipcserver/serviceipcobserver.h
author hgs
Fri, 15 Oct 2010 17:30:59 -0400
changeset 16 3c88a81ff781
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
16
hgs
parents:
diff changeset
     1
/**
hgs
parents:
diff changeset
     2
   This file is part of CWRT package **
hgs
parents:
diff changeset
     3
hgs
parents:
diff changeset
     4
   Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). **
hgs
parents:
diff changeset
     5
hgs
parents:
diff changeset
     6
   This program is free software: you can redistribute it and/or modify
hgs
parents:
diff changeset
     7
   it under the terms of the GNU (Lesser) General Public License as
hgs
parents:
diff changeset
     8
   published by the Free Software Foundation, version 2.1 of the License.
hgs
parents:
diff changeset
     9
   This program is distributed in the hope that it will be useful, but
hgs
parents:
diff changeset
    10
   WITHOUT ANY WARRANTY; without even the implied warranty of
hgs
parents:
diff changeset
    11
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
hgs
parents:
diff changeset
    12
   (Lesser) General Public License for more details. You should have
hgs
parents:
diff changeset
    13
   received a copy of the GNU (Lesser) General Public License along
hgs
parents:
diff changeset
    14
   with this program. If not, see <http://www.gnu.org/licenses/>.
hgs
parents:
diff changeset
    15
*/
hgs
parents:
diff changeset
    16
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef serviceipcobserver_h
hgs
parents:
diff changeset
    19
#define serviceipcobserver_h
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
#include <QtCore>
hgs
parents:
diff changeset
    22
#include "clientinfo.h"
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
namespace WRT {
hgs
parents:
diff changeset
    25
    
hgs
parents:
diff changeset
    26
    class ServiceIPCRequest;
hgs
parents:
diff changeset
    27
    
hgs
parents:
diff changeset
    28
    /**
hgs
parents:
diff changeset
    29
     *  Interface Observer class to handle IPC related events
hgs
parents:
diff changeset
    30
     */
hgs
parents:
diff changeset
    31
    class MServiceIPCObserver
hgs
parents:
diff changeset
    32
    {
hgs
parents:
diff changeset
    33
    public:
hgs
parents:
diff changeset
    34
    
hgs
parents:
diff changeset
    35
        /**
hgs
parents:
diff changeset
    36
         * Handle a new request 
hgs
parents:
diff changeset
    37
         * @param aRequest request object, ownership NOT passed
hgs
parents:
diff changeset
    38
         * @return bool true if handled
hgs
parents:
diff changeset
    39
         */
hgs
parents:
diff changeset
    40
        virtual bool handleRequest(ServiceIPCRequest *aRequest) = 0;
hgs
parents:
diff changeset
    41
    
hgs
parents:
diff changeset
    42
        /**
hgs
parents:
diff changeset
    43
         * Handle any cancellation of an asynchronous request.
hgs
parents:
diff changeset
    44
         * @param aRequest request object that is going to be cancelled, ownership NOT passed
hgs
parents:
diff changeset
    45
         *                 Object will be cleaned up after callback returns
hgs
parents:
diff changeset
    46
         * @return void
hgs
parents:
diff changeset
    47
         */
hgs
parents:
diff changeset
    48
        virtual void handleCancelRequest(ServiceIPCRequest *aRequest) = 0;
hgs
parents:
diff changeset
    49
        
hgs
parents:
diff changeset
    50
        /**
hgs
parents:
diff changeset
    51
        * Handle the connection of a new client to the server
hgs
parents:
diff changeset
    52
        * @param aNewClient information about the new client, including session ID
hgs
parents:
diff changeset
    53
        * @return void
hgs
parents:
diff changeset
    54
        */
hgs
parents:
diff changeset
    55
        virtual void handleClientConnect( ClientInfo *aNewClient ) = 0;
hgs
parents:
diff changeset
    56
        
hgs
parents:
diff changeset
    57
        /**
hgs
parents:
diff changeset
    58
        * Handle the disconnection of a client from the server. 
hgs
parents:
diff changeset
    59
        * This callback is called when a client disconnects (ie closes a session)
hgs
parents:
diff changeset
    60
        * @param aClient information about the client that is disconected
hgs
parents:
diff changeset
    61
        * @return void
hgs
parents:
diff changeset
    62
        */
hgs
parents:
diff changeset
    63
        virtual void handleClientDisconnect( ClientInfo *aClient ) = 0;
hgs
parents:
diff changeset
    64
    };
hgs
parents:
diff changeset
    65
hgs
parents:
diff changeset
    66
}
hgs
parents:
diff changeset
    67
#endif // serviceipcobserver_h