core
/
oga
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated README intro + thread-safety section.

This commit is contained in:
Yorick Peterse 2014-09-11 23:39:10 +02:00
parent 019ba8c660
commit 7a3655a43b
1 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,12 +1,14 @@
# Oga # Oga
Oga is an XML/HTML parser written in Ruby. Oga aims to provide an easy to use Oga is an XML/HTML parser written in Ruby. It provides an easy to use API for
and high performance API for all your XML/HTML parsing needs. Oga requires parsing, modifying and querying documents (using XPath expressions). Oga does
nothing other than Ruby, it does not depend on libxml or other system libraries. not require system libraries such as libxml, making it easier and faster to
install on various platforms. To achieve better performance Oga uses a small,
native extension (C for MRI/Rubinius, Java for JRuby).
Oga uses a small native extension (C for MRI/Rubinius, Java for JRuby) to Oga provides an API that allows you to safely parse and query documents in a
speed up the process of lexing XML into tokens. Initial prototypes used a pure multi-threaded environment, without having to worry about your applications
Ruby setup but this proved to be too slow when consuming large input sizes. blowing up.
From [Wikipedia][oga-wikipedia]: From [Wikipedia][oga-wikipedia]:
@ -86,6 +88,16 @@ gcc or clang. Oga's C extension can be compiled with both. JRuby does not
require a compiler as the native extension is compiled during the Gem building require a compiler as the native extension is compiled during the Gem building
process and bundled inside the Gem itself. process and bundled inside the Gem itself.
## Thread Safety
Documents parsed using Oga are thread-safe as long as they are not modified by
multiple threads at the same time. Querying documents using XPath can be done by
multiple threads just fine. Write operations, such as removing attributes, are
_not_ thread-safe and should not be done by multiple threads at once.
It is advised that you do not share parsed documents between threads unless you
_really_ have to.
## Documentation ## Documentation
The documentation is best viewed [on the documentation website][doc-website]. The documentation is best viewed [on the documentation website][doc-website].