Skip to content

A simple Unix IPC Socket client for Go. For more flexibility try joseluisq/gonetc instead.

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

joseluisq/goipcc

Repository files navigation

goipcc Build Status codecov Go Report Card PkgGoDev

A simple Unix IPC Socket client for Go.

NOTE: For more flexibility try joseluisq/gonetc instead.

Usage

package main

import (
    "log"
    "strings"

    "github.com/joseluisq/goipcc"
)

func main() {
    // Code for example purposes only

    // 1. Create a simple listening Unix socket with echo functionality
    // using the `socat` tool -> http://www.dest-unreach.org/socat/
    // Then execute the following commands on your terminal:
    //  rm -f /tmp/mysocket && socat UNIX-LISTEN:/tmp/mysocket,fork exec:'/bin/cat'

    // 2. Now just run this client code example in order to exchange data with current socket.
    //  go run examples/main.go

    // 2.1 Connect to the listening socket
    sock := goipcc.New("/tmp/mysocket")
    err := sock.Connect()
    if err != nil {
        log.Fatalln("unable to communicate with socket:", err)
    }

    // 2.2 Send some sequential data to current socket (example only)
    pangram := strings.Split("The quick brown fox jumps over the lazy dog", " ")
    for _, word := range pangram {
        log.Println("client data sent:", word)
        _, err := sock.Write([]byte(word), func(resp []byte, err error, done func()) {
            log.Println("client data received:", string(resp))
            // Finish the current write handling response if we are done
            done()
        })
        if err != nil {
            log.Fatalln("unable to write to socket:", err)
        }
    }

    sock.Close()

    // 3. Finally after running the client you'll see a similar output like:
    //
    // 2020/11/24 00:39:27 client data sent: The
    // 2020/11/24 00:39:27 client data received: The
    // 2020/11/24 00:39:28 client data sent: quick
    // 2020/11/24 00:39:28 client data received: quick
    // 2020/11/24 00:39:29 client data sent: brown
    // 2020/11/24 00:39:29 client data received: brown
    // 2020/11/24 00:39:30 client data sent: fox
    // 2020/11/24 00:39:30 client data received: fox
    // 2020/11/24 00:39:31 client data sent: jumps
    // 2020/11/24 00:39:31 client data received: jumps
    // 2020/11/24 00:39:32 client data sent: over
    // 2020/11/24 00:39:32 client data received: over
    // 2020/11/24 00:39:33 client data sent: the
    // 2020/11/24 00:39:33 client data received: the
    // 2020/11/24 00:39:34 client data sent: lazy
    // 2020/11/24 00:39:34 client data received: lazy
    // 2020/11/24 00:39:35 client data sent: dog
    // 2020/11/24 00:39:35 client data received: dog
}

Contributions

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in current work by you, as defined in the Apache-2.0 license, shall be dual licensed as described below, without any additional terms or conditions.

Feel free to send some Pull request or issue.

License

This work is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0).

© 2020-present Jose Quintana

About

A simple Unix IPC Socket client for Go. For more flexibility try joseluisq/gonetc instead.

Topics

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Packages

No packages published