# Shmex

[![API Docs](](

Shmex is a library providing Elixir bindings for shared memory and native
functions to manipulate it in NIFs.

Documentation is available at [HexDocs](

The source code is available at [GitHub](

## Installation

Add the following line to your `deps` in `mix.exs`. Run `mix deps.get`.

	{:shmex, "~> 0.5.0"}

All native stuff is exported in `:lib` and `:shmex` [Bundlex]( dependencies.
To import, add the following line to your nif specification in `bundlex.exs`
deps: [shmex: :lib]
and another one in your native header file
#import <shmex/lib.h>

## Testing

To execute tests run `mix test`. These test tags are excluded by default:
- `shm_tmpfs` - tests that require access to information about shared memory segments present in the OS via tmpfs, not supported e.g. by Mac OS
- `shm_resizable` - tests for functions that involve resizing existing shared memory segments, not supported e.g. by Mac OS

## Copyright and License

Copyright 2018, [Software Mansion](

[![Software Mansion](](

Licensed under the [Apache License, Version 2.0](LICENSE)