Abstract class to create a session store. More...

#include <Cutelyst/Plugins/Session/Session>

Inheritance diagram for Cutelyst::SessionStore:

[legend]

Public Member Functions
	SessionStore (QObject *parent=nullptr)

virtual bool	deleteExpiredSessions (Context *c, quint64 expires)=0

virtual bool	deleteSessionData (Context *c, const QByteArray &sid, const QString &key)=0

virtual QVariant	getSessionData (Context *c, const QByteArray &sid, const QString &key, const QVariant &defaultValue=QVariant())=0

virtual bool	storeSessionData (Context *c, const QByteArray &sid, const QString &key, const QVariant &value)=0

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () 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< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	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 QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () 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

T	qobject_cast (const QObject *object)

T	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)

QThread *	thread () 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

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Properties inherited from QObject
	objectName

Detailed Description

Use this class to create your own session store to use with the Session plugin. Reimplement the pure virtual functions getSessionData(), storeSessionData(), deleteSessionData() and deleteExpiredSessions() in your derived class.

Cutelyst already ships with some session stores to store user sessions in the filesystem or on memcached servers.

Definition at line 35 of file session.h.

Constructor & Destructor Documentation

◆ SessionStore()

SessionStore::SessionStore ( QObject * parent = nullptr )

explicit

Constructs a new SessionStore object with the given parent.

Definition at line 634 of file session.cpp.

Member Function Documentation

◆ deleteExpiredSessions()

virtual bool Cutelyst::SessionStore::deleteExpiredSessions	(	Context *	c,
		quint64	expires
	)

pure virtual

Removes all expired sessions which are above expires.

Implemented in Cutelyst::SessionStoreFile, and Cutelyst::MemcachedSessionStore.

◆ deleteSessionData()

virtual bool Cutelyst::SessionStore::deleteSessionData	(	Context *	c,
		const QByteArray &	sid,
		const QString &	key
	)

pure virtual

Removes all session data for the given session id sid and key.

Implemented in Cutelyst::SessionStoreFile, and Cutelyst::MemcachedSessionStore.

◆ getSessionData()

virtual QVariant Cutelyst::SessionStore::getSessionData	(	Context *	c,
		const QByteArray &	sid,
		const QString &	key,
		const QVariant &	defaultValue = `QVariant()`
	)

pure virtual

Returns the session data for the given session id sid and key, if key does not exist returns defaultValue.

Implemented in Cutelyst::SessionStoreFile, and Cutelyst::MemcachedSessionStore.

◆ storeSessionData()

virtual bool Cutelyst::SessionStore::storeSessionData	(	Context *	c,
		const QByteArray &	sid,
		const QString &	key,
		const QVariant &	value
	)

pure virtual

Stores the session data for the given session id sid and key to value.

Implemented in Cutelyst::SessionStoreFile, and Cutelyst::MemcachedSessionStore.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SessionStore()

Member Function Documentation

◆ deleteExpiredSessions()

◆ deleteSessionData()

◆ getSessionData()

◆ storeSessionData()