README
¶
go-ipc: A library for inter-process communication written in pure Go.
This package gives you access to os-native ipc mechanisms on linux, OSX, freebsd, and windows.
- Pure Go implementation, no cgo is required.
- Works on linux, OSX, freebsd, and windows.
- Support of the following mechanisms:
- fifo (all supported platforms)
- memory mapped files (all supported platforms)
- shared memory (all supported platforms)
- system message queues (linux, sysv)
- cross-platform priority message queue
- locking primitives: (all supported platforms)
Install
- Install Go 1.6 or higher.
- Run
go get -u bitbucket.org/avd/go-ipc
Documentation
Documentation can be found at godoc.
Build status
This library is currently alpha. The 'master' branch is not guaranteed to contain stable code, it is even not guaranteed, that it builds correctly on all platforms. The library uses Semantic Versioning 2.0.0, so it is recommended to checkout the latest release.
Contributing
Any contributions are welcome. Feel free to:
- create
issues - open
pull requests
Before opening a PR, be sure, that:
- your PR has an issue associated with it.
- your commit messages are adequate.
- you added unit tests for your code.
- you gofmt'ed the code.
- you used
gometalinterto check your code.
PR's containing documentation improvements and tests are especially welcome.
LICENSE
This package is made available under an Apache License 2.0. See LICENSE and NOTICE.
Documentation
¶
Overview ¶
Package ipc provides primitives for inter-process communication. Currently it implements the following mechanisms:
fifo (unix, windows) memory mapped files (unix, windows) system message queues (linux, sysv) cross-platform priority message queue shared memory (unix, windows) mutexes (unix, windows)
The library is currently alpha, so it lacks docs and examples, I'll add them later. Also, its public API may change. You can find some usage examples in test files of the subpackages.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package fifo implements first-in-first-out objects logic.
|
Package fifo implements first-in-first-out objects logic. |
|
internal/test
command
|
|
|
internal
|
|
|
Package mmf implements privitives for mapping files into memory.
|
Package mmf implements privitives for mapping files into memory. |
|
Package mq implements interprocess queues logic.
|
Package mq implements interprocess queues logic. |
|
internal/test
command
|
|
|
Package shm implements shared memory objects.
|
Package shm implements shared memory objects. |
|
internal/test
command
|
|
|
Package sync implements primitives for synchronization between processes.
|
Package sync implements primitives for synchronization between processes. |
|
internal/test/sync
command
|