lmdbjava/src/main/java/org/lmdbjava/package-info.java at gh-267 · lmdbjava/lmdbjava · GitHub

History

52 lines (52 loc) · 2.42 KB

Raw

* 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.

/**

* Lightning Memory Database (LMDB) for Java (LmdbJava).

* LmdbJava is intended for extremely low latency use cases. Users are required to understand and

* comply with the LMDB C API contract (eg handle usage patterns, thread binding, process rules).

* Priorities:

* <ol>

* <li>Minimize latency, particularly on any critical path (see below)

* <li>Preserve the LMDB C API model as far as practical

* <li>Apply Java idioms only when not in conflict with the above

* <li>Fully encapsulate (hide) the native call library and patterns

* <li>Don't require runtime dependencies beyond the native call library

* <li>Support official JVMs running on typical 64-bit operating systems

* <li>Prepare for Java 9 (eg Unsafe, native call technology roadmap etc)

* </ol>

* Critical paths of special latency focus:

* <ul>

* <li>Releasing and renewing a read-only transaction

* <li>Any operation that uses a cursor

* </ul>

* The classes in LmdbJava DO NOT provide any concurrency guarantees. Instead you MUST observe

* LMDB's specific thread rules (eg do not share transactions between threads). LmdbJava does not

* shield you from these requirements, as doing so would impose locking overhead on use cases that

* may not require it or have already carefully implemented application threading (as most low

* latency applications do to optimize the memory hierarchy, core pinning etc).

* Most methods in this package will throw a standard Java exception for failing preconditions

* (eg {@link NullPointerException} if a mandatory argument was missing) or a subclass of {@link

* LmdbException} for precondition or LMDB C failures. The majority of LMDB exceptions indicate an

* API usage or {@link Env} configuration issues, and as such are typically unrecoverable.

package org.lmdbjava;

lmdbjava/src/main/java/org/lmdbjava/package-info.java at gh-267 · lmdbjava/lmdbjava · GitHub

Uh oh!

Expand file tree

Breadcrumbs

package-info.java

Latest commit

History

Breadcrumbs

package-info.java

File metadata and controls