memshare (version 1.1.0)

memshare_gc: Function to remove all handles (ownership and viewership) for a namespace in a worker context.

Description

Given a namespace identifier (identifies the shared memory space to register to), this function removes all handles to shared memory held by the master and a worker context.

Usage

memshare_gc(namespace, cluster)

Value

No return value, called deallocation of memory pages and views in a joint memory context.

Arguments

namespace

string of the identifier of the shared memory context.

cluster

A worker context (parallel cluster) that holds views or pages in the same memory context as the master. NULL by default; then only the master session gets its handles removed.

Author

Julian Maerte

See Also

releaseVariables, releaseViews

Examples

  cluster = parallel::makeCluster(1)
  
  mat = matrix(0,5,5)
  registerVariables("ns", list(mat=mat))
  
  parallel::clusterEvalQ(cluster, {
    view = memshare::retrieveViews("ns", c("mat"))
  })
  if (FALSE) {
  # At this point each worker holds a view of mat
  }
  memshare_gc("ns", cluster)
  if (FALSE) {
  # Every workers viewership handle gets destroyed, master sessions page handle
  # gets destroyed.
  # As no handles are left open, the memory is free'd.
  }
  parallel::stopCluster(cluster)