Package org.onosproject.net.behaviour.upf

Class UpfInterface

java.lang.Object

org.onosproject.net.behaviour.upf.UpfInterface

All Implemented Interfaces:

UpfEntity

@Beta
public final class UpfInterface
extends Object
implements UpfEntity

A UPF device interface, such as a S1U or UE IP address pool.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpfInterface.Builder
static class	UpfInterface.Type

Field Summary

Fields inherited from interface org.onosproject.net.behaviour.upf.UpfEntity

DEFAULT_APP_ID

Method Summary

Modifier and Type	Method	Description
static UpfInterface.Builder	builder()
static UpfInterface	createDbufReceiverFrom(Ip4Address address)	Create a dbuf-receiving UPF interface from the given IP address.
static UpfInterface	createS1uFrom(Ip4Address address)	Create a core-facing UPF Interface from the given address, which will be treated as a /32 prefix.
static UpfInterface	createUePoolFrom(Ip4Prefix prefix)	Create a core-facing UPF Interface from the given IP prefix.
boolean	equals(Object obj)
Ip4Prefix	getPrefix()	Get the IPv4 prefix of this UPF interface.
int	hashCode()
boolean	isAccess()	Check if this UPF interface is for packets traveling from UEs.
boolean	isCore()	Check if this UPF interface is for packets traveling towards UEs.
boolean	isDbufReceiver()	Check if this UPF interface is for receiving buffered packets as they are released from the dbuf buffering device.
Ip4Prefix	prefix()	Get the IP prefix of this interface.
String	toString()
UpfEntityType	type()	Returns the type of this entity.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static UpfInterface.Builder builder()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

createS1uFrom

public static UpfInterface createS1uFrom(Ip4Address address)

Create a core-facing UPF Interface from the given address, which will be treated as a /32 prefix.

Parameters:

address - the address of the new core-facing interface

Returns:

a new UPF interface

createUePoolFrom

public static UpfInterface createUePoolFrom(Ip4Prefix prefix)

Create a core-facing UPF Interface from the given IP prefix.

Parameters:

prefix - the prefix of the new core-facing interface

Returns:

a new UPF interface

createDbufReceiverFrom

public static UpfInterface createDbufReceiverFrom(Ip4Address address)

Create a dbuf-receiving UPF interface from the given IP address.

Parameters:

address - the address of the dbuf-receiving interface

Returns:

a new UPF interface

prefix

public Ip4Prefix prefix()

Get the IP prefix of this interface.

Returns:

the interface prefix

isAccess

public boolean isAccess()

Check if this UPF interface is for packets traveling from UEs. This will be true for S1U interface table entries.

Returns:

true if interface receives from access

isCore

public boolean isCore()

Check if this UPF interface is for packets traveling towards UEs. This will be true for UE IP address pool table entries.

Returns:

true if interface receives from core

isDbufReceiver

public boolean isDbufReceiver()

Check if this UPF interface is for receiving buffered packets as they are released from the dbuf buffering device.

Returns:

true if interface receives from dbuf

getPrefix

public Ip4Prefix getPrefix()

Get the IPv4 prefix of this UPF interface.

Returns:

the interface prefix

type

public UpfEntityType type()

Description copied from interface: UpfEntity

Returns the type of this entity.

Specified by:

type in interface UpfEntity

Returns:

entity type