listSharedObjects: List all shared Objects

In Jiefei-Wang/SharedObject: Sharing R objects across multiple R processes without memory duplication

List all shared Objects

Description

List all shared Objects

Usage

listSharedObjects(end = NULL, start = NULL)

Arguments

end	the end value of the ID. The default is NULL. See details.
start	the start value of the ID. The default is NULL. See details.

Details

The parameter start and end specify the range of the ID. If not specified, all IDs will be listed.

On Ubuntu or some other linux systems, the shared objects can be found in the folder ⁠/dev/shm⁠. The function can find all shared objects if the folder exists.

On Windows, since there is no easy way to find all shared objects. the function will guess the range of the shared object IDs and search for all IDs within the range. Therefore, if there are too many shared objects(over 4 billions) ,the object id can be out of the searching range and the result may not be complete. Furthermore, there will be no named shared memory in the returned list.

Note that the size in the return value is the true memory size that is reserved for the shared object, so it might be larger than the object size.

Value

A data.frame object with shared object id and size

See Also

getLastIndex, allocateSharedMemory, mapSharedMemory, unmapSharedMemory, freeSharedMemory, hasSharedMemory, getSharedMemorySize

Examples

x <- share(runif(10))
## Automatically determine the search range
listSharedObjects()

## specify the search range
listSharedObjects(start = 10, end = 20)

## Search from 0 to 20
listSharedObjects(20)

Jiefei-Wang/SharedObject documentation built on Aug. 19, 2023, 5:47 p.m.