Merge pull request #818 from devlights/add-mkfifo-write-nonblocking-example

Author: devlights

examples/singleapp/mkfifo/write-nonblocking/.gitignore

@@ -0,0 +1,2 @@
+tmp-fifo
+app

examples/singleapp/mkfifo/write-nonblocking/Taskfile.yml

@@ -0,0 +1,26 @@
+# https://taskfile.dev
+
+version: '3'
+
+vars:
+  FIFO_FILE: ./tmp-fifo
+
+tasks:
+  default:
+    cmds:
+      - task: build
+      - task: create-fifo
+      - task: run
+  build:
+    cmds:
+      - go build -o app .
+  create-fifo:
+    cmds:
+      - rm -f {{.FIFO_FILE}}
+      - mkfifo {{.FIFO_FILE}} -m0666
+  run:
+    cmds:
+      # ワザと読み込みを遅延させて実行
+      - ./app -fname {{.FIFO_FILE}} &
+      - sleep 1
+      - cat {{.FIFO_FILE}}

examples/singleapp/mkfifo/write-nonblocking/main.go

@@ -0,0 +1,129 @@
+//go:build linux
+
+package main
+
+import (
+	"bufio"
+	"errors"
+	"flag"
+	"fmt"
+	"log"
+	"os"
+	"sync"
+	"syscall"
+	"time"
+
+	"golang.org/x/sys/unix"
+)
+
+var (
+	fname string
+)
+
+func init() {
+	log.SetFlags(log.Lmicroseconds)
+
+	flag.StringVar(&fname, "fname", "", "FIFO file name")
+	flag.Parse()
+}
+
+func main() {
+	if err := run(); err != nil {
+		log.Fatal(err)
+	}
+}
+
+func run() error {
+	//
+	// 名前付きパイプをノンブロッキングモードで開く
+	//   明示的なノンブロッキングモードの指定は os.OpenFile() では行えないため
+	//   golang.org/x/sys/unix を利用する
+	//
+	var (
+		fd  int
+		f   *os.File
+		err error
+	)
+
+	log.Println("[Before] unix.Open(unix.O_WRONLY|unix.O_NONBLOCK)")
+
+	// 名前付きパイプを書込みでノンブロッキングモードで開く場合に O_WRONLY を指定すると
+	// 読み込み側が開かれていない場合 `ENXIO(no such device or address)` が発生する。
+	//
+	// 逆に読み込みでノンブロッキングモードで開く場合はここではエラーとならず
+	// 実際に読み込む際に書込みが行われていない場合に即EOFが返ることになる。
+	// ノンブロッキングリードする処理は ../read-nonbloking/ を参照のこと。
+	//
+	// 読み込みと書込みでエラーが発生する箇所が異なる点に注意。
+	//
+	// REFERENCES
+	//   - https://qiita.com/seriru13/items/39ed2431dfd959ad512e
+	for {
+		fd, err = unix.Open(fname, unix.O_WRONLY|unix.O_NONBLOCK, 0666)
+		if err != nil {
+			var sysErr syscall.Errno
+			if errors.As(err, &sysErr) && sysErr == unix.ENXIO {
+				log.Printf("[ENXIO] %s", sysErr)
+				<-time.After(200 * time.Millisecond)
+				continue
+			}
+
+			return err
+		}
+
+		break
+	}
+
+	f = os.NewFile(uintptr(fd), fname)
+	if f == nil {
+		return fmt.Errorf("invalid file descriptor")
+	}
+	defer f.Close() // ここで f.Close() しているので、上で unix.Close(fd) は不要
+
+	log.Println("[After ] unix.Open(unix.O_WRONLY|unix.O_NONBLOCK)")
+
+	//
+	// データを書き込み
+	//
+	type (
+		data struct {
+			numWrites int
+			err       error
+		}
+	)
+	var (
+		writer  = bufio.NewWriter(f)
+		results = make(chan data)
+		timeout = 1500 * time.Millisecond
+		done    = make(chan struct{})
+		wg      sync.WaitGroup
+	)
+
+	wg.Add(1)
+	go func() {
+		defer wg.Done()
+
+		n, err := writer.WriteString("helloworld\n")
+		if err == nil {
+			err = writer.Flush()
+		}
+
+		results <- data{n, err}
+	}()
+
+	select {
+	case r := <-results:
+		if r.err != nil {
+			return r.err
+		}
+
+		log.Printf("Write %d byte(s)", r.numWrites)
+	case <-time.After(timeout):
+		log.Println("timeout")
+	}
+
+	close(done)
+	wg.Wait()
+
+	return nil
+}

examples/singleapp/mkfifo/write/Taskfile.yml

@@ -21,4 +21,4 @@ tasks:
   run:
     cmds:
       - ./app -fname {{.FIFO_FILE}} &
-      - (sleep 2; (date '+%H:%M:%S.%6N'; cat {{.FIFO_FILE}}) | xargs)
+      - (sleep 2; cat {{.FIFO_FILE}})

examples/singleapp/mkfifo/write/main.go

@@ -31,7 +31,7 @@ func run() error {
 	//
 	// 名前付きパイプを開く
 	//   os.OpenFile() にて、モード指定で os.ModeNamedPipe を指定する
-	//   os.O_RDOONLYで開くと書込み専用となるが、この場合読み込みが発生するまで
+	//   os.O_WRONLYで開くと書込み専用となるが、この場合読み込みが発生するまで
 	//   ブロックされる。これはUNIXの名前付きパイプの挙動に従った動作である。
 	//
 	var (