Skip to content
v1.11dev
GitHub

API · fair::mq::shmem

Monitorclass

#include <Monitor.h>fairmq/shmem/Monitor.h:61GitHub ↗

No comment in the header yet.

Nested types

Functions

Monitor

Monitor.h:64
Monitor(
    std::string shmId,
    bool selfDestruct,
    bool interactive,
    bool viewOnly,
    unsigned int timeoutInMS,
    unsigned int intervalInMS,
    bool runAsDaemon,
    bool cleanOnExit
)

No comment in the header yet.

Static functions

Cleanup

staticMonitor.h:78
static std::vector<std::pair<std::string, bool>> Cleanup(
    const ShmId& shmId,
    bool verbose = true
)

Cleanup all shared memory artifacts created by devices.

shmId
shared memory id
verbose
output cleanup results to stdout

Cleanup

staticMonitor.h:82
static std::vector<std::pair<std::string, bool>> Cleanup(
    const SessionId& sessionId,
    bool verbose = true
)

Cleanup all shared memory artifacts created by devices.

sessionId
session id
verbose
output cleanup results to stdout

CleanupFull

staticMonitor.h:86
static std::vector<std::pair<std::string, bool>> CleanupFull(
    const ShmId& shmId,
    bool verbose = true
)

Cleanup all shared memory artifacts created by devices and monitors.

shmId
shared memory id
verbose
output cleanup results to stdout

CleanupFull

staticMonitor.h:90
static std::vector<std::pair<std::string, bool>> CleanupFull(
    const SessionId& sessionId,
    bool verbose = true
)

Cleanup all shared memory artifacts created by devices and monitors.

sessionId
session id
verbose
output cleanup results to stdout

ResetContent

staticMonitor.h:95
static void ResetContent(const ShmId& shmId, bool verbose = true)

[EXPERIMENTAL] cleanup the content of the shem segment, without recreating it

shmId
shared memory id Only call this when segment is not in use

ResetContent

staticMonitor.h:99
static void ResetContent(const SessionId& sessionId, bool verbose = true)

[EXPERIMENTAL] cleanup the content of the shem segment, without recreating it

sessionId
session id Only call this when segment is not in use

ResetContent

staticMonitor.h:103
static void ResetContent(
    const ShmId& shmId,
    const std::vector<SegmentConfig>& segmentCfgs,
    const std::vector<RegionConfig>& regionCfgs,
    bool verbose = true
)

[EXPERIMENTAL] cleanup the content of the shem segment, without recreating it

shmId
shared memory id Only call this when segment is not in use

ResetContent

staticMonitor.h:107
static void ResetContent(
    const SessionId& sessionId,
    const std::vector<SegmentConfig>& segmentCfgs,
    const std::vector<RegionConfig>& regionCfgs,
    bool verbose = true
)

[EXPERIMENTAL] cleanup the content of the shem segment, without recreating it

sessionId
session id Only call this when segment is not in use

PrintDebugInfo

staticMonitor.h:111
static void PrintDebugInfo(const ShmId& shmId)

Outputs list of messages in shmem (if compiled with FAIRMQ_DEBUG_MODE=ON)

shmId
shmem id

GetFreeMemory

staticMonitor.h:125
static unsigned long GetFreeMemory(const ShmId& shmId, uint16_t segmentId)

Returns the amount of free memory in the specified segment.

shmId
shmem id
segmentId
segment id
MonitorError throws

GetFreeMemory

staticMonitor.h:130
static unsigned long GetFreeMemory(
    const SessionId& sessionId,
    uint16_t segmentId
)

Returns the amount of free memory in the specified segment.

sessionId
session id
segmentId
segment id
MonitorError throws

SegmentIsPresent

staticMonitor.h:134
static bool SegmentIsPresent(const ShmId& shmId, uint16_t segmentId)

Checks if a given segment can be opened.

shmId
shmem id
segmentId
segment id

RegionIsPresent

staticMonitor.h:142
static bool RegionIsPresent(const ShmId& shmId, uint16_t regionId)

Checks if a given region can be opened.

shmId
shmem id
regionId
region id