Catalog_Namespace::SessionsStore Class Reference

#include <SessionsStore.h>

Inheritance diagram for Catalog_Namespace::SessionsStore:

Public Member Functions
virtual SessionInfoPtr	add (const Catalog_Namespace::UserMetadata &user_meta, std::shared_ptr< Catalog > cat, ExecutorDeviceType device)=0
virtual SessionInfoPtr	get (const std::string &session_id)=0
void	erase (const std::string &session_id)
void	eraseByUser (const std::string &user_name)
void	eraseByDB (const std::string &db_name)
std::vector< SessionInfoPtr >	getAllSessions ()
std::vector< SessionInfoPtr >	getUserSessions (const std::string &user_name)
SessionInfoPtr	getByPublicID (const std::string &public_id)
virtual	~SessionsStore ()=default
SessionInfo	getSessionCopy (const std::string &session_id)
void	disconnect (const std::string session_id)

Static Public Member Functions
static std::unique_ptr < SessionsStore >	create (const std::string &base_path, size_t n_workers, int idle_session_duration, int max_session_duration, int capacity, DisconnectCallback disconnect_callback)

Protected Member Functions
bool	isSessionExpired (const SessionInfoPtr &session_ptr, int idle_session_duration, int max_session_duration)
virtual bool	isSessionInUse (const SessionInfoPtr &session_ptr)=0
virtual SessionInfoPtr	getUnlocked (const std::string &session_id)=0
virtual void	eraseUnlocked (const std::string &session_id)=0
virtual DisconnectCallback	getDisconnectCallback ()=0
virtual std::vector < SessionInfoPtr >	getIf (std::function< bool(const SessionInfoPtr &)> predicate)=0
virtual void	eraseIf (std::function< bool(const SessionInfoPtr &)> predicate)=0
virtual heavyai::shared_mutex &	getLock ()=0

Detailed Description

Definition at line 31 of file SessionsStore.h.

Constructor & Destructor Documentation

virtual Catalog_Namespace::SessionsStore::~SessionsStore ( )

virtualdefault

Member Function Documentation

virtual SessionInfoPtr Catalog_Namespace::SessionsStore::add ( const Catalog_Namespace::UserMetadata &  user_meta, std::shared_ptr< Catalog >  cat, ExecutorDeviceType  device  )

pure virtual

Implemented in CachedSessionStore.

std::unique_ptr< SessionsStore > SessionsStore::create ( const std::string &  base_path, size_t  n_workers, int  idle_session_duration, int  max_session_duration, int  capacity, DisconnectCallback  disconnect_callback  )

static

Definition at line 241 of file SessionsStore.cpp.

Referenced by DBHandler::resetSessionsStore().

                                            {
  return std::make_unique<CachedSessionStore>(
      idle_session_duration, max_session_duration, capacity, disconnect_callback);
}

Here is the caller graph for this function:

void SessionsStore::disconnect

(

const std::string

session_id

)

Definition at line 54 of file SessionsStore.cpp.

References eraseUnlocked(), getDisconnectCallback(), getLock(), getUnlocked(), logger::INFO, and LOG.

                                                         {
  heavyai::lock_guard<heavyai::shared_mutex> lock(getLock());
  auto session_ptr = getUnlocked(session_id);
  if (session_ptr) {
    const auto dbname = session_ptr->getCatalog().getCurrentDB().dbName;
    LOG(INFO) << "User " << session_ptr->get_currentUser().userLoggable()
              << " disconnected from database " << dbname
              << " with public_session_id: " << session_ptr->get_public_session_id();
    getDisconnectCallback()(session_ptr);
    eraseUnlocked(session_ptr->get_session_id());
  }
}

Here is the call graph for this function:

void SessionsStore::erase

(

const std::string &

session_id

)

Definition at line 37 of file SessionsStore.cpp.

References eraseUnlocked(), and getLock().

                                                     {
  heavyai::lock_guard<heavyai::shared_mutex> lock(getLock());
  eraseUnlocked(session_id);
}

Here is the call graph for this function:

void SessionsStore::eraseByDB

(

const std::string &

db_name

)

Definition at line 48 of file SessionsStore.cpp.

References eraseIf().

                                                      {
  eraseIf([&db_name](const SessionInfoPtr& session_ptr) {
    return boost::iequals(db_name, session_ptr->getCatalog().getCurrentDB().dbName);
  });
}

Here is the call graph for this function:

void SessionsStore::eraseByUser

(

const std::string &

user_name

)

Definition at line 42 of file SessionsStore.cpp.

References eraseIf().

                                                          {
  eraseIf([&user_name](const SessionInfoPtr& session_ptr) {
    return boost::iequals(user_name, session_ptr->get_currentUser().userName);
  });
}

Here is the call graph for this function:

virtual void Catalog_Namespace::SessionsStore::eraseIf ( std::function< bool(const SessionInfoPtr &)>  predicate )

