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

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::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().