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

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 )

explicit

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

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

Referenced by MemcachedSessionStore(), deleteSessionData(), getSessionData(), setGroupKey(), and storeSessionData().