SwiftyPing

1.2.1

ICMP ping client for Swift 5
samiyr/SwiftyPing

What's New

v1.2.1

2021-06-09T07:13:51Z
  • Fix a crash when sending more than 65535 pings (thanks to @Kususumu)
  • Overall better handling of sequence indices. All the functions and result structs now use the appropriate integer types. This may be a breaking change if you depend on those values being Int types.
  • There's a new trueSequenceNumber in PingResponse and a similar private variable in SwiftyPing, which is now returned by currentCount. trueSequenceNumber is an UInt64, which will probably never overflow. This keeps track of the actual number of pings sent, even when sequenceNumber, which is just an UInt16, has overflowed and been wrapped back to 0.

SwiftyPing

ICMP ping client for Swift 5

SwiftyPing is an easy-to-use, one file ICMP ping client

This project is based on SwiftPing: https://github.com/ankitthakur/SwiftPing.

Usage

// Ping indefinitely
let pinger = try? SwiftyPing(host: "1.1.1.1", configuration: PingConfiguration(interval: 0.5, with: 5), queue: DispatchQueue.global())
pinger?.observer = { (response) in
    let duration = response.duration
    print(duration)
}
try? pinger?.startPinging()

// Ping once
let once = try? SwiftyPing(host: "1.1.1.1", configuration: PingConfiguration(interval: 0.5, with: 5), queue: DispatchQueue.global())
once?.observer = { (response) in
    let duration = response.duration
    print(duration)
}
once?.targetCount = 1
try? once?.startPinging()

Installation

Just drop the SwiftyPing.swift file to your project. Using SwiftyPing for a Mac application requires allowing Network->Incoming Connections and Network->Outgoing Connections in the application sandbox.

You can also use Swift Package Manager:

.Package(url: "https://github.com/samiyr/SwiftyPing.git", branch: "master")

Future development and contributions

I made this project based on what I need, so I probably won't be adding any features unless I really need them. I will maintain it (meaning bug fixes and support for new Swift versions) for some time at least. However, you can submit a pull request and I'll take a look. Please try to keep the overall coding style.

Caveats

This is low-level code, basically C code translated to Swift. This means that there are unsafe casts from raw bytes to Swift structs, for which Swift's usual type safety checks no longer apply. These can fail ungracefully (throwing an exception), and may even be used as an exploit (I'm not a security researcher and thus don't have the expertise to say for sure), so use with caution, especially if pinging untrusted hosts.

Also, while I think that the API is now stable, I don't make any guarantees – some new version might break old stuff.

License

Use pretty much however you want. Officially licensed under MIT.

Description

  • Swift Tools 5.2.0
View More Packages from this Author

Dependencies

  • None
Last updated: Sat Nov 23 2024 17:28:43 GMT-1000 (Hawaii-Aleutian Standard Time)