Charles Chan | ff79dd9 | 2018-06-01 16:33:48 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2018-present Open Networking Foundation |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.net.host; |
| 17 | |
| 18 | import org.onlab.packet.MacAddress; |
| 19 | import org.onosproject.net.ConnectPoint; |
| 20 | import org.onosproject.net.Host; |
| 21 | |
| 22 | /** |
| 23 | * Information related to the host being probed. |
| 24 | */ |
| 25 | public interface HostProbe extends Host { |
| 26 | /** |
| 27 | * Gets connect point of this entry. |
| 28 | * |
| 29 | * @return connect point |
| 30 | */ |
| 31 | ConnectPoint connectPoint(); |
| 32 | |
| 33 | /** |
| 34 | * Gets retry counter of this entry. |
| 35 | * |
| 36 | * @return retry |
| 37 | */ |
| 38 | int retry(); |
| 39 | |
| 40 | /** |
| 41 | * Decrease retry counter of this entry by one. |
| 42 | */ |
| 43 | void decreaseRetry(); |
| 44 | |
| 45 | /** |
| 46 | * Gets mode of this entry. |
| 47 | * |
| 48 | * @return mode |
| 49 | */ |
| 50 | ProbeMode mode(); |
| 51 | |
| 52 | /** |
| 53 | * Gets probe MAC of this entry. |
| 54 | * |
| 55 | * @return probe mac |
| 56 | */ |
| 57 | MacAddress probeMac(); |
| 58 | } |