Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dantmnf/tdlib-netcore
Fast TDLib binding for .NET Core and .NET Standard.
https://github.com/dantmnf/tdlib-netcore
Last synced: about 2 months ago
JSON representation
Fast TDLib binding for .NET Core and .NET Standard.
- Host: GitHub
- URL: https://github.com/dantmnf/tdlib-netcore
- Owner: dantmnf
- License: bsl-1.0
- Created: 2019-02-16T14:55:05.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T10:32:26.000Z (3 months ago)
- Last Synced: 2024-07-10T12:36:24.747Z (2 months ago)
- Language: C#
- Homepage:
- Size: 2.46 MB
- Stars: 16
- Watchers: 5
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE_1_0.txt
Awesome Lists containing this project
README
# TDLibCore
Fast [TDLib](https://github.com/tdlib/td) binding for .NET Core and .NET Standard:
* Generated APIs with full documentation.
* Generated `System.Text.Json`-based reflection-free reader and writer for performance.
* Plus *experimental* SWIG-like binding that directly consumes TDLib C++ API for more performance (~40% faster than JSON binding on calling getTextEntities in example below).
## Installation
There is no official NuGet packages at the moment. You can build your own package with build script, or use packages from CI.
```bash
# build native package
ruby build-native.rb -- -DCMAKE_BUILD_TYPE=Release -DTD_ENABLE_LTO=ON [other tdlib CMake options]
# build managed (.NET) packages.
ruby build-managed.rb
```
This will build package in `pkgs` subdirectory by default.
> ð¡ **vcpkg users:** use `-DVCPKG_APPLOCAL_DEPS=ON/OFF` to control including OpenSSL and zlib libraries in package.
Build script options
```
usage: build-managed.rb [options] -- [tdlib CMake options]
-b, --build-root=DIR set build root to DIR, defaults to /thisrepo/build
-o, --output=DIR set output directory to DIR, defaults to /thisrepo/pkgs
-r, --use-release-versioning remove commit hash from package version
-h, --help Show this message
```
```
usage: build-native.rb [options] -- [tdlib CMake options]
-b, --build-root=DIR set build root to DIR, defaults to /thisrepo/build
-s, --source-root=DIR set tdlib source root to DIR, defaults to /thisrepo/td
-o, --output=DIR set output directory to DIR, defaults to /thisrepo/pkgs
--[no-]build-tdjson build tdjson and runtime.RID.TDLibCore.JsonClient.Native
--build-tdbridge build tdbridge and runtime.RID.TDLibCore.NativeClient.Native
-r, --use-release-versioning remove commit hash from package version
--rid=RID override RID detection
-h, --help Show this message
```
### Packages Description
* **TDLib**: provides TDLib APIs.
* **TDLibCore.JsonClient**: provides TDLib tdjson binding.
* **TDLibCore.NativeClient**: provides native TDLib binding, which means data is passed to TDLib with its native representation.
* **TDLibCore.{Json,Native}Client.Native**: helper package to reference correct runtime package on publish.
* **runtime.{RID}.TDLibCore.{Json,Native}Client.Native**: provides native library for runtime RID.
* **TDLibCore.ApiVersionTag**: dummy package to enforce native package is used with correct version of binging package.
Binding packages don't depend on native package. Feel free to bring your own native library.
## Usage
Add reference to `TDLibCore.JsonClient` or `TDLibCore.NativeClient`, additionally with corresponding native package.
> ð¡ You need a runtime package to make native libraries copied to build output (for debugging).
```c#
using System;
using TDLibCore.Api;
using TDLibCore.JsonClient; // or NativeClient
using var client = new JsonClient(); // or NativeClient
var text = "/ban_shanye@lgjjbot #å±±é @shanye https://github.com/ShanYe/ [email protected] \n\r\tå°åç¹å±±é对倧家éœå¥œ";
var request = new GetTextEntities(text);
var response = client.Execute(request);
Console.WriteLine($"Found {response.Entities.Length} entities");
// using extension methods
using TDLibCore.ClientExtension;
response = client.GetTextEntitiesSync(text);
Console.WriteLine($"Found {response.Entities.Length} entities");
// using async APIs
client.Update += (client, update) => { Console.WriteLine($"Received update of type {update.GetType()}") }
client.RunEventLoop();
response = await client.GetTextEntities(text);
Console.WriteLine($"Found {response.Entities.Length} entities");
// error handling
try
{
// Ok mapped to void
await client.SetAuthenticationPhoneNumber(phoneNumber);
}
catch (TDLibError e)
{
TDLibCore.Api.Error err = e.Error;
Console.WriteLine($"{err.Code} {err.Message}")
}
// stop event loop to stop receiving updates
// ... and cancel pending async calls
await client.StopEventLoop();
```
## Targeting Different TDLib Version
The current targeting TDLib version/revision is included as submodule for reference.
You can generate code for a different version:
```bash
cd codegen
make # using td submodule by default, override with TD_DIR=/path/to/tdlib
# and run build-native.rb with --source-root=/path/to/tdlib
# or with MSVC NMake
nmake # additionally with TD_DIR=C:\path\to\tdlib
```
## Benchmarks
BenchmarkDotNet=v0.12.1, OS=Windows 10.0.19042
Intel Core i7-4770K CPU 3.50GHz (Haswell), 1 CPU, 8 logical and 4 physical cores
.NET Core SDK=5.0.100-rc.2.20479.15
[Host] : .NET Core 3.1.9 (CoreCLR 4.700.20.47201, CoreFX 4.700.20.47203), X64 RyuJIT
DefaultJob : .NET Core 3.1.9 (CoreCLR 4.700.20.47201, CoreFX 4.700.20.47203), X64 RyuJIT
| Method | Mean | Error | StdDev | Ratio | RatioSD |
|------------------------ |----------:|----------:|----------:|------:|--------:|
| td_json_client_execute* | 6.195 us | 0.0376 us | 0.0294 us | 1.00 | 0.00 |
| JsonClientExecute | 10.820 us | 0.0630 us | 0.0558 us | 1.75 | 0.01 |
| NativeClientExecute | 4.444 us | 0.0276 us | 0.0230 us | 0.72 | 0.01 |
| JsonDotNetExecute** | 67.604 us | 0.5022 us | 0.4452 us | 10.91 | 0.10 |
\*: invoked with prepared request and discarded response for a baseline of (de)serialization performance.
\**: using Newtonsoft.Json reflection-based converter.