Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
/*
* Copyright (c) 2026 VK DIGITAL TECHNOLOGIES LIMITED LIABILITY COMPANY
* All Rights Reserved.
*/

package io.tarantool.pool.availability.heartbeat;

import java.time.Duration;
import java.util.Map;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionStage;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicReference;

import io.micrometer.core.instrument.MeterRegistry;
import io.netty.util.Timer;

import io.tarantool.pool.HeartbeatOpts;
import io.tarantool.pool.PoolEntryState;
import io.tarantool.pool.PoolEntryView;
import io.tarantool.pool.availability.AvailabilityPolicy;
import io.tarantool.pool.availability.heartbeat.HeartbeatEvent.StartEvent;
import io.tarantool.pool.availability.heartbeat.HeartbeatEvent.StopEvent;

/**
* The default availability policy: it sends pings to the connection and switches the connection
* state between the active, invalidated and killed ones depending on the ping results.
*/
public class DefaultAvailabilityPolicy implements AvailabilityPolicy {

private final AtomicReference<Utils> utils;

private final HeartbeatOpts opts;

private final Map<PoolEntryView, HeartbeatStateMachine> entries;

public DefaultAvailabilityPolicy(HeartbeatOpts opts) {
this.opts = Objects.requireNonNull(opts, "Heartbeat options must not be null!");
this.utils = new AtomicReference<>(null);
this.entries = new ConcurrentHashMap<>();
}

@Override
public PoolEntryState initState(PoolEntryView view) {
return HeartbeatConstants.ACTIVE_STATE;
}

@Override
public Duration restartBackoff(PoolEntryView view) {
return Duration.ZERO;
}

@Override
public CompletionStage<Void> start(PoolEntryView view) {
Objects.requireNonNull(view, "view must not be null!");
final CompletableFuture<Void> cf = new CompletableFuture<>();

try {
final HeartbeatStateMachine m =
this.entries.computeIfAbsent(
view, old -> new HeartbeatStateMachine(view, this.opts, this.utils.get()));
m.handle(new StartEvent(cf));
} catch (Throwable ex) {
cf.completeExceptionally(ex);
}
return cf;
}

@Override
public CompletionStage<Void> stop(PoolEntryView view, Throwable cause) {
Objects.requireNonNull(view, "view must not be null!");
final CompletableFuture<Void> cf = new CompletableFuture<>();

final HeartbeatStateMachine machine = this.entries.remove(view);
if (machine == null) {
cf.complete(null);
return cf;
}

machine.handle(new StopEvent(cf, cause));
return cf;
}

@Override
public void configure(Timer timer, MeterRegistry metrics) {
Objects.requireNonNull(timer, "timer must not be null");
this.utils.compareAndSet(null, Utils.configure(timer, metrics));
}
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@

'HeartbeatStateMachine

@startuml
skinparam linetype ortho
skinparam nodesep 100
Expand Down Expand Up @@ -229,3 +232,56 @@ class io.tarantool.pool.availability.heartbeat.HeartbeatStateMachine$HeartbeatCt
~ firstSuccess(): void
}
@enduml

'io.tarantool.pool.availability.heartbeat.DefaultAvailabilityPolicy
@startuml
skinparam linetype ortho
skinparam nodesep 100
skinparam ranksep 100

interface io.tarantool.pool.availability.AvailabilityPolicy {
+ configure(timer: Timer, metrics: MeterRegistry): void
+ initState(view: PoolEntryView): PoolEntryState
+ restartBackoff(view: PoolEntryView): Duration
+ start(view: PoolEntryView): CompletionStage<Void>
+ stop(view: PoolEntryView): CompletionStage<Void> <<default>>
+ stop(view: PoolEntryView, cause: Throwable): CompletionStage<Void>
}

class io.tarantool.pool.availability.heartbeat.DefaultAvailabilityPolicy <<public>> {
- utils: AtomicReference<Utils> {readOnly}
- entries: Map<PoolEntryView, HeartbeatStateMachine> {readOnly}
- opts: HeartbeatOpts {readOnly}
+ DefaultAvailabilityPolicy(opts: HeartbeatOpts): <<create>>
+ initState(view: PoolEntryView): PoolEntryState
+ restartBackoff(view: PoolEntryView): Duration
+ start(view: PoolEntryView): CompletionStage<Void>
+ stop(view: PoolEntryView, cause: Throwable): CompletionStage<Void>
+ configure(timer: Timer, metrics: MeterRegistry): void
~ hasView(view: PoolEntryView): boolean
}

class io.tarantool.pool.availability.heartbeat.HeartbeatConstants <<public final>> {
+ {static} ACTIVE_STATE_NAME: String {readOnly}
+ {static} ACTIVE_STATE: PoolEntryState {readOnly}
}

class io.tarantool.pool.availability.heartbeat.HeartbeatStateMachine
class io.tarantool.pool.availability.heartbeat.Utils
class io.tarantool.pool.availability.heartbeat.HeartbeatEvent$StartEvent
class io.tarantool.pool.availability.heartbeat.HeartbeatEvent$StopEvent
class io.tarantool.pool.HeartbeatOpts
class io.tarantool.pool.PoolEntryView
class io.tarantool.pool.PoolEntryState

io.tarantool.pool.availability.heartbeat.DefaultAvailabilityPolicy ..|> io.tarantool.pool.availability.AvailabilityPolicy
io.tarantool.pool.availability.heartbeat.DefaultAvailabilityPolicy --> io.tarantool.pool.HeartbeatOpts: opts
io.tarantool.pool.availability.heartbeat.DefaultAvailabilityPolicy --> io.tarantool.pool.availability.heartbeat.Utils: utils (set in configure)
io.tarantool.pool.availability.heartbeat.DefaultAvailabilityPolicy "1" o-- io.tarantool.pool.availability.heartbeat.HeartbeatStateMachine: entries (by PoolEntryView)
io.tarantool.pool.availability.heartbeat.DefaultAvailabilityPolicy ..> io.tarantool.pool.availability.heartbeat.HeartbeatStateMachine: <<create>>
io.tarantool.pool.availability.heartbeat.DefaultAvailabilityPolicy ..> io.tarantool.pool.availability.heartbeat.HeartbeatEvent$StartEvent: <<create>>
io.tarantool.pool.availability.heartbeat.DefaultAvailabilityPolicy ..> io.tarantool.pool.availability.heartbeat.HeartbeatEvent$StopEvent: <<create>>
io.tarantool.pool.availability.heartbeat.DefaultAvailabilityPolicy ..> io.tarantool.pool.availability.heartbeat.HeartbeatConstants: <<use>>
io.tarantool.pool.availability.heartbeat.DefaultAvailabilityPolicy ..> io.tarantool.pool.PoolEntryView: <<use>>
io.tarantool.pool.availability.heartbeat.DefaultAvailabilityPolicy ..> io.tarantool.pool.PoolEntryState: <<use>>
@enduml
Loading
Loading