org.onosproject.pcep.api

Interface PcepTunnel

All Superinterfaces:

PcepOperator

public interface PcepTunnel
extends PcepOperator

Abstraction of a generalized PCEP Tunnel entity (bandwidth pipe) for L2 networks or L1/L0 networks, representation of e.g., VLAN, L1 ODUk connection, WDM OCH, etc..

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PcepTunnel.Ability The ability of a tunnel.
static class	PcepTunnel.PathState Represents state of the path, work normally or broken down.
static class	PcepTunnel.PathType
static class	PcepTunnel.Type Describe the type of a tunnel.

Nested classes/interfaces inherited from interface org.onosproject.pcep.api.PcepOperator

PcepOperator.OperationType

Method Summary

Modifier and Type	Method and Description
long	bandWidth() Returns the bandwidth of a tunnel.
PcepDpid	dstDeviceId() Returns the device id of source endpoint of a tunnel.
long	dstPort() Returns destination port of a tunnel.
List<PcepHopNodeDescription>	getHopList() Returns the detail hop list of a tunnel.
int	getInstance() Returns the instance of a pcep tunnel,a instance is used to mark the times of a tunnel created.
PcepTunnel.PathState	getPathState() Returns the state of a path.
PcepTunnel.PathType	getPathType() Returns the path type of a path if the tunnel's ability is diamond .
PcepTunnel.Ability	getSla() Returns the ability of a tunnel.
long	id() Returns the tunnel id.
String	name() Returns the name of a tunnel.
PcepDpid	srcDeviceID() Returns the device id of destination endpoint of a tunnel.
long	srcPort() Returns source port of a tunnel.
PcepTunnel.Type	type() Returns the type of a tunnel.
long	underlayTunnelId() Get the under lay tunnel id of VLAN tunnel.

Methods inherited from interface org.onosproject.pcep.api.PcepOperator

getOperationType

Method Detail

type

PcepTunnel.Type type()

Returns the type of a tunnel.

Returns:

tunnel type

name

String name()

Returns the name of a tunnel.

Returns:

tunnel name

srcDeviceID

PcepDpid srcDeviceID()

Returns the device id of destination endpoint of a tunnel.

Returns:

device id

dstDeviceId

PcepDpid dstDeviceId()

Returns the device id of source endpoint of a tunnel.

Returns:

device id

srcPort

long srcPort()

Returns source port of a tunnel.

Returns:

port number

dstPort

long dstPort()

Returns destination port of a tunnel.

Returns:

port number

bandWidth

long bandWidth()

Returns the bandwidth of a tunnel.

Returns:

bandwidth

id

long id()

Returns the tunnel id.

Returns:

id of the PCEP tunnel

getHopList

List<PcepHopNodeDescription> getHopList()

Returns the detail hop list of a tunnel.

Returns:

hop list

getInstance

int getInstance()

Returns the instance of a pcep tunnel,a instance is used to mark the times of a tunnel created. instance and id identify a tunnel together.

Returns:

the instance of a tunnel.

getPathState

PcepTunnel.PathState getPathState()

Returns the state of a path.

Returns:

normal or broken

getSla

PcepTunnel.Ability getSla()

Returns the ability of a tunnel.

Returns:

ability of the tunenl

getPathType

PcepTunnel.PathType getPathType()

Returns the path type of a path if the tunnel's ability is diamond .

Returns:

the type of a path, the preferred or alternate.

underlayTunnelId

long underlayTunnelId()

Get the under lay tunnel id of VLAN tunnel.

Returns:

the tunnel id of a OCH tunnel under lay of a VLAN tunnel.