com.swirlds.common.wiring.WiringConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swirlds-common Show documentation

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

There is a newer version: 0.56.6

Show newest version

/*
 * Copyright (C) 2024 Hedera Hashgraph, LLC
 *
 * 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.
 */

package com.swirlds.common.wiring;

import com.swirlds.config.api.ConfigData;
import com.swirlds.config.api.ConfigProperty;
import java.time.Duration;

/**
 * Configuration for the wiring framework.
 *
 * @param healthMonitorEnabled           whether the health monitor is enabled
 * @param hardBackpressureEnabled        whether hard backpressure is enabled
 * @param defaultPoolMultiplier          used when calculating the size of the default platform fork join pool. Maximum
 *                                       parallelism in this pool is calculated as max(1, (defaultPoolMultiplier *
 *                                       [number of processors] + defaultPoolConstant)).
 * @param defaultPoolConstant            used when calculating the size of the default platform fork join pool. Maximum
 *                                       parallelism in this pool is calculated as max(1, (defaultPoolMultiplier *
 *                                       [number of processors] + defaultPoolConstant)). It is legal for this constant
 *                                       to be a negative number.
 * @param healthMonitorSchedulerCapacity the unhandled task capacity of the health monitor's scheduler
 * @param healthMonitorHeartbeatPeriod   the period between heartbeats sent to the health monitor
 * @param healthLogThreshold             the amount of time a scheduler may be unhealthy before the platform is
 *                                       considered to be unhealthy and starts to write log warnings
 * @param healthLogPeriod                the minimum amount of time that must pass between health log messages for the
 *                                       same scheduler
 */
@ConfigData("platform.wiring")
public record WiringConfig(
        @ConfigProperty(defaultValue = "true") boolean healthMonitorEnabled,
        @ConfigProperty(defaultValue = "false") boolean hardBackpressureEnabled,
        @ConfigProperty(defaultValue = "0") double defaultPoolMultiplier,
        @ConfigProperty(defaultValue = "8") int defaultPoolConstant,
        @ConfigProperty(defaultValue = "500") int healthMonitorSchedulerCapacity,
        @ConfigProperty(defaultValue = "100ms") Duration healthMonitorHeartbeatPeriod,
        @ConfigProperty(defaultValue = "1s") Duration healthLogThreshold,
        @ConfigProperty(defaultValue = "10m") Duration healthLogPeriod) {}