jnr.ffi.Memory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cassandra-driver Show documentation
Show all versions of cassandra-driver Show documentation
Shaded version of DataStax Java Driver for Apache Cassandra
/*
* Copyright (C) 2010 Wayne Meissner
*
* This file is part of the JNR project.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package jnr.ffi;
/**
* A utility for allocating memory that can be passed to native functions.
*/
public final class Memory {
private Memory() {
}
/**
* Allocates a new block of java memory and wraps it in a {@link Pointer}
* accessor.
*
* @param runtime The current runtime.
* @param size The size in bytes of memory to allocate.
*
* @return a {@code Pointer} instance that can access the memory.
*/
public static Pointer allocate(Runtime runtime, int size) {
return runtime.getMemoryManager().allocate(size);
}
/**
* Allocates a new block of java memory and wraps it in a {@link Pointer}
* accessor.
*
* @param runtime The current runtime.
* @param type The native type to allocate memory for.
*
* @return a {@code Pointer} instance that can access the memory.
*/
public static Pointer allocate(Runtime runtime, NativeType type) {
return runtime.getMemoryManager().allocate(runtime.findType(type).size());
}
/**
* Allocates a new block of java memory and wraps it in a {@link Pointer}
* accessor.
*
* @param runtime The current runtime.
* @param type The type to allocate memory for.
*
* @return a {@code Pointer} instance that can access the memory.
*/
public static Pointer allocate(Runtime runtime, Type type) {
return runtime.getMemoryManager().allocate(type.size());
}
/**
* Allocates a new block of java memory and wraps it in a {@link Pointer}
* accessor.
*
* @param runtime The current runtime.
* @param type The type alias to allocate memory for.
*
* @return a {@code Pointer} instance that can access the memory.
*/
public static Pointer allocate(Runtime runtime, TypeAlias type) {
return runtime.getMemoryManager().allocate(runtime.findType(type).size());
}
/**
* Allocates a new block of native memory and wraps it in a {@link Pointer}
* accessor.
*
* @param runtime The current runtime.
* @param size The size in bytes of memory to allocate.
*
* @return a {@code Pointer} instance that can access the memory.
*/
public static Pointer allocateDirect(Runtime runtime, int size) {
return runtime.getMemoryManager().allocateDirect(size);
}
/**
* Allocates a new block of native memory and wraps it in a {@link Pointer}
* accessor.
*
* @param runtime The current runtime.
* @param type The native type to allocate memory for.
*
* @return a {@code Pointer} instance that can access the memory.
*/
public static Pointer allocateDirect(Runtime runtime, NativeType type) {
return runtime.getMemoryManager().allocateDirect(runtime.findType(type).size());
}
/**
* Allocates a new block of native memory and wraps it in a {@link Pointer}
* accessor.
*
* @param runtime The current runtime.
* @param type The type alias to allocate memory for.
*
* @return a {@code Pointer} instance that can access the memory.
*/
public static Pointer allocateDirect(Runtime runtime, TypeAlias type) {
return runtime.getMemoryManager().allocateDirect(runtime.findType(type).size());
}
/**
* Allocates a new block of native memory and wraps it in a {@link Pointer}
* accessor.
*
* @param runtime The current runtime.
* @param size The size in bytes of memory to allocate.
* @param clear Whether the memory contents should be cleared, or left as
* random data.
*
* @return a {@code Pointer} instance that can access the memory.
*/
public static Pointer allocateDirect(Runtime runtime, int size, boolean clear) {
return runtime.getMemoryManager().allocateDirect(size, clear);
}
/**
* Allocates a new block of transient native memory and wraps it in a {@link Pointer}
* accessor. The memory returned by this method should not be passed to native methods
* that store the address for later use, as it may change each time it is passed to native code.
*
* @param runtime The current runtime.
* @param type The native type to allocate memory for.
*
* @return a {@code Pointer} instance that can access the memory.
*/
public static Pointer allocateTemporary(Runtime runtime, NativeType type) {
return runtime.getMemoryManager().allocateTemporary(runtime.findType(type).size(), true);
}
/**
* Allocates a new block of transient native memory and wraps it in a {@link Pointer}
* accessor. The memory returned by this method should not be passed to native methods
* that store the address for later use, as it may change each time it is passed to native code.
*
* @param runtime The current runtime.
* @param type The type alias to allocate memory for.
*
* @return a {@code Pointer} instance that can access the memory.
*/
public static Pointer allocateTemporary(Runtime runtime, TypeAlias type) {
return runtime.getMemoryManager().allocateTemporary(runtime.findType(type).size(), true);
}
/**
* Allocates a new block of transient native memory and wraps it in a {@link Pointer}
* accessor. The memory returned by this method should not be passed to native methods
* that store the address for later use, as it may change each time it is passed to native code.
*
* @param runtime The current runtime.
* @param type The native type to allocate memory for.
* @param clear Whether the memory contents should be cleared, or left as
* random data.
*
* @return a {@code Pointer} instance that can access the memory.
*/
public static Pointer allocateTemporary(Runtime runtime, NativeType type, boolean clear) {
return runtime.getMemoryManager().allocateTemporary(runtime.findType(type).size(), clear);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy