https://github.com/st1vms/dynamic-bits
Fast de/serialization library supporting variable-bits arrangement
https://github.com/st1vms/dynamic-bits
android boolean-bits c compression deserialization embedded fast ieee-754 iot java marshalling networking packet serialization serialization-library utf8-string varints
Last synced: 18 days ago
JSON representation
Fast de/serialization library supporting variable-bits arrangement
- Host: GitHub
- URL: https://github.com/st1vms/dynamic-bits
- Owner: st1vms
- License: gpl-3.0
- Created: 2023-01-29T17:47:16.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-09T12:35:08.000Z (over 1 year ago)
- Last Synced: 2025-04-12T12:59:24.248Z (about 1 year ago)
- Topics: android, boolean-bits, c, compression, deserialization, embedded, fast, ieee-754, iot, java, marshalling, networking, packet, serialization, serialization-library, utf8-string, varints
- Language: C
- Homepage:
- Size: 316 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# dynamic-bits
## Table of content
- [Overview](#overview)
- [Linux Installation](#linux-installation)
- [Installing on Linux (Cmake)](#installing-on-linux-cmake)
- [Android Installation](#manual-android-installation)
- [Uninstalling](#uninstalling)
- [Usage](#usage)
- [Notes](#notes)
# Overview
This is a serialization library that supports **variable length integers/doubles**, **UTF8 strings** and serialization of **boolean bits**.
This library is designed to be **strong**, **lightweight** and **fast**, using (one-malloc) allocation strategy and minimizing the amount of resources during serialization/deserialization.
This library uses variable-length integers, trying to serialize the minimum amount of bits required for each data type, prepending a bit header representing the bit size of the data. It follows IEEE 754 for 64-bit double precision, is UTF8 string compatible, and allows boolean serialization using only one bit.
Each "packet" is defined in a packet table, a fixed number of fields is assigned to every packet, along with an unsigned 8-bit integer representing the packet-id.
Programmers must register their packets in the table before any de/serialization activity, this way thread safety can be achieved.
# Linux-Installation
## Requirements
## Requirements
- [cmake](https://cmake.org/install/) is required in order to build this library.
- Download this repository, either by zip or git using:
```
git clone https://github.com/st1vms/dynamic-bits
```
## Before building
_____________________________________
Ensure to set optimal value for `MAX_PACKET_FIELDS` macro. It is located in the first lines of [include/dpacket.h](include/dpacket.h)
***MAX_PACKET_FIELDS** -> Max number of fields a packet can hold.*
It is drastically important to tweak this value in order to optimize space required for building the static packet table,
*PacketTableByteSize = 255 * (MAX_PACKET_FIELDS) bytes*
## Installing-On-Linux-CMake
After configuration is done, open a terminal inside the repository directory, and execute these commands.
```
chmod u+x ./build.sh
./build.sh && sudo make install -C build/
```
Inside the build folder you will find the generated shared library.
The library will be already installed on your system...
# Manual-Android-Installation
- Install [Android Studio](https://cmake.org/install/) if not already installed.
- Open the JDBits bind project inside Android Studio
## Before Building ( Android )
_____________________________________
Ensure to set optimal value for `MAX_PACKET_FIELDS` macro. It is located in the first lines of [jdbits/src/main/cpp/include/dpacket.h](binds/Android/JDBits/jdbits/src/main/cpp/include/dpacket.h)
***MAX_PACKET_FIELDS** -> Max number of fields a packet can hold.*
It is drastically important to tweak this value in order to optimize space required for building the static packet table.
*PacketTableByteSize = 255 * (MAX_PACKET_FIELDS) bytes*
## Building AAR library in Android Studio
- After syncing gradle files, open a terminal and execute this command:
```
JAVA_HOME=$HOME/android-studio/jbr ./gradlew jdbits:assemble
```
You will find the generated **jdbits-.aar** file inside the `build/outputs/aar` folder
Copy the AAR file into your Android project **`libs`** folder, and import is as an **`implementation`** dependency, using the Android Studio dependency manager in your Project Settings.
## Usage
Please refer to the examples provided in the [examples](examples/) folder, for the specific language/platform you're using...
- [C-Example](examples/c-example/)
- [Android-Java-Example](examples/android-example/app/src/main/java/com/example/dbitsandroidexample/MainActivity.java)
## Notes
This library doesn't still support complex structures, such as arrays, unions, dictonaries, etc...
I'm planning to add them very soon along with bindings for Python and Java.
## Uninstalling
Run these two commands inside project folder...
```
chmod u+x uninstall.sh
sudo ./uninstall.sh
```