github.com/mysteriumnetwork/node@v0.0.0-20240516044423-365054f76801/services/wireguard/endpoint.go (about)

     1  /*
     2   * Copyright (C) 2018 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 wireguard
    19  
    20  import (
    21  	"github.com/mysteriumnetwork/node/services/wireguard/wgcfg"
    22  )
    23  
    24  // EndpointFactory creates new connection endpoint.
    25  type EndpointFactory func() (ConnectionEndpoint, error)
    26  
    27  // ConnectionEndpoint represents Wireguard network instance, it provide information
    28  // required for establishing connection between service provider and consumer.
    29  type ConnectionEndpoint interface {
    30  	StartConsumerMode(config wgcfg.DeviceConfig) error
    31  	ReconfigureConsumerMode(config wgcfg.DeviceConfig) error
    32  	StartProviderMode(publicIP string, config wgcfg.DeviceConfig) error
    33  	PeerStats() (wgcfg.Stats, error)
    34  	Config() (ServiceConfig, error)
    35  	InterfaceName() string
    36  	Stop() error
    37  }