org.onosproject.incubator.net.tunnel

Interface TunnelDescription

All Superinterfaces:

org.onosproject.net.Annotated, org.onosproject.net.Description

All Known Implementing Classes:

DefaultTunnelDescription

@Beta
public interface TunnelDescription
extends org.onosproject.net.Description, org.onosproject.net.Annotated

Describes a tunnel.

Method Summary

Modifier and Type	Method and Description
TunnelEndPoint	dst() Returns the connection point destination.
org.onosproject.core.GroupId	groupId() Returns group flow table id which a tunnel match up.
TunnelId	id() Returns the tunnel id.
org.onosproject.net.Path	path() Returns the path of the tunnel.
org.onosproject.net.provider.ProviderId	producerName() Returns tunnel producer name.
org.onosproject.net.NetworkResource	resource() Returns the network resource backing the tunnel, e.g.
TunnelEndPoint	src() Returns the connection point source.
TunnelName	tunnelName() Return the name of a tunnel.
Tunnel.Type	type() Returns the tunnel type.

Methods inherited from interface org.onosproject.net.Description

annotations

Method Detail

id

TunnelId id()

Returns the tunnel id.

Returns:

tunnelId

src

TunnelEndPoint src()

Returns the connection point source.

Returns:

tunnel source ConnectionPoint

dst

TunnelEndPoint dst()

Returns the connection point destination.

Returns:

tunnel destination

type

Tunnel.Type type()

Returns the tunnel type.

Returns:

tunnel type

groupId

org.onosproject.core.GroupId groupId()

Returns group flow table id which a tunnel match up.

Returns:

OpenFlowGroupId

producerName

org.onosproject.net.provider.ProviderId producerName()

Returns tunnel producer name.

Returns:

producer name

tunnelName

TunnelName tunnelName()

Return the name of a tunnel.

Returns:

Tunnel Name

path

org.onosproject.net.Path path()

Returns the path of the tunnel.

Returns:

the path of the tunnel

resource

org.onosproject.net.NetworkResource resource()

Returns the network resource backing the tunnel, e.g. lambda, VLAN id, MPLS tag, label stack.

Returns:

backing resource