https://github.com/davidmoten/rxjava-file

RxJava observables for files including NIO events
https://github.com/davidmoten/rxjava-file

Last synced: 3 months ago
JSON representation

RxJava observables for files including NIO events

• Host: GitHub
• URL: https://github.com/davidmoten/rxjava-file
• Owner: davidmoten
• License: apache-2.0
• Created: 2014-05-10T04:46:22.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2018-12-06T03:19:47.000Z (about 6 years ago)
• Last Synced: 2024-10-14T07:45:56.271Z (3 months ago)
• Language: Java
• Homepage:
• Size: 147 KB
• Stars: 82
• Watchers: 12
• Forks: 17
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-rxjava - rxjava-file - RxJava observables for files including NIO events. (Bindings)

README

        
rxjava-file

===========




[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.davidmoten/rxjava-file/badge.svg?style=flat)](https://maven-badges.herokuapp.com/maven-central/com.github.davidmoten/rxjava-file)

Status: *released to Maven Central*

Requires Java 7.

Observable utilities for files:

* tail a file (either lines or byte[]) 

* trigger tail updates using Java 7 and later NIO ```WatchService``` events

* or trigger tail updates using any Observable

* stream ```WatchEvent```s from a ```WatchService```

* backpressure support

* tested on Linux and Windows 7 (not OSX, help appreciated!)

[Release Notes](RELEASE_NOTES.md)

Maven site reports are [here](http://davidmoten.github.io/rxjava-file/index.html) including [javadoc](http://davidmoten.github.io/rxjava-file/apidocs/index.html).

For RxJava 2.x see [rxjava2-file](https://github.com/davidmoten/rxjava2-file).

Getting started

----------------

Add this maven dependency to your pom.xml:

```xml

  com.github.davidmoten

  rxjava-file

  0.4.4

```

How to build

----------------

```bash

git clone https://github.com/davidmoten/rxjava-file

cd rxjava-file

mvn clean install 

```

Examples

--------------

### Tail a text file with NIO

Tail the lines of the text log file ```/var/log/server.log``` as an ```Observable```:

```java

import com.github.davidmoten.rx.FileObservable;

import rx.Observable;

import java.io.File; 

 

Observable items = 

     FileObservable.tailer()

                   .file("/var/log/server.log")

                   .startPosition(0)

                   .sampleTimeMs(500)

                   .chunkSize(8192)

                   .utf8()

                   .tailText();

                     

```

or, using defaults (will use default charset):

```java

Observable items = 

     FileObservable.tailer()

                   .file("/var/log/server.log")

                   .tailText();

```

Note that if you want the ```Observable``` to be emitting line by line then wrap 

it with a call like ```StringObservable.split(observable, "\n")```. ```StringObservable``` is in the RxJava *rxjava-string* artifact.

### Tail a text file without NIO

The above example uses a ```WatchService``` to generate ```WatchEvent```s to prompt rereads of the end of the file to perform the tail.

To use polling instead (say every 5 seconds):

```java

Observable items = 

     FileObservable.tailer()

                   .file(new File("var/log/server.log"))

                   .source(Observable.interval(5, TimeUnit.SECONDS)

                   .tailText();

```

### Tail a binary file with NIO

```java

Observable items = 

     FileObservable.tailer()

                   .file("/tmp/dump.bin")

                   .tail();

```

### Tail a binary file without NIO

```java

Observable items = 

     FileObservable.tailer()

                   .file("/tmp/dump.bin")

                   .source(Observable.interval(5, TimeUnit.SECONDS)

                   .tail();

```