Currents 0.2

Currents 0.2

TestsTested
LangLanguage CC
License MIT
ReleasedLast Release Nov 2015

Maintained by Paulo Faria.



  • By
  • Paulo Faria

Currents

codecov.io

Currents is a TCP/IP library for Swift 2.

Features

  • [x] No Foundation dependency (Linux ready)
  • [x] Local IP
  • [x] Remote IP
  • [x] TCP Server Socket
  • [x] TCP Client Socket

Usage

IP

// local
do {
    // all network interfaces
    let ip1 = try IP(port: 5555, mode: .IPV4)

    // specific network interface
    let ip2 = try IP(networkInterface: "en0", port: 5555, mode: .IPV6)
} catch {
    // something bad happened :(
}

// remote
do {
    let ip3 = try IP(address: "127.0.0.1", port: 5555, mode: .IPV4)
} catch {
    // something bad happened :(
}

TCP

// server
do {
    let ip = try IP(port: 5555)
    let serverSocket = try TCPServerSocket(ip: ip)
    let clientSocket = try serverSocket.accept()

    let yo = try clientSocket.receiveString(untilDelimiter: "\n")
} catch {
    // something bad happened :(
}

// client
do {
    let ip = try IP(address: "127.0.0.1", port: 5555)
    let clientSocket = try TCPClientSocket(ip: ip)

    // calls to send append the data to an internal
    // buffer to minimize system calls
    try clientSocket.sendString("yo\n")\
    // flush actually sends all data in the buffer
    try clientSocket.flush()
} catch {
    // something bad happened :(
}

Installation

Manually

If you prefer not to use a dependency manager, you can integrate Currents into your project manually.

Embedded Framework

  • Open up Terminal, cd into your top-level project directory, and run the following command “if” your project is not initialized as a git repository:
$ git init
  • Add Currents as a git submodule by running the following command:
$ git submodule add https://github.com/Zewo/Currents.git
  • Open the new Currents folder, and drag the Currents.xcodeproj into the Project Navigator of your application’s Xcode project.

    It should appear nested underneath your application’s blue project icon. Whether it is above or below all the other Xcode groups does not matter.

  • Select the Currents.xcodeproj in the Project Navigator and verify the deployment target matches that of your application target.

  • Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the “Targets” heading in the sidebar.
  • In the tab bar at the top of that window, open the “General” panel.
  • Click on the + button under the “Embedded Binaries” section.
  • You will see two different Currents.xcodeproj folders each with two different versions of the Currents.framework nested inside a Products folder.

    It does not matter which Products folder you choose from, but it does matter whether you choose the top or bottom Currents.framework.

  • Select the top Currents.framework for OS X and the bottom one for iOS.

    You can verify which one you selected by inspecting the build log for your project. The build target for Currents will be listed as either Currents iOS or Currents OSX.

  • And that’s it!

The Currents.framework is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.

License

Currents is released under the MIT license. See LICENSE for details.