Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davenchy/libtorrent-dart-bindings-example
A simple example on how to write libtorrent bindings for dart lang
https://github.com/davenchy/libtorrent-dart-bindings-example
bindings dart dart-ffi dartlang example ffi libtorrent torrent
Last synced: 5 days ago
JSON representation
A simple example on how to write libtorrent bindings for dart lang
- Host: GitHub
- URL: https://github.com/davenchy/libtorrent-dart-bindings-example
- Owner: Davenchy
- Archived: true
- Created: 2024-03-27T03:17:52.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-04-24T04:56:38.000Z (5 months ago)
- Last Synced: 2024-09-28T16:02:54.301Z (5 days ago)
- Topics: bindings, dart, dart-ffi, dartlang, example, ffi, libtorrent, torrent
- Language: C++
- Homepage:
- Size: 236 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LibTorrent Dart Bindings Example
## Introduction
Hello there! Welcome to this example project demonstrating how to create LibTorrent bindings for the Dart language. I hope you find it helpful and informative.
## Why??
Everything started from here [https://github.com/dart-lang/native/issues/218](https://github.com/dart-lang/native/issues/218)
## Requirements
Before diving in, make sure you have the following prerequisites installed:
- Ensure libtorrent shared library is installed on your system and recognized by the compiler using the flag `-ltorrent-rasterbar`.
- If you have libtorrent source files in a custom path, update the `wrapper/Makefile` accordingly.
- You'll also need to have the [Dart SDK](https://dart.dev/get-dart) installed.
## Makefile
- The `wrapper/Makefile` contains various useful rules to streamline the development process:
1. **debug**: Builds a test binary with gdb flag enabled for testing/debugging process.
2. **run**: Similar to `debug`, but it also runs the binary after building.
3. **build**: This rule is responsible for building the wrapper library: `libwrapper.so` by default.
## Build the Wrapper Library
- To build the wrapper library, execute the following command:
```sh
make build
```
## Run the Example Project
Once you've built the wrapper library, follow these steps to run the example project:
1. Copy the library file `libwrapper.so` into the Dart project directory.
2. Get dart packages
```sh
dart pub get
```
2. Run the project using the following command:
```sh
dart run
```
## Additional Resources
If you want to dive deeper into LibTorrent, here are some helpful resources:
### LibTorrent Documentation
- [LibTorrent Tutorial](https://www.libtorrent.org/tutorial-ref.html)
- [Settings Pack](https://www.libtorrent.org/reference-Settings.html#settings_pack)
- [Alert Categories](https://www.libtorrent.org/reference-Alerts.html#alert-category-t)
- [Alerts](https://www.libtorrent.org/reference-Alerts.html#overview)
- [Parse Magnet URI](https://www.libtorrent.org/reference-Core.html#parse_magnet_uri())
- [Add Torrent Parameters](https://www.libtorrent.org/reference-Add_Torrent.html#add_torrent_params)
- [Session Handle](https://www.libtorrent.org/reference-Session.html#session_handle)
- [Torrent Handle](https://www.libtorrent.org/reference-Torrent_Handle.html#torrent_handle)
- [Torrent Info](https://www.libtorrent.org/reference-Torrent_Info.html#torrent_info)
- [File Storage](https://www.libtorrent.org/reference-Storage.html)
### Dart FFI
- [C interop using dart:ffi](https://dart.dev/interop/c-interop)
- [dart-lang repo ffi samples](https://github.com/dart-lang/samples/tree/main/ffi)
### StackOverflow
- [Developing C wrapper API for Object-Oriented C++ code](https://stackoverflow.com/q/2045774/8046862)
- [How to create a shared library in android and use it in flutter?](https://stackoverflow.com/q/74063116/8046862)
### Other
- [GeeksForGeeks:extern-c-in-c](https://www.geeksforgeeks.org/extern-c-in-c/)
## Contribution
Feel free to fork this project or create pull requests if you'd like to contribute. **Your feedback and contributions are highly appreciated!**