org.onosproject.net.behaviour

Interface PortAdmin

All Superinterfaces:

Behaviour, HandlerBehaviour

@Beta
public interface PortAdmin
extends HandlerBehaviour

Means to administratively enable,disable and query the state of a port on a device.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<java.lang.Boolean>	disable(PortNumber number) Disable administratively a port.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	enable(PortNumber number) Enable administratively a port.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	isEnabled(PortNumber number) Retrieves the information about the administrative state of a port.

Methods inherited from interface org.onosproject.net.driver.HandlerBehaviour

handler, setHandler

Methods inherited from interface org.onosproject.net.driver.Behaviour

data, setData

Method Detail

enable

java.util.concurrent.CompletableFuture<java.lang.Boolean> enable(PortNumber number)

Enable administratively a port.

Parameters:

number - the port to be enabled

Returns:

CompletableFuture with true if the operation was successful

disable

java.util.concurrent.CompletableFuture<java.lang.Boolean> disable(PortNumber number)

Disable administratively a port.

Parameters:

number - the port to be disabled

Returns:

CompletableFuture with true if the operation was successful

isEnabled

java.util.concurrent.CompletableFuture<java.lang.Boolean> isEnabled(PortNumber number)

Retrieves the information about the administrative state of a port.

Parameters:

number - identifier of the port to be queried about its state

Returns:

CompletableFuture containing, when completed, true if the port isEnabled.