Skip to content

Commit

Permalink
adding notes about synchronous methods in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nathanjsweet committed Jul 23, 2015
1 parent f17a0ef commit b97ebc6
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,10 @@ nodehun.createNewNodehun(affbuf,dictbuf,function(err,dict){
});
```

A Warning on Synchronous Methods
-----------------------------
There are synchronous versions of all the methods listed above, but they are not doucmented as they are only present for people who really know and understand what they are doing. I highly recommend looking at the C++ source code if you are going to use these methods in a production environment as the locks involved with them can create some counterintuitive situations. For example, if you were to remove a word synchronously while many different suggestion threads were working in the backgound the remove word method could take seconds to complete while it waits to take control of the read-write lock. This is obviously disastrous in a situation where you would be servicing many requests.

A Note About Open Office Dictionaries
-------------------------------------
All files must be UTF-8 to work! When you download [open office dictionaries](http://cgit.freedesktop.org/libreoffice/dictionaries/tree/) don't assume that the file is UTF-8 just because it is being served as a UTF-8 file. You may have to convert the file using the `iconv` unix utility (easy enough to do) to UTF-8 in order for the files to work.
Expand Down

0 comments on commit b97ebc6

Please sign in to comment.