Index (junixsocket-memory 2.11.0 API)

A B C D G I M O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values

A

addSeals(Set) - Method in class org.newsclub.net.unix.memory.SharedMemory: Adds the given MemorySeals, preventing certain operations on shared memory.
anonymousCopyOnWriteSegment(Arena, long) - Static method in class org.newsclub.net.unix.memory.MappedMemory: Returns an anonymous copy-on-write (changes are local to the process running this JVM) memory segment of the given length.
anonymousReadOnlySegment(Arena, long) - Static method in class org.newsclub.net.unix.memory.MappedMemory: Returns an anonymous read-only memory segment of the given length.
anonymousSegment(Arena, long) - Static method in class org.newsclub.net.unix.memory.MappedMemory: Returns an anonymous read/write memory segment of the given length.
asMappedMemorySegment(FileChannel.MapMode) - Method in class org.newsclub.net.unix.memory.SharedMemory: Return a MemorySegment instance corresponding to this shared memory object, using the given FileChannel.MapMode, and a custom shared Arena that will be closed upon SharedMemory.close().
asMappedMemorySegment(FileChannel.MapMode, Arena) - Method in class org.newsclub.net.unix.memory.SharedMemory: Return a MemorySegment instance corresponding to this shared memory object, using the given FileChannel.MapMode, and the given arena.
asMappedMemorySegment(FileChannel.MapMode, Arena, int) - Method in class org.newsclub.net.unix.memory.SharedMemory: Return a MemorySegment instance corresponding to this shared memory object -- repeated multiple times after each other (aligned with page size) -- using the given FileChannel.MapMode, and the given arena, as well as the duplication count.
asMappedMemorySegment(FileChannel.MapMode, Arena, long, long, int) - Method in class org.newsclub.net.unix.memory.SharedMemory: Return a MemorySegment instance corresponding to a range of this shared memory object -- repeated multiple times after each other (aligned with page size) -- using the given FileChannel.MapMode, and the given arena, as well as the duplication count.

B

byteSize() - Method in class org.newsclub.net.unix.memory.SharedMemory: Returns the aligned size of this shared memory instance.

C

close() - Method in class org.newsclub.net.unix.memory.MappedMemory
close() - Method in class org.newsclub.net.unix.memory.SharedMemory: Closes this SharedMemory resource, potentially unlinking the corresponding underlying resource from the kernel if the object has been instantiated with SharedMemoryOption.UNLINK_UPON_CLOSE.
createAnonymous(long) - Static method in class org.newsclub.net.unix.memory.SharedMemory: Creates a new SharedMemory instance using an anonymous identifier.
createAnonymous(long, SharedMemoryOption...) - Static method in class org.newsclub.net.unix.memory.SharedMemory: Creates a new SharedMemory instance using an anonymous identifier.
createExclusively(String, long, Set, SharedMemoryOption...) - Static method in class org.newsclub.net.unix.memory.SharedMemory: Creates a new SharedMemory instance under the given name.
createExclusively(String, long, SharedMemoryOption...) - Static method in class org.newsclub.net.unix.memory.SharedMemory: Creates a new SharedMemory instance under the given name, using default permissions (read-write for all users, where applicable).
createOrOpenExisting(String, long, Set, SharedMemoryOption...) - Static method in class org.newsclub.net.unix.memory.SharedMemory: Creates a new SharedMemory instance under the given namex.
createOrOpenExisting(String, long, SharedMemoryOption...) - Static method in class org.newsclub.net.unix.memory.SharedMemory: Creates a new SharedMemory instance under the given name, using default permissions (read-write for all users, where applicable).
createOrReuseExisting(String, long, Set, SharedMemoryOption...) - Static method in class org.newsclub.net.unix.memory.SharedMemory: Creates a new SharedMemory instance under the given name.
createOrReuseExisting(String, long, SharedMemoryOption...) - Static method in class org.newsclub.net.unix.memory.SharedMemory: Creates a new SharedMemory instance under the given name, using default permissions (read-write for all users, where applicable).

D

defaultAllocationSize() - Static method in class org.newsclub.net.unix.memory.MappedMemory: Returns the system's default memory page allocation size for shared memory.
defaultAllocationSize() - Static method in class org.newsclub.net.unix.memory.SharedMemory: Returns the system's default memory page allocation size for shared memory.

G

getFileDescriptor() - Method in class org.newsclub.net.unix.memory.SharedMemory: Returns the file descriptor associated with this instance.
getMemorySegment() - Method in class org.newsclub.net.unix.memory.MappedMemory: Returns the MemorySegment backed by this instance.
getMinimumSubAllocationSize() - Method in class org.newsclub.net.unix.memory.MappedMemory: Returns the minimum sub-allocation size.
getOpt() - Method in enum class org.newsclub.net.unix.memory.SharedMemoryOption: An value only used by junixsocket internals; do not use.
getSeals() - Method in class org.newsclub.net.unix.memory.SharedMemory: Returns the current MemorySeals for this shared memory instance.

