contentstorage/caclient/s60/inc/caclientnotifierproxy.h
author hgs
Fri, 14 May 2010 17:24:44 +0300
changeset 94 dbb8300717f7
parent 93 82b66994846c
permissions -rw-r--r--
201019
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
85
7feec50967db 201003_02
hgs
parents:
diff changeset
     1
/*
7feec50967db 201003_02
hgs
parents:
diff changeset
     2
 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
7feec50967db 201003_02
hgs
parents:
diff changeset
     3
 * All rights reserved.
7feec50967db 201003_02
hgs
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
7feec50967db 201003_02
hgs
parents:
diff changeset
     5
 * under the terms of "Eclipse Public License v1.0"
7feec50967db 201003_02
hgs
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
7feec50967db 201003_02
hgs
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
7feec50967db 201003_02
hgs
parents:
diff changeset
     8
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
     9
 * Initial Contributors:
7feec50967db 201003_02
hgs
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
7feec50967db 201003_02
hgs
parents:
diff changeset
    11
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    12
 * Contributors:
7feec50967db 201003_02
hgs
parents:
diff changeset
    13
 *
87
hgs
parents: 85
diff changeset
    14
 * Description:
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    15
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    16
 */
7feec50967db 201003_02
hgs
parents:
diff changeset
    17
7feec50967db 201003_02
hgs
parents:
diff changeset
    18
#ifndef CACLIENTNOTIFIERPROXY_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    19
#define CACLIENTNOTIFIERPROXY_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    20
7feec50967db 201003_02
hgs
parents:
diff changeset
    21
#include <QObject>
7feec50967db 201003_02
hgs
parents:
diff changeset
    22
#include <QMutex>
7feec50967db 201003_02
hgs
parents:
diff changeset
    23
#include "cadef.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    24
7feec50967db 201003_02
hgs
parents:
diff changeset
    25
#include "caclient_global.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    26
#include "cadefs.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    27
#include "canotifier_p.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    28
#include "caclientnotifiersession.h"
7feec50967db 201003_02
hgs
parents:
diff changeset
    29
7feec50967db 201003_02
hgs
parents:
diff changeset
    30
class CaEntry;
7feec50967db 201003_02
hgs
parents:
diff changeset
    31
class CaNotifierFilter;
7feec50967db 201003_02
hgs
parents:
diff changeset
    32
93
hgs
parents: 87
diff changeset
    33
