Interface

open class Interface : CustomStringConvertible, CustomDebugStringConvertible

This class represents a network interface in your system. For example, en0 with a certain IP address. It is a wrapper around the getifaddrs system call.

Typical use of this class is to first call Interface.allInterfaces() and then use the properties of the interface(s) that you need.

See

/usr/include/ifaddrs.h
Show on GitHub
  • id

    Undocumented

    Declaration

    Swift

    public var id: UUID
    Show on GitHub

  • The network interface family (IPv4 or IPv6).

    See more

    Declaration

    Swift

    public enum Family : Int
    Show on GitHub

  • Returns all network interfaces in your system. If you have an interface name (e.g. en0) that has multiple IP addresses (e.g. one IPv4 address and a few IPv6 addresses), then they will be returned as separate instances of Interface.

    Declaration

    Swift

    public static func allInterfaces() -> [Interface]

    Return Value

    An array containing all network interfaces in your system.

    Show on GitHub

  • Returns a new Interface instance that does not represent a real network interface, but can be used for (unit) testing.

    Declaration

    Swift

    public static func createTestDummy(_ name: String, family: Family, address: String, multicastSupported: Bool, broadcastAddress: String?) -> Interface

    Return Value

    An instance of Interface that does not represent a real network interface.

    Show on GitHub

  • Initialize a new Interface with the given properties.

    Declaration

    Swift

    public init(name: String, family: Family, address: String?, netmask: String?, running: Bool, up: Bool, loopback: Bool, multicastSupported: Bool, broadcastAddress: String?)
    Show on GitHub

  • Creates the network format representation of the interface’s IP address. Wraps inet_pton.

    Declaration

    Swift

    open var addressBytes: [UInt8]? { get }
    Show on GitHub

  • IFF_RUNNING flag of ifaddrs->ifa_flags.

    Declaration

    Swift

    open var isRunning: Bool { get }
    Show on GitHub

  • IFF_UP flag of ifaddrs->ifa_flags.

    Declaration

    Swift

    open var isUp: Bool { get }
    Show on GitHub

  • IFF_LOOPBACK flag of ifaddrs->ifa_flags.

    Declaration

    Swift

    open var isLoopback: Bool { get }
    Show on GitHub

  • IFF_MULTICAST flag of ifaddrs->ifa_flags.

    Declaration

    Swift

    open var supportsMulticast: Bool { get }
    Show on GitHub

  • Field ifaddrs->ifa_name.

    Declaration

    Swift

    public let name: String
    Show on GitHub

  • Field ifaddrs->ifa_addr->sa_family.

    Declaration

    Swift

    public let family: Family
    Show on GitHub

  • Extracted from ifaddrs->ifa_addr, supports both IPv4 and IPv6.

    Declaration

    Swift

    public let address: String?
    Show on GitHub

  • Extracted from ifaddrs->ifa_netmask, supports both IPv4 and IPv6.

    Declaration

    Swift

    public let netmask: String?
    Show on GitHub

  • Extracted from ifaddrs->ifa_dstaddr. Not applicable for IPv6.

    Declaration

    Swift

    public let broadcastAddress: String?
    Show on GitHub

  • Returns the interface name.

    Declaration

    Swift

    open var description: String { get }
    Show on GitHub

  • Returns a string containing a few properties of the Interface.

    Declaration

    Swift

    open var debugDescription: String { get }
    Show on GitHub