Cutelyst  2.3.0
Public Member Functions | List of all members
Cutelyst::MemcachedSessionStore Class Reference

Memcached based session store. More...

#include <memcachedsessionstore.h>

Inheritance diagram for Cutelyst::MemcachedSessionStore:
Inheritance graph
[legend]

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:

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

◆ ~MemcachedSessionStore()

MemcachedSessionStore::~MemcachedSessionStore ( )

Deconstructs the MemcachedSessionStore object

Definition at line 47 of file memcachedsessionstore.cpp.

Member Function Documentation

◆ deleteExpiredSessions()

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

Removes all expired sessions which are above expires.

Implements Cutelyst::SessionStore.

Definition at line 83 of file memcachedsessionstore.cpp.

◆ deleteSessionData()

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

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

Implements Cutelyst::SessionStore.

Definition at line 72 of file memcachedsessionstore.cpp.

References Cutelyst::Context::setStash().

◆ getSessionData()

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

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

◆ setGroupKey()

void MemcachedSessionStore::setGroupKey ( const QString &  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 91 of file memcachedsessionstore.cpp.

References Cutelyst::Application::afterDispatch(), Cutelyst::Context::app(), Cutelyst::Memcached::remove(), Cutelyst::Memcached::removeByKey(), Cutelyst::Memcached::set(), Cutelyst::Memcached::setByKey(), and Cutelyst::Context::stash().

◆ storeSessionData()

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

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

Implements Cutelyst::SessionStore.

Definition at line 61 of file memcachedsessionstore.cpp.

References Cutelyst::Context::setStash().