session.hpp

/* Copyright (c) 2014, The Nuria Project
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *    1. The origin of this software must not be misrepresented; you must not
 *       claim that you wrote the original software. If you use this software
 *       in a product, an acknowledgment in the product documentation would be
 *       appreciated but is not required.
 *    2. Altered source versions must be plainly marked as such, and must not be
 *       misrepresented as being the original software.
 *    3. This notice may not be removed or altered from any source
 *       distribution.
 */

#ifndef NURIA_SESSION_HPP
#define NURIA_SESSION_HPP

#include "essentials.hpp"

#include <QSharedData>
#include <QVariant>

namespace Nuria {

class AbstractSessionManager;
class SessionPrivate;
class Session;

NURIA_CORE_EXPORT bool operator== (const Session &a, const Session &b);
NURIA_CORE_EXPORT bool operator!= (const Session &a, const Session &b);

class NURIA_CORE_EXPORT Session {
public:
    Session ();
    
    Session (const Session& other);
    
    Session &operator= (const Session &other);
    
    ~Session ();
    
    bool isValid () const;
    
    QByteArray id () const;
    
    AbstractSessionManager *manager () const;
    
    bool isDirty () const;
    
    void markDirty ();
    
    void markClean ();
    
    void remove ();
    
    int refCount () const;
    
    QVariant value (const QString &key) const;
    
    bool contains (const QString &key) const;
    
    QVariant &operator[] (const QString &key);
    
    QVariant operator[] (const QString &key) const;
    

private:
    friend class AbstractSessionManager;
    friend bool operator== (const Session &a, const Session &b);
    friend bool operator!= (const Session &a, const Session &b);
    
    Session (const QByteArray &id, AbstractSessionManager *manager);
    
    QExplicitlySharedDataPointer< SessionPrivate > d;
};

} // namespace Nuria

Q_DECLARE_METATYPE(Nuria::Session)

#endif // NURIA_SESSION_HPP