streamtime
The streamtime package provides a simple extension to Java I/O streams that
can track transfer rates and provide statistics.
Features
- Input and output stream implementations that track and regularly broadcast transfer statistics.
- High coverage test suite.
- OSGi-ready.
- JPMS-ready.
- ISC license.
Usage
Create a STTimedInputStream from an existing InputStream, and provide it
with a Consumer<STTransferStatistics> function that receives transfer updates:
InputStream is;
Consumer<STTransferStatistics> f;
try (var input = new STTimedInputStream(f, is)) {
input.transferTo(...);
}
The f function will be called at a rate of roughly once per second, with
a new value of type STTransferStatistics describing the expected number of
octets, the current number of octets, and the current number of octets received
per second.
The STTimedOutputStream class works similarly, but for OutputStream values.
Releases & Development Snapshots
Releases
You can subscribe to the atom feed to be notified of project releases.
The most recently released version of the package is 1.0.0.
1.0.0 Release (2024-05-11Z)
The compiled artifacts for the release (and all previous releases) are available on Maven Central.
Maven Modules
<dependency> <group>com.io7m.streamtime</group> <artifactId>com.io7m.streamtime.core</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.streamtime</group> <artifactId>com.io7m.streamtime.tests</artifactId> <version>1.0.0</version> </dependency>
Development Snapshots
At the time of writing, the current unstable development version of the package is 1.0.1-SNAPSHOT.
Development snapshots may be available in the Central Portal Snapshots repository. Snapshots are published to this repository every time the project is built by the project's continuous integration system, but snapshots do expire after around ninety days and so may or may not be available depending on when a build of the package was last triggered.
Manual
This project does not have any user manuals or other documentation beyond what might be present on the page above.
Sources
This project uses Git to manage source code.
Repository: https://www.github.com/io7m-com/streamtime
$ git clone --recursive https://www.github.com/io7m-com/streamtime
Issues
This project uses GitHub Issues to track issues.
License
Copyright © 2023 Mark Raynsford <code@io7m.com> https://www.io7m.com Permission to use, copy, modify, and/or 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.