Class 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.
    • Method Detail

      • 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