org.onosproject.incubator.net.tunnel

Class TunnelSubscription

java.lang.Object

org.onosproject.net.AbstractAnnotated

org.onosproject.incubator.net.tunnel.TunnelSubscription

All Implemented Interfaces:

org.onosproject.net.Annotated

@Beta
public final class TunnelSubscription
extends org.onosproject.net.AbstractAnnotated

Represents for a order that consumer subscribe tunnel. ONOS maintains request information, it means ONOS knows how much resource echo consumer uses in the ONOS. Although there is no a tunnel that consumer want to use, when producer creates a new tunnel, ONOS will notify the consumers that want to use it.

Constructor Summary

Constructors

Constructor and Description
TunnelSubscription(org.onosproject.core.ApplicationId consumerId, TunnelEndPoint src, TunnelEndPoint dst, TunnelId tunnelId, Tunnel.Type type, TunnelName tunnelName, org.onosproject.net.Annotations... annotations) Creates a TunnelSubscription.

Method Summary

Modifier and Type	Method and Description
org.onosproject.core.ApplicationId	consumerId() Returns consumer identity.
TunnelEndPoint	dst() Returns destination point of tunnel.
boolean	equals(Object obj)
int	hashCode()
TunnelEndPoint	src() Returns source point of tunnel.
String	toString()
TunnelId	tunnelId() Returns tunnel identity.
TunnelName	tunnelName() Returns tunnel name.
Tunnel.Type	type() Returns tunnel type.

Methods inherited from class org.onosproject.net.AbstractAnnotated

annotations

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TunnelSubscription

public TunnelSubscription(org.onosproject.core.ApplicationId consumerId,
                          TunnelEndPoint src,
                          TunnelEndPoint dst,
                          TunnelId tunnelId,
                          Tunnel.Type type,
                          TunnelName tunnelName,
                          org.onosproject.net.Annotations... annotations)

Creates a TunnelSubscription.

Parameters:

consumerId - consumer identity

src - source tunnel end point of tunnel

dst - destination tunnel end point of tunnel

tunnelId - tunnel identity

type - tunnel type

tunnelName - the name of a tunnel

annotations - parameter

Method Detail

consumerId

public org.onosproject.core.ApplicationId consumerId()

Returns consumer identity.

Returns:

consumerId consumer id

src

public TunnelEndPoint src()

Returns source point of tunnel.

Returns:

source point

dst

public TunnelEndPoint dst()

Returns destination point of tunnel.

Returns:

destination point

type

public Tunnel.Type type()

Returns tunnel type.

Returns:

tunnel type

tunnelId

public TunnelId tunnelId()

Returns tunnel identity.

Returns:

tunnel id

tunnelName

public TunnelName tunnelName()

Returns tunnel name.

Returns:

tunnel name

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object