Skip to content

Attempt to move ByteBufProxy into the main codebase so it can be used. #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
buko wants to merge 2 commits into from
Closed

Attempt to move ByteBufProxy into the main codebase so it can be used. #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02fcdbe
Attempt to move ByteBufProxy into the main codebase so it can be used.
Jul 11, 2018
477a51e
More changes to make the build work.
Jul 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
402 changes: 201 additions & 201 deletions LICENSE.txt
View file
Open in desktop

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions pom.xml
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
<github.org>lmdbjava</github.org>
<github.repo>lmdbjava</github.repo>
<license.licenseName>apache_v2</license.licenseName>
<netty.version>4.1.24.Final</netty.version>
</properties>
<dependencies>
<dependency>
Expand Down Expand Up @@ -93,13 +94,13 @@
<groupId>org.agrona</groupId>
<artifactId>agrona</artifactId>
<version>0.9.16</version>
<optional>true</optional>
<optional>false</optional>
</dependency>
<dependency>
<groupId>io.netty</groupId>
<artifactId>netty-all</artifactId>
<version>4.1.24.Final</version>
<scope>test</scope>
<artifactId>netty-buffer</artifactId>
<version>${netty.version}</version>
<optional>false</optional>
</dependency>
<dependency>
<groupId>com.google.guava</groupId>
Expand Down
264 changes: 132 additions & 132 deletions src/main/java/org/lmdbjava/BufferProxy.java
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,132 +1,132 @@
/*-
* #%L
* LmdbJava
* %%
* Copyright (C) 2016 - 2018 The LmdbJava Open Source 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.
* #L%
*/

package org.lmdbjava;

import static java.lang.Long.BYTES;
import jnr.ffi.Pointer;