class CACLIENT_EXPORT CaClientNotifierProxy: public QObject
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    34
{
87
hgs
parents: 85
diff changeset
    35
    Q_OBJECT
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    36
7feec50967db 201003_02
hgs
parents:
diff changeset
    37
public:
7feec50967db 201003_02
hgs
parents:
diff changeset
    38
7feec50967db 201003_02
hgs
parents:
diff changeset
    39
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    40
     * Constructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    41
     * @param parent pointer to parent. Defaults to NULL.
7feec50967db 201003_02
hgs
parents:
diff changeset
    42
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    43
    explicit CaClientNotifierProxy(QObject *parent = 0);
7feec50967db 201003_02
hgs
parents:
diff changeset
    44
7feec50967db 201003_02
hgs
parents:
diff changeset
    45
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    46
     * Destructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    47
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    48
    ~CaClientNotifierProxy();
7feec50967db 201003_02
hgs
parents:
diff changeset
    49
7feec50967db 201003_02
hgs
parents:
diff changeset
    50
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    51
     * Method for registering notifier
7feec50967db 201003_02
hgs
parents:
diff changeset
    52
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    53
     * @param notifierFilter notifierFilter used to register notifier.
7feec50967db 201003_02
hgs
parents:
diff changeset
    54
     * @param notifierType type of notifier
7feec50967db 201003_02
hgs
parents:
diff changeset
    55
     * @return error code
7feec50967db 201003_02
hgs
parents:
diff changeset
    56
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    57
    int registerNotifier(
7feec50967db 201003_02
hgs
parents:
diff changeset
    58
        const CaNotifierFilter *notifierFilter,
7feec50967db 201003_02
hgs
parents:
diff changeset
    59
        CaNotifierPrivate::NotifierType notifierType,
93
hgs
parents: 87
diff changeset
    60
        const IDataObserver *observer);
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    61
7feec50967db 201003_02
hgs
parents:
diff changeset
    62
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    63
     * Method for unregistering notifier.
7feec50967db 201003_02
hgs
parents:
diff changeset
    64
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    65
     * @param notifierFilter notifierFilter used to unregister notifier.
7feec50967db 201003_02
hgs
parents:
diff changeset
    66
     * @param notifierType type of notifier
7feec50967db 201003_02
hgs
parents:
diff changeset
    67
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    68
    void unregisterNotifier(
7feec50967db 201003_02
hgs
parents:
diff changeset
    69
        const CaNotifierFilter &notifierFilter,
7feec50967db 201003_02
hgs
parents:
diff changeset
    70
        CaNotifierPrivate::NotifierType notifierType);
7feec50967db 201003_02
hgs
parents:
diff changeset
    71
93
hgs
parents: 87
diff changeset
    72
    /**
hgs
parents: 87
diff changeset
    73
     * Reconnect all sessions when server was terminated
hgs
parents: 87
diff changeset
    74
     *
hgs
parents: 87
diff changeset
    75
     */
hgs
parents: 87
diff changeset
    76
    void connectSessions();
85
7feec50967db 201003_02
hgs
parents:
diff changeset
    77
7feec50967db 201003_02
hgs
parents:
diff changeset
    78
private:
7feec50967db 201003_02
hgs
parents:
diff changeset
    79
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    80
     * Method for finding a session with free slots.
7feec50967db 201003_02
hgs
parents:
diff changeset
    81
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    82
     * @return a pointer to a session.
7feec50967db 201003_02
hgs
parents:
diff changeset
    83
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    84
    RCaClientNotifierSession *findSession();
7feec50967db 201003_02
hgs
parents:
diff changeset
    85
7feec50967db 201003_02
hgs
parents:
diff changeset
    86
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    87
     * Method for finding a position of a session with a subsession
7feec50967db 201003_02
hgs
parents:
diff changeset
    88
     * associated with given parameters.
7feec50967db 201003_02
hgs
parents:
diff changeset
    89
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
    90
     * @param notifierFilter notifierFilter used to unregister notifier.
7feec50967db 201003_02
hgs
parents:
diff changeset
    91
     * @param innerNotifierType inner type of notifier
7feec50967db 201003_02
hgs
parents:
diff changeset
    92
     * @return a position of a pointer to a session,
7feec50967db 201003_02
hgs
parents:
diff changeset
    93
     * KErrNotFound when not found.
7feec50967db 201003_02
hgs
parents:
diff changeset
    94
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    95
    TInt findSession(
7feec50967db 201003_02
hgs
parents:
diff changeset
    96
        const CaNotifierFilter &notifierFilter,
7feec50967db 201003_02
hgs
parents:
diff changeset
    97
        CCaInnerNotifierFilter::TNotifierType innerNotifierType) const;
7feec50967db 201003_02
hgs
parents:
diff changeset
    98
7feec50967db 201003_02
hgs
parents:
diff changeset
    99
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
   100
     * Method for creating a new session.
7feec50967db 201003_02
hgs
parents:
diff changeset
   101
     *
7feec50967db 201003_02
hgs
parents:
diff changeset
   102
     * @param[out] error error code.
7feec50967db 201003_02
hgs
parents:
diff changeset
   103
     * @return a pointer to a newly created session, NULL in case of error.
7feec50967db 201003_02
hgs
parents:
diff changeset
   104
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
   105
    RCaClientNotifierSession *newSession(TInt &error);
7feec50967db 201003_02
hgs
parents:
diff changeset
   106
7feec50967db 201003_02
hgs
parents:
diff changeset
   107
private:
7feec50967db 201003_02
hgs
parents:
diff changeset
   108
7feec50967db 201003_02
hgs
parents:
diff changeset
   109
    // Sessions to server.
7feec50967db 201003_02
hgs
parents:
diff changeset
   110
    RArray<RCaClientNotifierSession> mSessions;
7feec50967db 201003_02
hgs
parents:
diff changeset
   111
7feec50967db 201003_02
hgs
parents:
diff changeset
   112
    // Mutex to serialize access to mSessions.
7feec50967db 201003_02
hgs
parents:
diff changeset
   113
    QMutex mMutex;
7feec50967db 201003_02
hgs
parents:
diff changeset
   114
7feec50967db 201003_02
hgs
parents:
diff changeset
   115
    Q_DISABLE_COPY(CaClientNotifierProxy)
7feec50967db 201003_02
hgs
parents:
diff changeset
   116
7feec50967db 201003_02
hgs
parents:
diff changeset
   117
    friend class CaClientProxy;
7feec50967db 201003_02
hgs
parents:
diff changeset
   118
7feec50967db 201003_02
hgs
parents:
diff changeset
   119
};
7feec50967db 201003_02
hgs
parents:
diff changeset
   120
7feec50967db 201003_02
hgs
parents:
diff changeset
   121
#endif //_CACLIENTNOTIFIERPROXY_H