github.com/mysteriumnetwork/node@v0.0.0-20240516044423-365054f76801/core/shaper/bootstrap.go (about)

     1  /*
     2   * Copyright (C) 2019 The "MysteriumNetwork/node" Authors.
     3   *
     4   * This program is free software: you can redistribute it and/or modify
     5   * it under the terms of the GNU General Public License as published by
     6   * the Free Software Foundation, either version 3 of the License, or
     7   * (at your option) any later version.
     8   *
     9   * This program is distributed in the hope that it will be useful,
    10   * but WITHOUT ANY WARRANTY; without even the implied warranty of
    11   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    12   * GNU General Public License for more details.
    13   *
    14   * You should have received a copy of the GNU General Public License
    15   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    16   */
    17  
    18  package shaper
    19  
    20  // Shaper shapes traffic on a network interface.
    21  type Shaper interface {
    22  	// Start applies shaping configuration on the specified interface and then continuously ensures it.
    23  	Start(interfaceName string) error
    24  	// Clear clears shaping rules.
    25  	Clear(interfaceName string)
    26  }
    27  
    28  type eventListener interface {
    29  	SubscribeAsync(topic string, fn interface{}) error
    30  }
    31  
    32  // New creates a traffic shaper (linux) or no-op.
    33  func New(listener eventListener) (shaper Shaper) {
    34  	return create(listener)
    35  }