Nuklei

An experiment in connecting services in various languages via composable standard protocols.

License (See LICENSE file for full license)

Copyright 2014 Kaazing Corporation, All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Attributions

AtomicBuffer and AtomicBufferTest are taken from SBE. Queuing mechanism hugely inspired by Martin Thompson, Mike Barker, Gil Tene, Nitsan Wakart, and discussions on the Mechanical Sympathy Google Group

Build

You require the following to build Nuklei:

• Latest stable Oracle JDK 8
• 3.0.4 or later of Maven

To build and install to local maven repository.

$ mvn clean install

Components

• AtomicBuffer: common interface over byte[], ByteBuffer (including MappedByteBuffer), and heap-allocated memory. Port of SBE DirectBuffer with additions for atomic operations.
• Nukleus: interface for service. Also the service itself.
• MpscRingBuffer: multiple-producer-single-consumer (MPSC) ring buffer between Nuklei (suitable for inter-process communications) with Spying support.
• MpscArrayBuffer: multiple-producer-single-consumer (MPSC) queue between Nuklei (suitable for in-process communications) with Spying support.
• Spy: means to attach a "sniffer" to a communication channel to spy on the data exchange. May be lossy. Similar to tcpdump.
• Flyweight: overlay of structured layout over an AtomicBuffer.
• Nuklei: scheduler interface for one or more Nukleus implementations. Some implementations are:
  • DedicatedNuklei: one thread per Nuklei scheduler
  • FjpFreeStandingNuklei: ForkJoinPool based Nuklei scheduler
• Kompound: container for Mikro based services
  • Mikro: interface for pure message based services
  • Proxy: interface for sending messages to other services

TODOs

• Pre-packaged Nuklei
  • TCP Connector
  • UDP Reader
  • UDP Writer
• Kompound container
• Spy for RingBuffer and ArrayBuffer
• Standard Parsers/Flyweights
  • WebSocket (RFC 6455) via HTTP/1.1 Upgrade
  • CoAP (RFC 7252) over WebSocket
• Robin Hood HashMap for Dictionary-style state handling within Nuklei