/usr/include/akonadi/session.h is in kdepimlibs5-dev 4:4.13.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 | /*
Copyright (c) 2007 Volker Krause <vkrause@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef AKONADI_SESSION_H
#define AKONADI_SESSION_H
#include "akonadi_export.h"
#include <QtCore/QObject>
class KJob;
class FakeSession;
namespace Akonadi {
class Job;
class SessionPrivate;
/**
* @short A communication session with the Akonadi storage.
*
* Every Job object has to be associated with a Session.
* The session is responsible of scheduling its jobs.
* For now only a simple serial execution is implemented (the IMAP-like
* protocol to communicate with the storage backend is capable of parallel
* execution on a single session though).
*
* @code
*
* using namespace Akonadi;
*
* Session *session = new Session( "mySession" );
*
* CollectionFetchJob *job = new CollectionFetchJob( Collection::root(),
* CollectionFetchJob::Recursive,
* session );
*
* connect( job, SIGNAL( result( KJob* ) ), this, SLOT( slotResult( KJob* ) ) );
*
* @endcode
*
* @author Volker Krause <vkrause@kde.org>
*/
class AKONADI_EXPORT Session : public QObject
{
Q_OBJECT
friend class Job;
friend class JobPrivate;
friend class SessionPrivate;
public:
/**
* Creates a new session.
*
* @param sessionId The identifier for this session, will be a
* random value if empty.
* @param parent The parent object.
*
* @see defaultSession()
*/
explicit Session( const QByteArray &sessionId = QByteArray(), QObject *parent = 0 );
/**
* Destroys the session.
*/
~Session();
/**
* Returns the session identifier.
*/
QByteArray sessionId() const;
/**
* Returns the default session for this thread.
*/
static Session* defaultSession();
/**
* Stops all jobs queued for execution.
*/
void clear();
Q_SIGNALS:
/**
* This signal is emitted whenever the session has been reconnected
* to the server (e.g. after a server crash).
*
* @since 4.6
*/
void reconnected();
protected:
/**
* Creates a new session with shared private object.
*
* @param d The private object.
* @param sessionId The identifier for this session, will be a
* random value if empty.
* @param parent The parent object.
*
* @note This constructor is needed for unit testing only.
*/
explicit Session( SessionPrivate *d, const QByteArray &sessionId = QByteArray(), QObject *parent = 0 );
private:
//@cond PRIVATE
SessionPrivate* const d;
friend class ::FakeSession;
Q_PRIVATE_SLOT( d, void reconnect() )
Q_PRIVATE_SLOT( d, void socketError( QLocalSocket::LocalSocketError ) )
Q_PRIVATE_SLOT( d, void socketError( QAbstractSocket::SocketError ) )
Q_PRIVATE_SLOT( d, void socketDisconnected() )
Q_PRIVATE_SLOT( d, void dataReceived() )
Q_PRIVATE_SLOT( d, void doStartNext() )
Q_PRIVATE_SLOT( d, void jobDone( KJob* ) )
Q_PRIVATE_SLOT( d, void jobWriteFinished( Akonadi::Job* ) )
Q_PRIVATE_SLOT( d, void jobDestroyed( QObject* ) )
Q_PRIVATE_SLOT( d, void serverStateChanged( Akonadi::ServerManager::State ) )
//@endcond PRIVATE
};
}
#endif
|