diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 11 |
1 files changed, 5 insertions, 6 deletions
@@ -5,9 +5,8 @@ the specification. The code is licensed under the LGPLv3 or any later version, unless specified otherwise in a file. -Depends on Alexandria, Serapeum, Ironclad (version 0.58+), function-cache, -trivial-gray-streams, bordeaux-threads, and fiveam for testing. In addition, on -POSIX systems the mmap and osicat libraries are used for the parallel decoder. +Depends on Alexandria, Serapeum, Ironclad (version 0.58+), trivial-gray-streams, +lparallel, and fiveam for testing. The public API is exported by the ERIS package. @@ -27,7 +26,7 @@ The eris-encode (INPUT BLOCK-SIZE OUTPUT-FUNCTION &KEY SECRET HASH-OUTPUT) function can be used to encode a vector, stream or pathname into an ERIS read-capability. -The eris-decode (READ-CAPABILITY FETCH-FUNCTION &KEY (CACHE-CAPACITY 2048)) +The eris-decode (READ-CAPABILITY FETCH-FUNCTION) function can be used to decode an ERIS read-capability. It returns a stream of the class ERIS-DECODE-STREAM: this class implements the Gray streams protocol. @@ -47,8 +46,8 @@ larger or equal to EOF. A high-level API is provided for convenience in backend.lisp. The concept is that a backend object is created, which holds information like output-function, -fetch-function, caching details, block-size, etc. and the {en/de}coding -functions simply take the backend as an argument. +fetch-function, block-size, etc. and the {en/de}coding functions simply take the +backend as an argument. This interface consists of two generic functions: store-data, for encoding data, and fetch-data, for retrieving the contents from a read-capability object. |