io.vertx.kotlin.core.net.TrafficShapingOptions.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-lang-kotlin Show documentation
There is a newer version: 5.0.0.CR1
/*
 * Copyright 2019 Red Hat, Inc.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Apache License v2.0 which accompanies this distribution.
 *
 * The Eclipse Public License is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * The Apache License v2.0 is available at
 * http://www.opensource.org/licenses/apache2.0.php
 *
 * You may elect to redistribute this code under either of these licenses.
 */
package io.vertx.kotlin.core.net

import io.vertx.core.net.TrafficShapingOptions
import java.util.concurrent.TimeUnit

/**
 * A function providing a DSL for building [io.vertx.core.net.TrafficShapingOptions] objects.
 *
 * Options describing how [io.netty.handler.traffic.GlobalTrafficShapingHandler] will handle traffic shaping.
 *
 * @param inboundGlobalBandwidth  Set bandwidth limit in bytes per second for inbound connections
 * @param outboundGlobalBandwidth  Set bandwidth limit in bytes per second for outbound connections
 * @param maxDelayToWait  Set the maximum delay to wait in case of traffic excess
 * @param maxDelayToWaitUnit  Set the maximum delay to wait time unit
 * @param checkIntervalForStats  Set the delay between two computations of performances for channels
 * @param checkIntervalForStatsTimeUnit  Set time unit for check interval for stats.
 * @param peakOutboundGlobalBandwidth  Set the maximum global write size in bytes per second allowed in the buffer globally for all channels before write suspended is set. Default value is 400 MB
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.core.net.TrafficShapingOptions original] using Vert.x codegen.
 */
fun trafficShapingOptionsOf(
  inboundGlobalBandwidth: Long? = null,
  outboundGlobalBandwidth: Long? = null,
  maxDelayToWait: Long? = null,
  maxDelayToWaitUnit: TimeUnit? = null,
  checkIntervalForStats: Long? = null,
  checkIntervalForStatsTimeUnit: TimeUnit? = null,
  peakOutboundGlobalBandwidth: Long? = null): TrafficShapingOptions = io.vertx.core.net.TrafficShapingOptions().apply {

  if (inboundGlobalBandwidth != null) {
    this.setInboundGlobalBandwidth(inboundGlobalBandwidth)
  }
  if (outboundGlobalBandwidth != null) {
    this.setOutboundGlobalBandwidth(outboundGlobalBandwidth)
  }
  if (maxDelayToWait != null) {
    this.setMaxDelayToWait(maxDelayToWait)
  }
  if (maxDelayToWaitUnit != null) {
    this.setMaxDelayToWaitUnit(maxDelayToWaitUnit)
  }
  if (checkIntervalForStats != null) {
    this.setCheckIntervalForStats(checkIntervalForStats)
  }
  if (checkIntervalForStatsTimeUnit != null) {
    this.setCheckIntervalForStatsTimeUnit(checkIntervalForStatsTimeUnit)
  }
  if (peakOutboundGlobalBandwidth != null) {
    this.setPeakOutboundGlobalBandwidth(peakOutboundGlobalBandwidth)
  }
}