protectedpure virtual

Implemented in CachedSessionStore.

Referenced by eraseByDB(), and eraseByUser().

Here is the caller graph for this function:

virtual void Catalog_Namespace::SessionsStore::eraseUnlocked ( const std::string &  session_id )

protectedpure virtual

Implemented in CachedSessionStore.

Referenced by disconnect(), and erase().

Here is the caller graph for this function:

virtual SessionInfoPtr Catalog_Namespace::SessionsStore::get ( const std::string &  session_id )

pure virtual

Implemented in CachedSessionStore.

std::vector< SessionInfoPtr > SessionsStore::getAllSessions

(

)

Definition at line 93 of file SessionsStore.cpp.

References getIf().

                                                        {
  return getIf([](const SessionInfoPtr&) { return true; });
}

Here is the call graph for this function:

SessionInfoPtr SessionsStore::getByPublicID

(

const std::string &

public_id

)

Definition at line 103 of file SessionsStore.cpp.

References CHECK_EQ, and getIf().

                                                                      {
  auto sessions = getIf([&public_id](const SessionInfoPtr& session_ptr) {
    return session_ptr->get_public_session_id() == public_id;
  });
  if (sessions.empty()) {
    return nullptr;
  }
  CHECK_EQ(sessions.size(), 1ul);
  return sessions[0];
}

Here is the call graph for this function:

virtual DisconnectCallback Catalog_Namespace::SessionsStore::getDisconnectCallback ( )

protectedpure virtual

Implemented in CachedSessionStore.

Referenced by disconnect().

Here is the caller graph for this function:

virtual std::vector<SessionInfoPtr> Catalog_Namespace::SessionsStore::getIf ( std::function< bool(const SessionInfoPtr &)>  predicate )

protectedpure virtual

Implemented in CachedSessionStore.

Referenced by getAllSessions(), getByPublicID(), and getUserSessions().

Here is the caller graph for this function:

virtual heavyai::shared_mutex& Catalog_Namespace::SessionsStore::getLock ( )

protectedpure virtual

Implemented in CachedSessionStore.

Referenced by disconnect(), and erase().

Here is the caller graph for this function:

SessionInfo SessionsStore::getSessionCopy

(

const std::string &

session_id

)

Definition at line 28 of file SessionsStore.cpp.

                                                                     {
  auto origin = get(session_id);
  if (origin) {
    heavyai::shared_lock<heavyai::shared_mutex> lock(origin->getLock());
    return *origin;
  }
  throw std::runtime_error("No session with id " + session_id);
}

virtual SessionInfoPtr Catalog_Namespace::SessionsStore::getUnlocked ( const std::string &  session_id )

protectedpure virtual

Implemented in CachedSessionStore.

Referenced by disconnect().

Here is the caller graph for this function:

std::vector< SessionInfoPtr > SessionsStore::getUserSessions

(

const std::string &

user_name

)

Definition at line 97 of file SessionsStore.cpp.

References getIf().

                                                                                   {
  return getIf([&user_name](const SessionInfoPtr& session_ptr) {
    return session_ptr->get_currentUser().userName == user_name;
  });
}

Here is the call graph for this function:

bool SessionsStore::isSessionExpired ( const SessionInfoPtr &  session_ptr, int  idle_session_duration, int  max_session_duration  )

protected

Definition at line 67 of file SessionsStore.cpp.

References logger::INFO, isSessionInUse(), LOG, and run_benchmark_import::start_time.

Referenced by CachedSessionStore::get().

                                                               {
  if (isSessionInUse(session_ptr)) {
    return false;
  }
  time_t last_used_time = session_ptr->get_last_used_time();
  time_t start_time = session_ptr->get_start_time();
  const auto current_session_duration = time(0) - last_used_time;
  if (current_session_duration > idle_session_duration) {
    LOG(INFO) << "Session " << session_ptr->get_public_session_id() << " idle duration "
              << current_session_duration << " seconds exceeds maximum idle duration "
              << idle_session_duration << " seconds. Invalidating session.";
    return true;
  }
  const auto total_session_duration = time(0) - start_time;
  if (total_session_duration > max_session_duration) {
    LOG(INFO) << "Session " << session_ptr->get_public_session_id() << " total duration "
              << total_session_duration
              << " seconds exceeds maximum total session duration "
              << max_session_duration << " seconds. Invalidating session.";
    return true;
  }
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

virtual bool Catalog_Namespace::SessionsStore::isSessionInUse ( const SessionInfoPtr &  session_ptr )

protectedpure virtual

Implemented in CachedSessionStore.

Referenced by isSessionExpired().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• /home/jenkins-slave/workspace/core-os-doxygen/Catalog/SessionsStore.h
• /home/jenkins-slave/workspace/core-os-doxygen/Catalog/SessionsStore.cpp