#include <memcachedsessionstore.h>

Inheritance diagram for Cutelyst::MemcachedSessionStore:

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

	~MemcachedSessionStore ()

virtual bool	deleteExpiredSessions (Context *c, quint64 expires) final

virtual bool	deleteSessionData (Context *c, const QString &sid, const QString &key) final

virtual QVariant	getSessionData (Context *c, const QString &sid, const QString &key, const QVariant &defaultValue) final

void	setGroupKey (const QString &groupKey)

virtual bool	storeSessionData (Context *c, const QString &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 QObjectList &	children () const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const

bool	disconnect (const QObject receiver, const char method) const

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const

bool	inherits (const char *className) const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const

bool	isWindowType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

QString	objectName () const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const

QVariant	property (const char *name) const

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval, Qt::TimerType timerType)

QThread *	thread () 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 receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

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, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

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

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () 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. It obsoletes the SessionStoreMemcached class.

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 cutelyst configuration file in the Cutelyst_MemcachedSessionStore_Plugin section.

Currently there are the following configuration options:

group_key - string value, defines a group key to store the data on a specific server (default: empty)

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.

Since: Cutelyst 1.11.0

Definition at line 81 of file memcachedsessionstore.h.

Constructor & Destructor Documentation

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 38 of file memcachedsessionstore.cpp.

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

MemcachedSessionStore::~MemcachedSessionStore ( )

Deconstructs the MemcachedSessionStore object

Definition at line 47 of file memcachedsessionstore.cpp.