| Type: | Package |
| Title: | A Shared Resource Interface for Bigmemory Project Packages |
| Version: | 0.1.8 |
| Description: | A shared resource interface for the bigmemory and synchronicity packages. |
| Encoding: | UTF-8 |
| Language: | en-US |
| License: | LGPL-3 | Apache License 2.0 |
| Enhances: | bigmemory |
| Imports: | methods |
| RoxygenNote: | 7.2.3 |
| NeedsCompilation: | no |
| Packaged: | 2024-01-10 16:31:18 UTC; mike |
| Author: | Michael J. Kane 
[aut, cre] |
| Maintainer: | Michael J. Kane <bigmemoryauthors@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2024-01-10 17:13:09 UTC |
Create an Object that Makes Use of a Shared Resource
Description
This generic function should be used to attach to a system-wide shared resource on a computer. It is used by other packages.
Usage
attach.resource(obj, ...)
Arguments
obj |
a descriptor object describing the location and type of a shared resource. |
... |
other information needed for object-specific attaching. |
Value
An R object that makes use of a share resource.
Examples
# Create a concrete function.
setMethod(
"attach.resource",
signature(obj = "NULL"),
function (obj, ...) {
NULL
}
)
# Describe it
attach.resource(NULL)
Create a Description of a Shared Resource
Description
This generic function should be used for creating a
description of a shared resource and is used in conjunction with
attach.resource() to utilize shared resources from an R session.
Usage
describe(x)
Arguments
x |
the object to create the descriptor for. |
Value
A user-defined description of a shared resource.
See Also
[bigmemory.sri::attach.resource()]
Examples
# Create a concrete function.
setMethod(
"describe",
signature(x = "list"),
function (x) {
print(x$value)
}
)
# Create an object to describe.
tst = list(loc = "in_ram_not_shared", value = "hello world")
# Describe it
describe(tst)