// Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License"). You may
// not use this file except in compliance with the License. A copy of the
// License is located at
//
//     http://aws.amazon.com/apache2.0/
//
// or in the "license" file accompanying this file. This file 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 eni

import (
	"net"

	"github.com/aws/amazon-vpc-cni-plugins/network/netns"
)

// API interface abstracts a generic EC2 VPC Elastic Network Interface (ENI).
// https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html
type API interface {
	GetLinkIndex() int
	GetLinkName() string
	GetMACAddress() net.HardwareAddr

	AttachToLink() error
	DetachFromLink() error

	SetLinkName(name string) error
	SetLinkMTU(mtu uint) error
	SetOpState(up bool) error
	SetNetNS(ns netns.NetNS) error
	SetMACAddress(address net.HardwareAddr) error
	AddIPAddress(address *net.IPNet) error
	DeleteIPAddress(address *net.IPNet) error
}