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 N3, or UE IP address pool (N6).

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, DEFAULT_APP_INDEX, DEFAULT_SESSION_INDEX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static UpfInterface.Builder`	`builder()`
`static UpfInterface`	`createDbufReceiverFrom(Ip4Address address, int sliceId)`	Create a dbuf-receiving UPF interface from the given IP address.
`static UpfInterface`	`createN3From(Ip4Address address, int sliceId)`	Create access-facing UPF Interface (N3) from the given address, which will be treated as a /32 prefix.
`static UpfInterface`	`createUePoolFrom(Ip4Prefix prefix, int sliceId)`	Create a core-facing UPF Interface (N6) 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.
`int`	`sliceId()`	Get the slice ID 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
  - createN3From
```
public static UpfInterface createN3From(Ip4Address address,
                                        int sliceId)
```
    Create access-facing UPF Interface (N3) from the given address, which will be treated as a /32 prefix.
    
    Parameters:
    
    address - the address of the new access-facing interface (N3 interface)
    
    sliceId - the slice id of the new interface
    
    Returns:
    
    a new UPF interface
  - createUePoolFrom
```
public static UpfInterface createUePoolFrom(Ip4Prefix prefix,
                                            int sliceId)
```
    Create a core-facing UPF Interface (N6) from the given IP prefix.
    
    Parameters:
    
    prefix - the prefix of the new core-facing interface (N6 interface)
    
    sliceId - the slice id of the new interface
    
    Returns:
    
    a new UPF interface
  - createDbufReceiverFrom
```
public static UpfInterface createDbufReceiverFrom(Ip4Address address,
                                                  int sliceId)
```
    Create a dbuf-receiving UPF interface from the given IP address.
    
    Parameters:
    
    address - the address of the dbuf-receiving interface
    
    sliceId - the slice id of the new interface
    
    Returns:
    
    a new UPF interface
  - prefix
```
public Ip4Prefix prefix()
```
    Get the IP prefix of this interface.
    
    Returns:
    
    the interface prefix
  - sliceId
```
public int sliceId()
```
    Get the slice ID of this interface.
    
    Returns:
    
    the slice ID
  - isAccess
```
public boolean isAccess()
```
    Check if this UPF interface is for packets traveling from UEs. This will be true for N3 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

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

Class UpfInterface

Nested Class Summary

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

toString

equals

hashCode

createN3From

createUePoolFrom

createDbufReceiverFrom

prefix

sliceId

isAccess

isCore

isDbufReceiver

getPrefix

type