#include <Cutelyst/Pugins/MemcachedSessionStore/MemcachedSessionStore>

Inheritance diagram for Cutelyst::MemcachedSessionStore:

[legend]

Public Member Functions
	MemcachedSessionStore (Application app, QObject parent=nullptr)

	~MemcachedSessionStore () override

bool	deleteExpiredSessions (Context *c, quint64 expires) override

bool	deleteSessionData (Context *c, const QByteArray &sid, const QString &key) override

QVariant	getSessionData (Context *c, const QByteArray &sid, const QString &key, const QVariant &defaultValue) override

void	setGroupKey (const QByteArray &groupKey)

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

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

This session store saves session data to Memcached servers using the Memcached plugin.

Note: The memcached server does not guarantee the existence of the session data. It might for example delete the data because it runs out of memory and deletes session data. So be careful when using this plugin to store sessions.

Configuration

The MemcachedSessionStore plugin can be configured in the application configuration file in the Cutelyst_MemcachedSessionStore_Plugin section:

group_key

Type: string Default: empty

Sets an optional group key to store the data on a specific server.

Configuration example

[Cutelyst_MemcachedSessionStore_Plugin]

group_key=sessions

Usage example

#include <Cutelyst/Plugins/Memcached/Memcached>
#include <Cutelyst/Plugins/MemcachedSessionStore/MemcachedSessionStore>
 
bool MyCutelystApp::init()
{
    // other initilization stuff
    // ...
 
    new Memcached(this);
    auto sess = new Session(this);
    sess->setStorage(new MemcachedSessionStore(this));
 
    // maybe more initilization stuff
    // ...
}

Build requirements

To build this plugin you need the development and header files for libmemcached and have to enable the Memcached plugin. If the Memcached plugin is enabled, the MemcachedSessionStore plugin will be enabled automatically, too. To disable the build of the MemcachedSessionStore plugin, run cmake with -DPLUGIN_MEMCACHEDSESSIONSTORE:BOOL=OFF.

Logging category: cutelyst.plugin.memcachedsessionstore
Logging with Cutelyst

Since: Cutelyst 1.11.0

Definition at line 77 of file memcachedsessionstore.h.

Constructor & Destructor Documentation

◆ MemcachedSessionStore()

MemcachedSessionStore::MemcachedSessionStore	(	Cutelyst::Application *	app,
		QObject *	parent = `nullptr`
	)

Constructs a new MemcachedSessionStore object with the given parent and app. The pointer to the Application object is used to load the plugin configuration from the configuration file section Cutelyst_MemcachedSessionStore_Plugin.

Definition at line 26 of file memcachedsessionstore.cpp.

References Cutelyst::Engine::config(), and Cutelyst::Application::engine().

◆ ~MemcachedSessionStore()

MemcachedSessionStore::~MemcachedSessionStore ( )

overridedefault

Deconstructs the MemcachedSessionStore object

Member Function Documentation

◆ deleteExpiredSessions()

bool MemcachedSessionStore::deleteExpiredSessions	(	Context *	c,
		quint64	expires
	)

overridevirtual

Removes all expired sessions which are above expires.

Implements Cutelyst::SessionStore.

Definition at line 77 of file memcachedsessionstore.cpp.

◆ deleteSessionData()

bool MemcachedSessionStore::deleteSessionData	(	Context *	c,
		const QByteArray &	sid,
		const QString &	key
	)

overridevirtual

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

Implements Cutelyst::SessionStore.

Definition at line 66 of file memcachedsessionstore.cpp.

References Cutelyst::Context::setStash().

◆ getSessionData()

QVariant MemcachedSessionStore::getSessionData	(	Context *	c,
		const QByteArray &	sid,
		const QString &	key,
		const QVariant &	defaultValue
	)

overridevirtual

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

Implements Cutelyst::SessionStore.

Definition at line 40 of file memcachedsessionstore.cpp.

References QVariant::value().

◆ setGroupKey()

void MemcachedSessionStore::setGroupKey ( const QByteArray & groupKey )

Sets the groupKey to define the servers to store the sessions on. This can also be set in the configuration file.

Definition at line 85 of file memcachedsessionstore.cpp.

◆ storeSessionData()

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

overridevirtual

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

Implements Cutelyst::SessionStore.

Definition at line 52 of file memcachedsessionstore.cpp.

References Cutelyst::Context::setStash().

Public Member Functions

Additional Inherited Members

Detailed Description

Configuration

Configuration example

Usage example

Build requirements

Constructor & Destructor Documentation

◆ MemcachedSessionStore()

◆ ~MemcachedSessionStore()

Member Function Documentation

◆ deleteExpiredSessions()

◆ deleteSessionData()

◆ getSessionData()

◆ setGroupKey()

◆ storeSessionData()