search

awslabs / amazon-kinesis-producer

Amazon Kinesis Producer Library
Apache License 2.0
399 stars 331 forks source link

Document KPL #266

Open pauldraper opened 5 years ago

pauldraper commented 5 years ago

I must be missing something, but shouldn't this project be documented?

The Kinesis Producer Library (KPL) runs in a separate process, and communicates with your parent user process using IPC. This architecture is sometimes called a microservice, and is chosen for two main reasons:

2) Arbitrary clients can be supported

There are always customers who use languages other than the ones officially supported. These customers should also be able to use the KPL easily.

I can't find anything about this "easy" use of the KPL IPC.

rwaweber commented 4 years ago

Seconding @pauldraper 's comment -- would love to see some documentation around the IPC API.

There is mention in this blogpost that its possible to implement your own wrapper, after investigating the protobuf message definitions(I'm assuming here and maybe here too):

Communication between the wrapper and the native process takes place over named pipes (either Unix or Windows), and the messages are implemented with Google protocol buffers. It’s possible to build your own KPL wrapper using the protobuf message definitions available in the source code. The native process is agnostic to how the wrapper is implemented as long as the messages sent to it are valid.