/*
 * 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.
 */
package org.onosproject.openstacktroubleshoot.api;

import org.onosproject.openstacknetworking.api.InstancePort;

/**
 * Openstack troubleshoot interface.
 */
public interface OpenstackTroubleshootService {

    /**
     * Troubleshoot traffic direction.
     */
    enum Direction {

        /**
         * Signifies that EAST_WEST troubleshoot case.
         */
        EAST_WEST,

        /**
         * Signifies that NORTH_SOUTH troubleshoot case.
         */
        NORTH_SOUTH,
    }

    /**
     * Checks a single VM-to-Vm connectivity.
     *
     * @param srcInstancePort source instance port
     * @param dstInstancePort destination instance port
     * @return reachability
     */
    Reachability probeEastWest(InstancePort srcInstancePort,
                               InstancePort dstInstancePort);

    /**
     * Checks a single router-to-VM connectivity.
     *
     * @param dstInstancePort destination instance port
     * @return reachability
     */
    Reachability probeNorthSouth(InstancePort dstInstancePort);
}