Skip to content

Commit d92dac0

Browse files
committed
Added documentation about multi-threaded use
1 parent b996c58 commit d92dac0

2 files changed

Lines changed: 15 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
CHANGELOG
22
=========
33

4+
0.3.2 (201X-XX-XX)
5+
------------------
6+
7+
* Added tests and documentation for mutli-threaded use.
8+
49
0.3.1 (2013-11-05)
510
------------------
611

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ as they provide a convenient representation of multi-type data structures and
4242
the databind package of Jackson 2 supplies many tools for interacting with the
4343
data in this format.
4444

45+
We recommend reusing the `Reader` object rather than creating a new one for
46+
each lookup. The creation of this object is relatively expensive as it must
47+
read in metadata for the file.
48+
4549
## Example ##
4650

4751
```java
@@ -59,6 +63,12 @@ reader.close();
5963

6064
```
6165

66+
## Multi-Threaded Use ##
67+
68+
This API fully supports use in multi-threaded applications. In such
69+
applications, we suggest creating one `Reader` object and sharing that among
70+
threads.
71+
6272
## Format ##
6373

6474
The MaxMind DB format is an open format for quickly mapping IP addresses to

0 commit comments

Comments
 (0)