I

init(MemoryImplUtilInternal) - Static method in class org.newsclub.net.unix.memory.SharedMemory: Internal initializer used by junixsocket-common; do not use.
isInterProcess() - Method in interface org.newsclub.net.unix.memory.SharedMutex: Reports if this lock instance can safely be accessed from multiple processes, or not.
isReentrant() - Method in interface org.newsclub.net.unix.memory.SharedMutex: Reports if this lock instance is re-entrant, or not.

M

MappedMemory - Class in org.newsclub.net.unix.memory: Some mapped memory.
mapRegion(long, long, FileDescriptor, long) - Method in class org.newsclub.net.unix.memory.MappedMemory: Maps some memory to a region of this MappedMemory object.
MemorySeal - Enum Class in org.newsclub.net.unix.memory: Specific "memory seal" operations.
mutex(MemorySegment) - Method in class org.newsclub.net.unix.memory.SharedMemory: Returns a SharedMutex instance working with the given MemorySegment, which has to be exactly SharedMemory.MUTEX_SEGMENT_SIZE bytes long.
MUTEX_SEGMENT_SIZE - Static variable in class org.newsclub.net.unix.memory.SharedMemory: The exact size (in bytes) required for a MemorySegment used in SharedMemory.mutex(MemorySegment).

O

openExisting(String, SharedMemoryOption...) - Static method in class org.newsclub.net.unix.memory.SharedMemory: Creates a new SharedMemory instance under the given name, using the object under the given name.
org.newsclub.net.unix.memory - module org.newsclub.net.unix.memory: The junixsocket implementation for memory-related operations
org.newsclub.net.unix.memory - package org.newsclub.net.unix.memory

P

placeholderSegment(Arena, long) - Static method in class org.newsclub.net.unix.memory.MappedMemory: Returns an anonymous memory segment of the given length that acts as a placeholder for later, memory-mapped segments in this area.
PREVENT_FUTURE_WRITE - Enum constant in enum class org.newsclub.net.unix.memory.MemorySeal: Prevents writing to the memory area in question, except for shared writable mappings that were created prior to the seal being set.
PREVENT_GROW - Enum constant in enum class org.newsclub.net.unix.memory.MemorySeal: Prevents growing the memory area in question.
PREVENT_SEAL - Enum constant in enum class org.newsclub.net.unix.memory.MemorySeal: Prevents any further modifications to the set of seals.
PREVENT_SHRINK - Enum constant in enum class org.newsclub.net.unix.memory.MemorySeal: Prevents shrinking the memory area in question.
PREVENT_WRITE - Enum constant in enum class org.newsclub.net.unix.memory.MemorySeal: Prevents writing to the memory area in question.

R

READ_ONLY - Enum constant in enum class org.newsclub.net.unix.memory.SharedMemoryOption: Open for reading only (instead of read-write).

S

SEALABLE - Enum constant in enum class org.newsclub.net.unix.memory.SharedMemoryOption: Allow sealing operations (only supported on Linux).
SECRET - Enum constant in enum class org.newsclub.net.unix.memory.SharedMemoryOption: Require a more "secret" memory area.
SharedMemory - Class in org.newsclub.net.unix.memory: Some shared memory.
SharedMemoryOption - Enum Class in org.newsclub.net.unix.memory: Options for SharedMemorys.
SharedMutex - Interface in org.newsclub.net.unix.memory: A mutually exclusive lock, which may or may not be reentrant.

T

tryLock(int) - Method in interface org.newsclub.net.unix.memory.SharedMutex: Try to lock the mutex.

U

UNLINK_UPON_CLOSE - Enum constant in enum class org.newsclub.net.unix.memory.SharedMemoryOption: Unlink the object upon calling SharedMemory.close().
unlinkShared(String) - Static method in class org.newsclub.net.unix.memory.SharedMemory: Asks to explicitly unlink/remove a shared memory object identified by the given name.
unlock() - Method in interface org.newsclub.net.unix.memory.SharedMutex: Unlocks the mutex.
using(FileDescriptor) - Static method in class org.newsclub.net.unix.memory.SharedMemory: Creates a new SharedMemory instance using the given file descriptor, which can be associated with a regular file that is to be memory-mapped, or a shared memory region.

V

valueOf(String) - Static method in enum class org.newsclub.net.unix.memory.MemorySeal: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.newsclub.net.unix.memory.SharedMemoryOption: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.newsclub.net.unix.memory.MemorySeal: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.newsclub.net.unix.memory.SharedMemoryOption: Returns an array containing the constants of this enum class, in the order they are declared.

A B C D G I M O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values