buffer_open: Open an Existing Buffer

View source: R/buffer.R

buffer_openR Documentation

Open an Existing Buffer

Description

Opens a shared memory buffer that was created in another process. Used by workers to attach to the parent's output buffer.

Usage

buffer_open(path, type, dim, backing = c("mmap", "shm"), readonly = FALSE)

Arguments

path

Path or shm name of the buffer's segment.

type

Character. Data type of the buffer.

dim

Integer vector. Dimensions of the buffer.

backing

Backing type: "mmap" or "shm".

readonly

Logical. Open as read-only? Default FALSE for workers.

Value

A shard_buffer object attached to the existing segment.

Examples


buf <- buffer("double", dim = 10)
path <- buffer_path(buf)
buf2 <- buffer_open(path, type = "double", dim = 10, backing = "mmap")
buffer_close(buf2, unlink = FALSE)
buffer_close(buf)


shard documentation built on April 3, 2026, 9:08 a.m.