session.hpp

Go to the documentation of this file.

#pragma once
 
#include <utility>  // move
 
#include "open62541pp/types.hpp"
 
namespace opcua {
 
class Server;
 
/**
 * High-level session class to manage client sessions.
 *
 * Sessions are identified by a server-assigned session id (of type NodeId).
 * A session carries attributes in a key-value list. Custom attributes/meta-data can be attached to
 * a session as key-value pairs of QualifiedName and Variant.
 *
 * @see https://reference.opcfoundation.org/Core/Part4/v105/docs/5.7
 */
class Session {
public:
    Session(Server& connection, NodeId sessionId, void* sessionContext) noexcept
        : connection_(&connection),
          id_(std::move(sessionId)),
          context_(sessionContext) {}
 
    /// Get the server instance.
    Server& connection() noexcept {
        return *connection_;
    }
 
    /// Get the server instance.
    const Server& connection() const noexcept {
        return *connection_;
    }
 
    /// Get the session identifier.
    const NodeId& id() const noexcept {
        return id_;
    }
 
    /// Get the session context.
    void* context() noexcept {
        return context_;
    }
 
    /// Get the session context.
    const void* context() const noexcept {
        return context_;
    }
 
    /// Get a session attribute by its key.
    /// @note Supported since open62541 v1.3
    Variant getSessionAttribute(const QualifiedName& key);
 
    /// Attach a session attribute as a key-value pair.
    /// @note Supported since open62541 v1.3
    void setSessionAttribute(const QualifiedName& key, const Variant& value);
 
    /// Delete a session attribute by its key.
    /// @note Supported since open62541 v1.3
    void deleteSessionAttribute(const QualifiedName& key);
 
    /// Manually close this session.
    /// @note Supported since open62541 v1.3
    void close();
 
private:
    Server* connection_;
    NodeId id_;
    void* context_;
};
 
/// @relates Session
bool operator==(const Session& lhs, const Session& rhs) noexcept;
 
/// @relates Session
bool operator!=(const Session& lhs, const Session& rhs) noexcept;
 
}  // namespace opcua