hlc_dart 0.1.2

A Hybrid Logical Clock implementation in Dart, based on the paper "Logical Physical Clocks and Consistent Snapshots in Globally Distributed Databases".

Hybrid Logical Clock

• Hybrid Logical Clock
  • Features
  • Getting Started
  • Usage
    • Basic Usage
    • Complete Example

A hybrid logical clock implementation in Dart based on the paper Logical Physical Clocks and Consistent Snapshots in Globally Distributed Databases.

This library provides a Hybrid Logical Clock (HLC) implementation that combines the benefits of logical clocks and physical clocks:

• Captures causality like logical clocks (e hb f => l.e < l.f)
• Maintains closeness to physical/NTP time (l.e is close to pt.e)
• Compatible with 64-bit NTP timestamp format
• Works in peer-to-peer architectures without a central server

Features

• Local event handling
• Message exchange between peers
• Causality detection
• Serialization to/from 64-bit integers
• Thread-safe implementation
• Zero dependencies

Getting Started

Add this to your package's pubspec.yaml file:

dependencies:
  hlc_dart: ^1.0.0

Usage

Basic Usage

import 'package:hlc_dart/hlc_dart.dart';

// Create a new HLC initialized to the current time
final clock = HybridLogicalClock.now();

// Handle a local event
clock.localEvent(DateTime.now().millisecondsSinceEpoch);

// Handle receiving a message from another peer
final receivedClock = HybridLogicalClock.now();
clock.receiveEvent(DateTime.now().millisecondsSinceEpoch, receivedClock);

// Check causality
print(clock.happenedBefore(receivedClock));
print(clock.isConcurrentWith(receivedClock));

// Serialize/deserialize
final serialized = clock.toInt64();
final deserialized = HybridLogicalClock.fromInt64(serialized);

Complete Example