Alphatier is a resource management library. It is designed to allow different
schedulers to share the resources of a pool of executors in order to execute
tasks with those.
Read the [detailed documentation](#io.alphatier.pools) below to get an in-depth
understanding.
## License
Copyright © 2014 [Tobias Sarnowski](mailto:
[email protected]),
[Willi Schönborn](mailto:
[email protected])
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
## Usage
The library is written in [Clojure](http://clojure.org/) and is available in the
[central Maven repository](https://repo1.maven.org/maven2/io/alphatier/alphatier/):
<dependency>
<groupId>io.alphatier</groupId>
<artifactId>alphatier</artifactId>
<version>0.3.0</version>
</dependency>
The library is written in pure Clojure without [ahead-of-time compilation](http://clojure.org/compilation).
This means, that the library does not contain any *.class files. If you work with
Clojure, this is not a problem but if you like to use the library from another
JVM language (like Java, Scala or Groovy), you can use
[Clojure's built-in tools](http://clojure.org/java_interop#Java%20Interop-Calling%20Clojure%20From%20Java)
for interoperability or try our Java library:
[https://github.com/sarnowski/alphatier-java](https://github.com/sarnowski/alphatier-java)
### Development
If you like to change this library, please have a look at the [README](README.md). Development is done via
[Github](https://github.com/sarnowski/alphatier).
There are no modules declared in this project.
Alphatier
Alphatier is a resource management library. It is designed to allow different schedulers to share the resources of a pool of executors in order to execute tasks with those.
The detailed documentation is located at
An offline version is available by opening the index.html
file with your browser.
Development
The source code is managed via git and hosted on Github. See the Github help pages for more information.
The source is tested on every update by Travis-CI.
The build process of this library is managed by Leiningen. The following commands have to be executed at the root of your project checkout:
Cleanup your project
lein clean
The command deletes all generated files in order to guarantee a clean and defined project state.
Running the test suite
lein test
The test suite is implemented in the test/
directory. The test command runs all implemented unit tests.
Building a jar artifact
lein jar
The produced jar file can be used in other JVM based projects. It requires all other dependant jars on the classpath (see project.clj).
Generating the documentation
lein doc
This generates a new documentation index.html
at the root of your project directory. It uses comments from the source code.
License
Copyright (c) 2014 Tobias Sarnowski <[email protected]>, Willi Schönborn <[email protected]>
Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.