org.onosproject.incubator.net.tunnel

Interface Tunnel

All Superinterfaces:

Annotated, NetworkResource, Provided

All Known Implementing Classes:

DefaultTunnel

@Beta
public interface Tunnel
extends Annotated, Provided, NetworkResource

Abstraction of a generalized Tunnel entity (bandwidth pipe) for either L3/L2 networks or L1/L0 networks, representation of e.g., VLAN, GRE tunnel, MPLS LSP, L1 ODUk connection, WDM OCH, etc.. Each Tunnel is associated with at least two tunnel end point objects that model the logical ports essentially. Note that it supports nested case.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Tunnel.State Representation of the tunnel state.
static class	Tunnel.Type Tunnel technology type.

Method Summary

Modifier and Type	Method and Description
TunnelEndPoint	dst() the terminal of a tunnel.
GroupId	groupId() Returns group flow table id which a tunnel match up.
Path	path() Returns the path of the tunnel.
NetworkResource	resource() Network resource backing the tunnel, e.g.
TunnelEndPoint	src() the origin of a tunnel.
Tunnel.State	state() Returns the tunnel state.
TunnelId	tunnelId() Returns tunnel identify generated by ONOS as primary key.
TunnelName	tunnelName() Return the name of a tunnel.
Tunnel.Type	type() Returns the tunnel type.

Methods inherited from interface org.onosproject.net.Annotated

annotations

Methods inherited from interface org.onosproject.net.Provided

providerId

Method Detail

state

Tunnel.State state()

Returns the tunnel state.

Returns:

tunnel state

src

TunnelEndPoint src()

the origin of a tunnel.

Returns:

the origin of a tunnel

dst

TunnelEndPoint dst()

the terminal of a tunnel.

Returns:

the terminal of a tunnel

type

Tunnel.Type type()

Returns the tunnel type.

Returns:

tunnel type

groupId

GroupId groupId()

Returns group flow table id which a tunnel match up.

Returns:

OpenFlowGroupId

tunnelId

TunnelId tunnelId()

Returns tunnel identify generated by ONOS as primary key.

Returns:

TunnelId

tunnelName

TunnelName tunnelName()

Return the name of a tunnel.

Returns:

Tunnel Name

resource

NetworkResource resource()

Network resource backing the tunnel, e.g. lambda, VLAN id, MPLS tag.

Returns:

backing resource

path

Path path()

Returns the path of the tunnel.

Returns:

the path of the tunnel