cutelyst 4.3.0
A C++ Web Framework built on top of Qt, using the simple approach of Catalyst (Perl) framework.
Cutelyst::SessionStoreFile Class Reference

A session store that stores user sessions in the file system. More...

#include <Cutelyst/Plugins/Session/sessionstorefile.h>

Inheritance diagram for Cutelyst::SessionStoreFile:

Public Member Functions

 SessionStoreFile (QObject *parent=nullptr)
 
 ~SessionStoreFile ()
 
virtual bool deleteExpiredSessions (Context *c, quint64 expires) final
 
virtual bool deleteSessionData (Context *c, const QByteArray &sid, const QString &key) final
 
virtual QVariant getSessionData (Context *c, const QByteArray &sid, const QString &key, const QVariant &defaultValue) final
 
virtual bool storeSessionData (Context *c, const QByteArray &sid, const QString &key, const QVariant &value) final
 
- Public Member Functions inherited from Cutelyst::SessionStore
 SessionStore (QObject *parent=nullptr)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

This session store stores the session data in the file system. The data is stored in files named after the session id below a directory that is created in the system’s temporary directory and named after your application. For example /tmp/myapplication/session/data.

This is also the default session store that is used by the Session plugin if no session store has been manuall set via Session::setStorage().

Logging category
cutelyst.plugin.sessionfile
Logging with Cutelyst

Definition at line 29 of file sessionstorefile.h.

Constructor & Destructor Documentation

◆ SessionStoreFile()

SessionStoreFile::SessionStoreFile ( QObject parent = nullptr)
explicit

Constructs a new SessionStoreFile object with the given parent.

Definition at line 26 of file sessionstorefile.cpp.

◆ ~SessionStoreFile()

SessionStoreFile::~SessionStoreFile ( )

Destroys the SessionStoreFile object.

Definition at line 31 of file sessionstorefile.cpp.

Member Function Documentation

◆ deleteExpiredSessions()

bool SessionStoreFile::deleteExpiredSessions ( Context c,
quint64  expires 
)
finalvirtual

Reimplemented from SessionStore::deleteExpiredSessions().

Implements Cutelyst::SessionStore.

Definition at line 77 of file sessionstorefile.cpp.

References QDir::removeRecursively().

◆ deleteSessionData()

bool SessionStoreFile::deleteSessionData ( Context c,
const QByteArray sid,
const QString key 
)
finalvirtual

Reimplemented from SessionStore::deleteSessionData().

Implements Cutelyst::SessionStore.

Definition at line 59 of file sessionstorefile.cpp.

References Cutelyst::Context::setStash().

◆ getSessionData()

QVariant SessionStoreFile::getSessionData ( Context c,
const QByteArray sid,
const QString key,
const QVariant defaultValue 
)
finalvirtual

Reimplemented from SessionStore::getSessionData().

Implements Cutelyst::SessionStore.

Definition at line 35 of file sessionstorefile.cpp.

◆ storeSessionData()

bool SessionStoreFile::storeSessionData ( Context c,
const QByteArray sid,
const QString key,
const QVariant value 
)
finalvirtual

Reimplemented from SessionStore::storeSessionData().

Implements Cutelyst::SessionStore.

Definition at line 45 of file sessionstorefile.cpp.

References Cutelyst::Context::setStash().