listSharedObject {SharedObject} | R Documentation

## Get the shared object usage report

### Description

Get the shared object usage report. The size is the real memory size that a system allocates for the shared object, so it might be larger than the object size. The size unit is byte.

### Usage

    listSharedObject(end = NULL, start = NULL, includeCharId = FALSE)

### 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.
`includeCharId` | Whether including the shared objects named by a character ID, it only works on some linux systems. See details and `?allocateNamedSharedMemory` for more information. The default is `FALSE`.

### 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 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 object in the returned list.

### Value

A data.frame object with shared object id and size

### See Also

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

### Examples

    ## Automatically determine the search range
    listSharedObject()

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

    ## Search from 0 to 20
    listSharedObject(20)

[Package SharedObject version 1.4.0 Index]