/*
 * Copyright 2018-present Open Networking Foundation
 *
 * 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.
 */
/*
  Defines a logicalDeviceAgent Interface - Used for unit testing of the flow decomposer only at this
 time.
*/

package coreif

import (
	"context"
	"github.com/opencord/voltha-go/rw_core/route"
	"github.com/opencord/voltha-protos/v3/go/voltha"
)

// LogicalDeviceAgent represents a generic agent
type LogicalDeviceAgent interface {
	GetDeviceRoutes() *route.DeviceRoutes
	GetLogicalDevice(ctx context.Context) (*voltha.LogicalDevice, error)
	GetWildcardInputPorts(ctx context.Context, excludePort uint32) map[uint32]struct{}
	GetRoute(ctx context.Context, ingressPortNo uint32, egressPortNo uint32) ([]route.Hop, error)
	GetNNIPorts() map[uint32]struct{}
}