org.onosproject.incubator.net.tunnel

Interface TunnelProvider

All Superinterfaces:

org.onosproject.net.provider.Provider

@Beta
public interface TunnelProvider
extends org.onosproject.net.provider.Provider

Abstraction of an entity providing tunnel setup/release services to the core.

Method Summary

Modifier and Type	Method and Description
void	releaseTunnel(org.onosproject.net.ElementId srcElement, Tunnel tunnel) Instructs the provider to release a tunnel given the respective device.
void	releaseTunnel(Tunnel tunnel) Instructs the provider to release a tunnel.
void	setupTunnel(org.onosproject.net.ElementId srcElement, Tunnel tunnel, org.onosproject.net.Path path) Instructs the provider to setup a tunnel given the respective device.
void	setupTunnel(Tunnel tunnel, org.onosproject.net.Path path) Instructs the provider to setup a tunnel.
TunnelId	tunnelAdded(TunnelDescription tunnel) Signals that the provider has added a tunnel.
Tunnel	tunnelQueryById(TunnelId tunnelId) Signals that the a tunnel was queried.
void	tunnelRemoved(TunnelDescription tunnel) Signals that the provider has removed a tunnel.
void	tunnelUpdated(TunnelDescription tunnel) Signals that the a tunnel was changed (e.g., sensing changes of tunnel).It's used by producers.
void	updateTunnel(org.onosproject.net.ElementId srcElement, Tunnel tunnel, org.onosproject.net.Path path) Instructs the provider to update a tunnel given the respective device.
void	updateTunnel(Tunnel tunnel, org.onosproject.net.Path path) Instructs the provider to update a tunnel.

Methods inherited from interface org.onosproject.net.provider.Provider

id

Method Detail

setupTunnel

void setupTunnel(Tunnel tunnel,
                 org.onosproject.net.Path path)

Instructs the provider to setup a tunnel. It's used by consumers.

Parameters:

tunnel - Tunnel

path - explicit route or null for the tunnel

setupTunnel

void setupTunnel(org.onosproject.net.ElementId srcElement,
                 Tunnel tunnel,
                 org.onosproject.net.Path path)

Instructs the provider to setup a tunnel given the respective device. It's used by consumers.

Parameters:

srcElement - device

tunnel - Tunnel

path - explicit route (not null) for the tunnel

releaseTunnel

void releaseTunnel(Tunnel tunnel)

Instructs the provider to release a tunnel. It's used by consumers.

Parameters:

tunnel - Tunnel

releaseTunnel

void releaseTunnel(org.onosproject.net.ElementId srcElement,
                   Tunnel tunnel)

Instructs the provider to release a tunnel given the respective device. It's used by consumers.

Parameters:

srcElement - device

tunnel - Tunnel

updateTunnel

void updateTunnel(Tunnel tunnel,
                  org.onosproject.net.Path path)

Instructs the provider to update a tunnel. It's used by consumers. Maybe some consumers enable to update a tunnel.

Parameters:

tunnel - Tunnel

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

updateTunnel

void updateTunnel(org.onosproject.net.ElementId srcElement,
                  Tunnel tunnel,
                  org.onosproject.net.Path path)

Instructs the provider to update a tunnel given the respective device. It's used by consumers. Maybe some consumers enable to update a tunnel.

Parameters:

srcElement - device

tunnel - Tunnel

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

tunnelAdded

TunnelId tunnelAdded(TunnelDescription tunnel)

Signals that the provider has added a tunnel. It's used by producers.

Parameters:

tunnel - tunnel information

Returns:

tunnel identity

tunnelRemoved

void tunnelRemoved(TunnelDescription tunnel)

Signals that the provider has removed a tunnel. It's used by producers.

Parameters:

tunnel - tunnel information

tunnelUpdated

void tunnelUpdated(TunnelDescription tunnel)

Signals that the a tunnel was changed (e.g., sensing changes of tunnel).It's used by producers.

Parameters:

tunnel - tunnel information

tunnelQueryById

Tunnel tunnelQueryById(TunnelId tunnelId)

Signals that the a tunnel was queried. It's used by producers.

Parameters:

tunnelId - tunnel identity

Returns:

tunnel entity