https://github.com/svdo/swift-netutils

Swift library that simplifies getting information about your network interfaces and their properties, both for iOS and OS X.
https://github.com/svdo/swift-netutils

carthage cocoapods ios macos networking swift swift-library swift-package-manager

Last synced: 7 months ago
JSON representation

Swift library that simplifies getting information about your network interfaces and their properties, both for iOS and OS X.

• Host: GitHub
• URL: https://github.com/svdo/swift-netutils
• Owner: svdo
• License: mit
• Created: 2015-05-01T19:23:55.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2022-07-25T19:56:49.000Z (almost 3 years ago)
• Last Synced: 2024-12-10T04:10:25.270Z (7 months ago)
• Topics: carthage, cocoapods, ios, macos, networking, swift, swift-library, swift-package-manager
• Language: Swift
• Homepage: http://svdo.github.io/swift-netutils/
• Size: 814 KB
• Stars: 112
• Watchers: 10
• Forks: 22
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# NetUtils for Swift

![Swift Version 4](https://img.shields.io/badge/Swift-v4-yellow.svg)

![Swift Version 5](https://img.shields.io/badge/Swift-v5-yellow.svg)

[![CocoaPods Version Badge](https://img.shields.io/cocoapods/v/NetUtils.svg)](https://cocoapods.org/pods/NetUtils)

[![License Badge](https://img.shields.io/cocoapods/l/NetUtils.svg)](LICENSE.txt)

![Supported Platforms](https://img.shields.io/badge/platform-ios%20%7C%20macos%20%7C%20linux-lightgrey.svg)

[![Percentage Documented Badge](http://svdo.github.io/swift-netutils/badge.svg)](http://svdo.github.io/swift-netutils/)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

[![Swift Package Manager compatible](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager)

[![Swift Build](https://github.com/svdo/swift-netutils/actions/workflows/swift-package.yml/badge.svg)](https://github.com/svdo/swift-netutils/actions/workflows/swift-package.yml)

[![Xcode Build](https://github.com/svdo/swift-netutils/actions/workflows/objective-c-xcode.yml/badge.svg)](https://github.com/svdo/swift-netutils/actions/workflows/objective-c-xcode.yml)

[![Join the chat at https://gitter.im/NetUtils-for-Swift/Lobby](https://badges.gitter.im/NetUtils-for-Swift/Lobby.svg)](https://gitter.im/NetUtils-for-Swift/Lobby)

Swift library that simplifies getting information about your network interfaces

and their properties, both for iOS, macOS and Linux. This library is a wrapper

around the BSD APIs like `getifaddrs`, to make it easy to use them from Swift.

Recommended way of integrating this library on macOS or iOS is using CocoaPods:

https://cocoapods.org/pods/NetUtils. On Linux I recommend using the Swift

Package Manager.

This library works with both Swift 4 and Swift 5.

## Background Info

Some system APIs you can simply use from Swift, but others you cannot. The

difference is that some are made available as a module, and some are not. The

APIs around network interfaces are not exposed as a module, which means that you

cannot use them from Swift without defining a module for them yourself. I

documented this problem extensively [in a blog post][blog-post].

## Installation

This library can be installed via CocoaPods, Carthage and Swift Package Manager.

## Usage

This module contains only one class: `Interface`. This class represents a

network interface. It has a static method to list all interfaces, somewhat

surprisingly called `allInterfaces()`. This will return an array of `Interface`

objects, which contain properties like their IP address, family, whether they

are up and running, etc.

Please note that both IPv4 and IPv6 interfaces are supported.

## License

This project is released under the [MIT license](LICENSE.txt).

[blog-post]: https://medium.com/@stefanvdoord/using-system-headers-in-swift-8731e972adfe