Skip to content
This repository has been archived by the owner on May 21, 2020. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aserrallerios authored May 15, 2018
1 parent 03419c4 commit b0e6b33
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ For more information about KCL please visit the [official documentation](http://

```scala
resolvers += "aserrallerios bintray" at "https://dl.bintray.com/content/aserrallerios/maven"
libraryDependencies += "aserrallerios" %% "kcl-akka-stream" % "0.3"
libraryDependencies += "aserrallerios" %% "kcl-akka-stream" % "0.4"
```

## Usage
Expand All @@ -45,7 +45,8 @@ In order to use it, you need to provide a Worker builder and the Source settings
```scala
val workerSourceSettings = KinesisWorkerSourceSettings(
bufferSize = 1000,
terminateStreamGracePeriod = 1 minute)
terminateStreamGracePeriod = 1 minute,
backpressureTimeout = 1 minute)
val builder: IRecordProcessorFactory => Worker = { recordProcessorFactory =>
new Worker.Builder()
.recordProcessorFactory(recordProcessorFactory)
Expand Down Expand Up @@ -89,6 +90,8 @@ KinesisWorkerSource(builder, workerSourceSettings).to(
KinesisWorker.checkpointRecordsSink(checkpointSettings))
```

Note that checkpointer Flow may not maintain input order of records of different shards.

## License

Copyright (c) 2018 Albert Serrallé
Expand All @@ -103,4 +106,4 @@ We build on a number of third-party software tools, with the following licenses:

Third-Party software | License
----------------------------|-----------------------
amazon-kinesis-client | Amazon Software License
amazon-kinesis-client | Amazon Software License

0 comments on commit b0e6b33

Please sign in to comment.