/**
* The strategy for mapping memory address to a given buffer type.
*
* <p>
* The proxy is passed to the {@link Env#create(org.lmdbjava.BufferProxy)}
* method and is subsequently used by every {@link Txn}, {@link Dbi} and
* {@link Cursor} associated with the {@link Env}.
*
* @param <T> buffer type
*/
@SuppressWarnings("checkstyle:abstractclassname")
public abstract class BufferProxy<T> {

/**
* Size of a <code>MDB_val</code> pointer in bytes.
*/
protected static final int MDB_VAL_STRUCT_SIZE = BYTES * 2;

/**
* Offset from a pointer of the <code>MDB_val.mv_data</code> field.
*/
protected static final int STRUCT_FIELD_OFFSET_DATA = BYTES;

/**
* Offset from a pointer of the <code>MDB_val.mv_size</code> field.
*/
protected static final int STRUCT_FIELD_OFFSET_SIZE = 0;

/**
* Allocate a new buffer suitable for passing to
* {@link #out(java.lang.Object, jnr.ffi.Pointer, long)}.
*
* @return a buffer for passing to the <code>out</code> method
*/
protected abstract T allocate();

/**
* Compare the two buffers.
*
* <p>
* Implemented as a protected method to discourage use of the buffer proxy
* in collections etc (given by design it wraps a temporary value only).
*
* @param o1 left operand
* @param o2 right operand
* @return as per {@link Comparable}
*/
protected abstract int compare(T o1, T o2);

/**
* Deallocate a buffer that was previously provided by {@link #allocate()}.
*
* @param buff the buffer to deallocate (required)
*/
protected abstract void deallocate(T buff);

/**
* Obtain a copy of the bytes contained within the passed buffer.
*
* @param buffer a non-null buffer created by this proxy instance
* @return a copy of the bytes this buffer is currently representing
*/
protected abstract byte[] getBytes(T buffer);

/**
* Called when the <code>MDB_val</code> should be set to reflect the passed
* buffer. This buffer will have been created by end users, not
* {@link #allocate()}.
*
* @param buffer the buffer to write to <code>MDB_val</code>
* @param ptr the pointer to the <code>MDB_val</code>
* @param ptrAddr the address of the <code>MDB_val</code> pointer
*/
protected abstract void in(T buffer, Pointer ptr, long ptrAddr);

/**
* Called when the <code>MDB_val</code> should be set to reflect the passed
* buffer.
*
* @param buffer the buffer to write to <code>MDB_val</code>
* @param size the buffer size to write to <code>MDB_val</code>
* @param ptr the pointer to the <code>MDB_val</code>
* @param ptrAddr the address of the <code>MDB_val</code> pointer
*/
protected abstract void in(T buffer, int size, Pointer ptr, long ptrAddr);

/**
* Called when the <code>MDB_val</code> may have changed and the passed buffer
* should be modified to reflect the new <code>MDB_val</code>.
*
* @param buffer the buffer to write to <code>MDB_val</code>
* @param ptr the pointer to the <code>MDB_val</code>
* @param ptrAddr the address of the <code>MDB_val</code> pointer
* @return the buffer for <code>MDB_val</code>
*/
protected abstract T out(T buffer, Pointer ptr, long ptrAddr);

/**
* Create a new {@link KeyVal} to hold pointers for this buffer proxy.
*
* @return a non-null key value holder
*/
final KeyVal<T> keyVal() {
return new KeyVal<>(this);
}

}
/*-
* #%L
* LmdbJava
* %%
* Copyright (C) 2016 - 2018 The LmdbJava Open Source 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.
* #L%
*/
package org.lmdbjava;
import static java.lang.Long.BYTES;
import jnr.ffi.Pointer;
/**
* The strategy for mapping memory address to a given buffer type.
*
* <p>
* The proxy is passed to the {@link Env#create(org.lmdbjava.BufferProxy)}
* method and is subsequently used by every {@link Txn}, {@link Dbi} and
* {@link Cursor} associated with the {@link Env}.
*
* @param <T> buffer type
*/
@SuppressWarnings("checkstyle:abstractclassname")
public abstract class BufferProxy<T> {
/**
* Size of a <code>MDB_val</code> pointer in bytes.
*/
protected static final int MDB_VAL_STRUCT_SIZE = BYTES * 2;
/**
* Offset from a pointer of the <code>MDB_val.mv_data</code> field.
*/
protected static final int STRUCT_FIELD_OFFSET_DATA = BYTES;
/**
* Offset from a pointer of the <code>MDB_val.mv_size</code> field.
*/
protected static final int STRUCT_FIELD_OFFSET_SIZE = 0;
/**
* Allocate a new buffer suitable for passing to
* {@link #out(java.lang.Object, jnr.ffi.Pointer, long)}.
*
* @return a buffer for passing to the <code>out</code> method
*/
protected abstract T allocate();
/**
* Compare the two buffers.
*
* <p>
* Implemented as a protected method to discourage use of the buffer proxy
* in collections etc (given by design it wraps a temporary value only).
*
* @param o1 left operand
* @param o2 right operand
* @return as per {@link Comparable}
*/
protected abstract int compare(T o1, T o2);
/**
* Deallocate a buffer that was previously provided by {@link #allocate()}.
*
* @param buff the buffer to deallocate (required)
*/
protected abstract void deallocate(T buff);
/**
* Obtain a copy of the bytes contained within the passed buffer.
*
* @param buffer a non-null buffer created by this proxy instance
* @return a copy of the bytes this buffer is currently representing
*/
protected abstract byte[] getBytes(T buffer);
/**
* Called when the <code>MDB_val</code> should be set to reflect the passed
* buffer. This buffer will have been created by end users, not
* {@link #allocate()}.
*
* @param buffer the buffer to write to <code>MDB_val</code>
* @param ptr the pointer to the <code>MDB_val</code>
* @param ptrAddr the address of the <code>MDB_val</code> pointer
*/
protected abstract void in(T buffer, Pointer ptr, long ptrAddr);
/**
* Called when the <code>MDB_val</code> should be set to reflect the passed
* buffer.
*
* @param buffer the buffer to write to <code>MDB_val</code>
* @param size the buffer size to write to <code>MDB_val</code>
* @param ptr the pointer to the <code>MDB_val</code>
* @param ptrAddr the address of the <code>MDB_val</code> pointer
*/
protected abstract void in(T buffer, int size, Pointer ptr, long ptrAddr);
/**
* Called when the <code>MDB_val</code> may have changed and the passed buffer
* should be modified to reflect the new <code>MDB_val</code>.
*
* @param buffer the buffer to write to <code>MDB_val</code>
* @param ptr the pointer to the <code>MDB_val</code>
* @param ptrAddr the address of the <code>MDB_val</code> pointer
* @return the buffer for <code>MDB_val</code>
*/
protected abstract T out(T buffer, Pointer ptr, long ptrAddr);
/**
* Create a new {@link KeyVal} to hold pointers for this buffer proxy.
*
* @return a non-null key value holder
*/
final KeyVal<T> keyVal() {
return new KeyVal<>(this);
}
}
Loading