This is an automated email from the ASF dual-hosted git repository.
leerho pushed a commit to branch frank_grimes_java-21-ffm
in repository https://gitbox.apache.org/repos/asf/datasketches-memory.git
The following commit(s) were added to refs/heads/frank_grimes_java-21-ffm by
this push:
new fa95669 change not supported to not recommended.
fa95669 is described below
commit fa9566988882e828e5d591738c047517455d9790
Author: Lee Rhodes <[email protected]>
AuthorDate: Mon Nov 25 09:58:44 2024 -0800
change not supported to not recommended.
---
src/main/java/org/apache/datasketches/memory/Memory.java | 4 ++--
.../java/org/apache/datasketches/memory/MemoryRequestServer.java | 2 +-
src/main/java/org/apache/datasketches/memory/WritableMemory.java | 6 +++---
.../java/org/apache/datasketches/memory/internal/ResourceImpl.java | 2 +-
.../apache/datasketches/memory/internal/WritableMemoryImpl.java | 7 +++----
5 files changed, 10 insertions(+), 11 deletions(-)
diff --git a/src/main/java/org/apache/datasketches/memory/Memory.java
b/src/main/java/org/apache/datasketches/memory/Memory.java
index d19e21a..10ffbb7 100644
--- a/src/main/java/org/apache/datasketches/memory/Memory.java
+++ b/src/main/java/org/apache/datasketches/memory/Memory.java
@@ -77,7 +77,7 @@ public interface Memory extends Resource {
* map(file, 0, file.length(), scope, ByteOrder.nativeOrder())}.
* @param file the given file to map. It must be non-null with a
non-negative length and readable.
* @param arena the given arena. It must be non-null.
- * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not supported.
+ * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not recommended.
* @return <i>Memory</i> for managing the mapped memory.
* @throws IllegalArgumentException if path is not associated with the
default file system.
* @throws IllegalStateException if scope has been already closed, or if
access occurs from a thread other than the thread owning scope.
@@ -96,7 +96,7 @@ public interface Memory extends Resource {
* @param capacityBytes the size of the mapped memory. It must not be
negative..
* @param byteOrder the byte order to be used. It must be non-null.
* @param arena the given arena. It must be non-null.
- * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not supported.
+ * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not recommended.
* @return <i>Memory</i> for managing the mapped memory.
* @throws IllegalArgumentException if path is not associated with the
default file system.
* @throws IllegalStateException if scope has been already closed, or if
access occurs from a thread other than the thread owning scope.
diff --git
a/src/main/java/org/apache/datasketches/memory/MemoryRequestServer.java
b/src/main/java/org/apache/datasketches/memory/MemoryRequestServer.java
index 7c9fc67..8a0453a 100644
--- a/src/main/java/org/apache/datasketches/memory/MemoryRequestServer.java
+++ b/src/main/java/org/apache/datasketches/memory/MemoryRequestServer.java
@@ -52,7 +52,7 @@ public interface MemoryRequestServer {
* @param currentWritableMemory the current writableMemory of the client. It
must be non-null.
* @param newCapacityBytes The capacity being requested. It must be > the
capacity of the currentWritableMemory.
* @param arena the Arena to be used for the newly allocated memory. It must
be non-null.
- * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not supported.
+ * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not recommended.
* @return new WritableMemory with the requested capacity.
*/
WritableMemory request(
diff --git a/src/main/java/org/apache/datasketches/memory/WritableMemory.java
b/src/main/java/org/apache/datasketches/memory/WritableMemory.java
index 9d49220..2a764d0 100644
--- a/src/main/java/org/apache/datasketches/memory/WritableMemory.java
+++ b/src/main/java/org/apache/datasketches/memory/WritableMemory.java
@@ -113,7 +113,7 @@ public interface WritableMemory extends Memory {
* @param capacityBytes the size of the mapped Memory.
* @param byteOrder the given <i>ByteOrder</i>. It must be non-null.
* @param arena the given arena to map. It must be non-null.
- * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not supported.
+ * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not recommended.
* @return a file-mapped WritableMemory.
* @throws IllegalArgumentException if file is not readable or not writable.
* @throws IOException if the specified path does not point to an existing
file, or if some other I/O error occurs.
@@ -141,7 +141,7 @@ public interface WritableMemory extends Memory {
* and to call <i>close()</i> when done.</p>
* @param capacityBytes the size of the desired memory in bytes.
* @param arena the given arena to map. It must be non-null.
- * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not supported.
+ * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not recommended.
*
* @return WritableMemory for this off-heap, native resource.
*/
@@ -162,7 +162,7 @@ public interface WritableMemory extends Memory {
* @param memReqSvr A user-specified MemoryRequestServer, which may be null.
* This is a callback mechanism for a user client of direct memory to
request more memory.
* @param arena the given arena to map. It must be non-null.
- * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not supported.
+ * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not recommended.
*
* @return a WritableMemory for this off-heap resource.
*/
diff --git
a/src/main/java/org/apache/datasketches/memory/internal/ResourceImpl.java
b/src/main/java/org/apache/datasketches/memory/internal/ResourceImpl.java
index 957a444..796f0d4 100644
--- a/src/main/java/org/apache/datasketches/memory/internal/ResourceImpl.java
+++ b/src/main/java/org/apache/datasketches/memory/internal/ResourceImpl.java
@@ -110,7 +110,7 @@ abstract class ResourceImpl implements Resource {
* @param typeId the given typeId
* @param memReqSvr the given MemoryRequestServer, or null.
* @param arena the given Arena, or null if an on-heap MemorySegment.
- * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not supported.
+ * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not recommended.
*/
ResourceImpl(final MemorySegment seg, final int typeId, final
MemoryRequestServer memReqSvr, final Arena arena) {
this.seg = seg;
diff --git
a/src/main/java/org/apache/datasketches/memory/internal/WritableMemoryImpl.java
b/src/main/java/org/apache/datasketches/memory/internal/WritableMemoryImpl.java
index aa06b2b..6c008db 100644
---
a/src/main/java/org/apache/datasketches/memory/internal/WritableMemoryImpl.java
+++
b/src/main/java/org/apache/datasketches/memory/internal/WritableMemoryImpl.java
@@ -141,11 +141,11 @@ public abstract class WritableMemoryImpl extends
ResourceImpl implements Writabl
* @param capacityBytes the capacity of the mapped memory. It must be ≥ 0.
* It must be non-null.
* Typically use <i>Arena.ofConfined()</i>.
- * Warning: specifying a <i>Arena.ofShared()</i> is not supported.
+ * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not recommended.
* @param byteOrder the given <i>ByteOrder</i>. It must be non-null.
* @param localReadOnly true if read-only is being imposed locally, even if
the given file is writable..
* @param arena the given arena. It must be non-null.
- * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not supported.
+ * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not recommended.
* @return a <i>WritableMemory</i>
* @throws IllegalArgumentException if file is not readable.
* @throws IOException if mapping is not successful.
@@ -197,12 +197,11 @@ public abstract class WritableMemoryImpl extends
ResourceImpl implements Writabl
* The static constructor that chooses the correct Direct leaf node based on
the byte order.
* @param capacityBytes the requested capacity for the Direct (off-heap)
memory. It must be ≥ 0.
* @param alignmentBytes requested segment alignment. Typically 1, 2, 4 or 8.
- * Warning: specifying a <i>Arena.ofShared()</i> is not supported.
* @param byteOrder the byte order to be used. It must be non-null.
* @param memReqSvr A user-specified MemoryRequestServer, which may be null.
* This is a callback mechanism for a user client of direct memory to
request more memory.
* @param arena the given arena. It must be non-null.
- * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not supported.
+ * Warning: This class is not thread-safe. Specifying an Arena that allows
multiple threads is not recommended.
* @return WritableMemory
*/
public static WritableMemory wrapDirect(
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
