https://github.com/asynkron/protoactor-kotlin
Ultra-fast distributed cross-platform actor framework
https://github.com/asynkron/protoactor-kotlin
Last synced: 4 months ago
JSON representation
Ultra-fast distributed cross-platform actor framework
- Host: GitHub
- URL: https://github.com/asynkron/protoactor-kotlin
- Owner: asynkron
- License: apache-2.0
- Created: 2017-07-09T07:50:32.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-04-01T04:49:52.000Z (about 5 years ago)
- Last Synced: 2024-12-11T23:32:37.207Z (4 months ago)
- Language: Kotlin
- Homepage: http://proto.actor
- Size: 866 KB
- Stars: 222
- Watchers: 28
- Forks: 25
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/AsynkronIT/protoactor-kotlin)
[](https://bintray.com/asynkronit/protoactor-kotlin/proto-actor/_latestVersion)
[](https://codecov.io/gh/AsynkronIT/protoactor-kotlin)
# Proto.Actor Kotlin
Ultra-fast, distributed, cross-platform actors.
This is the Kotlin repository for [Proto.Actor](http://proto.actor/).
## Stability
It's used in production but doesn't have the same adoption and stability as the [C#](https://github.com/AsynkronIT/protoactor-dotnet) and [Go](https://github.com/AsynkronIT/protoactor-go) implementations.
## How to build
```
./gradlew build
```
## Design principles
**Minimalistic API** - The API should be small and easy to use. Avoid enterprisey containers and configurations.
**Build on existing technologies** - There are already a lot of great technologies for e.g. networking and clustering.
Build on those instead of reinventing them. E.g. gRPC streams for networking, Consul for clustering.
**Pass data, not objects** - Serialization is an explicit concern - don't try to hide it. Protobuf all the way.
**Be fast** - Do not trade performance for magic API trickery.
Inprocess Ping-Pong results:
```
Dispatcher Elapsed Msg/sec
300 273 116885925
400 217 147426522
500 150 213037390
600 85 375979638
700 87 364621820
800 83 381552772 <-- 380+ mil msg/sec
```
## Modules
Dependencies
## Getting started
The best place currently for learning how to use Proto.Actor is the [examples](https://github.com/AsynkronIT/protoactor-kotlin/tree/master/examples).
### Hello world
`build.gradle.kts`
```
repositories {
jcenter()
}
dependencies {
implementation("actor.proto:proto-actor:latest.release")
}
```
`App.kt`
```
import actor.proto.*
fun main() {
val prop = fromFunc { msg ->
when (msg) {
is Started -> println("Started")
is String -> {
println("Hello $msg")
stop(self)
}
is Stopping -> println("Stopping")
is Stopped -> println("Stopped")
else -> println("Unknown message $msg")
}
}
val pid = spawn(prop)
send(pid, "Proto.Actor")
readLine()
}
```
## Release management
Stable release are published to https://bintray.com/asynkronit/protoactor-kotlin and linked to jcenter.
Anyone of the repositories below will do.
```
repositories {
maven("https://dl.bintray.com/asynkronit/protoactor-kotlin")
}
```
```
repositories {
jcenter()
}
```
### Snapshot
Commits on the master branch are deployed as snapshots to
https://oss.jfrog.org/artifactory/oss-snapshot-local/actor/proto/ and can be consumed by adding the following configuration to your gradle file:
```
repositories {
repositories {
maven { url 'http://oss.jfrog.org/artifactory/oss-snapshot-local' }
}
}
dependencies {
compile 'actor.proto:proto-actor:0.1.0-SNAPSHOT'
}
```
### Publishing a new version
When a tag is created e.g. `v0.1.0` Travis will build and publish the packages to Bintray.
### Support
Many thanks to [JetBrains](https://www.jetbrains.com) for support!
Also thanks to [ej-technologies.com for their Java profiler - JProfiler](https://www.ej-technologies.com/products/jprofiler/overview.html)