org.onosproject.incubator.net.tunnel

Interface TunnelAdminService

@Beta
public interface TunnelAdminService

Service for administering the inventory of provisioned tunnels.

Method Summary

Modifier and Type	Method and Description
void	removeTunnel(TunnelId tunnelId) Removes the provisioned tunnel.
void	removeTunnels(TunnelEndPoint src, TunnelEndPoint dst, ProviderId producerName) Removes the provisioned tunnel leading to and from the specified labels.
void	removeTunnels(TunnelEndPoint src, TunnelEndPoint dst, Tunnel.Type type, ProviderId producerName) Removes all provisioned tunnels leading to and from the specified connection point.
void	updateTunnel(Tunnel tunnel, Path path) Invokes the core to update a tunnel based on specified tunnel parameters.
void	updateTunnelState(Tunnel tunnel, Tunnel.State state) Updates the state of a tunnel.

Method Detail

removeTunnel

void removeTunnel(TunnelId tunnelId)

Removes the provisioned tunnel.

Parameters:

tunnelId - tunnel ID

removeTunnels

void removeTunnels(TunnelEndPoint src,
                   TunnelEndPoint dst,
                   ProviderId producerName)

Removes the provisioned tunnel leading to and from the specified labels.

Parameters:

src - source label

dst - destination label

producerName - producer name

removeTunnels

void removeTunnels(TunnelEndPoint src,
                   TunnelEndPoint dst,
                   Tunnel.Type type,
                   ProviderId producerName)

Removes all provisioned tunnels leading to and from the specified connection point.

Parameters:

src - source connection point

dst - destination connection point

type - tunnel type

producerName - producer name

updateTunnel

void updateTunnel(Tunnel tunnel,
                  Path path)

Invokes the core to update a tunnel based on specified tunnel parameters.

Parameters:

tunnel - Tunnel

path - explicit route (path changed) or null (path not changed) for the tunnel

updateTunnelState

void updateTunnelState(Tunnel tunnel,
                       Tunnel.State state)

Updates the state of a tunnel.

Parameters:

tunnel - tunnel to be changed

state - new state of the tunnel