Package org.onosproject.net.host

Class InterfaceIpAddress

  • public class InterfaceIpAddress
extends java.lang.Object
    Represents a single IP address information on an interface. TODO: - Add computation for the default broadcast address if it is not specified - Add explicit checks that each IP address or prefix belong to the same IP version: IPv4/IPv6. - Inside the copy constructor we should use copy constructors for each field

    • Constructor Summary

      Constructors 
      Constructor Description
      InterfaceIpAddress​(org.onlab.packet.IpAddress ipAddress, org.onlab.packet.IpPrefix subnetAddress)
      Constructor for a given IP address and a subnet address.
      InterfaceIpAddress​(org.onlab.packet.IpAddress ipAddress, org.onlab.packet.IpPrefix subnetAddress, org.onlab.packet.IpAddress broadcastAddress)
      Constructor for a given IP address and a subnet address.
      InterfaceIpAddress​(org.onlab.packet.IpAddress ipAddress, org.onlab.packet.IpPrefix subnetAddress, org.onlab.packet.IpAddress broadcastAddress, org.onlab.packet.IpAddress peerAddress)
      Constructor for a given IP address and a subnet address.
      InterfaceIpAddress​(InterfaceIpAddress other)
      Copy constructor.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.onlab.packet.IpAddress broadcastAddress()
      Gets the subnet IP broadcast address.
      static org.onlab.packet.IpAddress computeBroadcastAddress​(org.onlab.packet.IpAddress ipAddress, org.onlab.packet.IpPrefix subnetAddress)
      Compute the IP broadcast address.
      boolean equals​(java.lang.Object other)  
      int hashCode()  
      org.onlab.packet.IpAddress ipAddress()
      Gets the IP address.
      org.onlab.packet.IpAddress peerAddress()
      Gets the IP point-to-point interface peer address.
      org.onlab.packet.IpPrefix subnetAddress()
      Gets the IP subnet address.
      java.lang.String toString()  
      static InterfaceIpAddress valueOf​(java.lang.String value)
      Converts a CIDR string literal to an interface IP address.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • InterfaceIpAddress

        public InterfaceIpAddress​(InterfaceIpAddress other)
        Copy constructor.
        Parameters:
        other - the object to copy from

      • InterfaceIpAddress

        public InterfaceIpAddress​(org.onlab.packet.IpAddress ipAddress,
                          org.onlab.packet.IpPrefix subnetAddress)
        Constructor for a given IP address and a subnet address.
        Parameters:
        ipAddress - the IP address
        subnetAddress - the IP subnet address

      • InterfaceIpAddress

        public InterfaceIpAddress​(org.onlab.packet.IpAddress ipAddress,
                          org.onlab.packet.IpPrefix subnetAddress,
                          org.onlab.packet.IpAddress broadcastAddress)
        Constructor for a given IP address and a subnet address.
        Parameters:
        ipAddress - the IP address
        subnetAddress - the IP subnet address
        broadcastAddress - the IP broadcast address. It can be used to specify non-default broadcast address

      • InterfaceIpAddress

        public InterfaceIpAddress​(org.onlab.packet.IpAddress ipAddress,
                          org.onlab.packet.IpPrefix subnetAddress,
                          org.onlab.packet.IpAddress broadcastAddress,
                          org.onlab.packet.IpAddress peerAddress)
        Constructor for a given IP address and a subnet address.
        Parameters:
        ipAddress - the IP address
        subnetAddress - the IP subnet address
        broadcastAddress - the IP broadcast address. It can be used to specify non-default broadcast address. It should be null for point-to-point interfaces with a peer address
        peerAddress - the peer IP address for point-to-point interfaces

    • Method Detail

      • ipAddress

        public org.onlab.packet.IpAddress ipAddress()
        Gets the IP address.
        Returns:
        the IP address

      • subnetAddress

        public org.onlab.packet.IpPrefix subnetAddress()
        Gets the IP subnet address.
        Returns:
        the IP subnet address

      • broadcastAddress

        public org.onlab.packet.IpAddress broadcastAddress()
        Gets the subnet IP broadcast address.
        Returns:
        the subnet IP broadcast address

      • peerAddress

        public org.onlab.packet.IpAddress peerAddress()
        Gets the IP point-to-point interface peer address.
        Returns:
        the IP point-to-point interface peer address

      • valueOf

        public static InterfaceIpAddress valueOf​(java.lang.String value)
        Converts a CIDR string literal to an interface IP address. E.g. 10.0.0.1/24
        Parameters:
        value - an IP address value in string form
        Returns:
        an interface IP address
        Throws:
        java.lang.IllegalArgumentException - if the argument is invalid

      • computeBroadcastAddress

        public static org.onlab.packet.IpAddress computeBroadcastAddress​(org.onlab.packet.IpAddress ipAddress,
                                                                 org.onlab.packet.IpPrefix subnetAddress)
        Compute the IP broadcast address.
        Parameters:
        ipAddress - base IP address
        subnetAddress - subnet specification
        Returns:
        the IP broadcast address

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object