47 lines
2.1 KiB
Markdown
47 lines
2.1 KiB
Markdown
### fifo
|
|
|
|
[](https://pkg.go.dev/github.com/containerd/fifo)
|
|
[](https://github.com/containerd/fifo/actions?query=workflow%3ACI)
|
|
[](https://codecov.io/gh/containerd/fifo)
|
|
[](https://goreportcard.com/report/github.com/containerd/fifo)
|
|
|
|
Go package for handling fifos in a sane way.
|
|
|
|
```
|
|
// OpenFifo opens a fifo. Returns io.ReadWriteCloser.
|
|
// Context can be used to cancel this function until open(2) has not returned.
|
|
// Accepted flags:
|
|
// - syscall.O_CREAT - create new fifo if one doesn't exist
|
|
// - syscall.O_RDONLY - open fifo only from reader side
|
|
// - syscall.O_WRONLY - open fifo only from writer side
|
|
// - syscall.O_RDWR - open fifo from both sides, never block on syscall level
|
|
// - syscall.O_NONBLOCK - return io.ReadWriteCloser even if other side of the
|
|
// fifo isn't open. read/write will be connected after the actual fifo is
|
|
// open or after fifo is closed.
|
|
func OpenFifo(ctx context.Context, fn string, flag int, perm os.FileMode) (io.ReadWriteCloser, error)
|
|
|
|
|
|
// Read from a fifo to a byte array.
|
|
func (f *fifo) Read(b []byte) (int, error)
|
|
|
|
|
|
// Write from byte array to a fifo.
|
|
func (f *fifo) Write(b []byte) (int, error)
|
|
|
|
|
|
// Close the fifo. Next reads/writes will error. This method can also be used
|
|
// before open(2) has returned and fifo was never opened.
|
|
func (f *fifo) Close() error
|
|
```
|
|
|
|
## Project details
|
|
|
|
The fifo is a containerd sub-project, licensed under the [Apache 2.0 license](./LICENSE).
|
|
As a containerd sub-project, you will find the:
|
|
|
|
* [Project governance](https://github.com/containerd/project/blob/master/GOVERNANCE.md),
|
|
* [Maintainers](https://github.com/containerd/project/blob/master/MAINTAINERS),
|
|
* and [Contributing guidelines](https://github.com/containerd/project/blob/master/CONTRIBUTING.md)
|
|
|
|
information in our [`containerd/project`](https://github.com/containerd/project) repository.
|