Swiftpack.co - Package - SwiftNIOExtras/swift-nio-irc

SwiftNIO IRC

Swift4 Swift5 iOS macOS tuxOS

SwiftNIO-IRC is a Internet Relay Chat protocol implementation for SwiftNIO.

This module contains just the protocol implementation. We also provide:

To get started with this, pull swift-nio-irc-server - a module to rule them all and in the darkness bind them.

NIOIRC is a SwiftNIO port of the Noze.io miniirc example from 2016.

Importing the module using Swift Package Manager

An example Package.swiftimporting the necessary modules:

// swift-tools-version:5.0

import PackageDescription

let package = Package(
    name: "IRCTests",
    dependencies: [
        .package(url: "https://github.com/SwiftNIOExtras/swift-nio-irc.git",
                 from: "0.6.0")
    ],
    targets: [
        .target(name: "MyProtocolTool",
                dependencies: [ "NIOIRC" ])
    ]
)

Using the SwiftNIO IRC protocol handler

The IRC protocol is implemented as a regular ChannelHandler, similar to NIOHTTP1. It takes incoming ByteBuffer data, parses that, and emits IRCMessage items. Same the other way around, the user writes IRCReply objects, and the handler renders such into ByteBuffers.

To add the IRC handler to a NIO Channel pipeline:

import NIOIRC

bootstrap.channelInitializer { channel in
    channel.pipeline
        .add(handler: IRCChannelHandler())
        .then { ... }
}

Who

Brought to you by ZeeZide. We like feedback, GitHub stars, cool contract work, presumably any form of praise you can think of.

Github

link
Stars: 20
Help us keep the lights on

Dependencies

Used By

Total:

Releases

0.6.2 - Dec 12, 2018

Fix an endless loop in the IRC message parser, should fix issue #4.

The parser skips empty lines, but didn't properly adjust the looping index. That should be fixed now.

P.S.: Now building on more Travis platforms (e.g. Linux Swift 4.2, and XcodeX)

0.6.0 - Jul 26, 2018

Decouple the protocol implementation from the client to make it useful to arbitrary higher level frameworks. The client now lives in an extra package over at Noze.io.