This repository has been archived on 2020-05-25. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
levlam dc274ea3b5 Send update with an empty User for unknown users.
GitOrigin-RevId: 470184a7277bbce3855ecad8acf955369370ff76
2018-01-26 22:53:20 +03:00
benchmark Update copyright year. 2018-01-02 16:45:09 +03:00
CMake Make JNI-bindings package-agnostic. 2018-01-21 14:45:24 +03:00
example Add example of td_set_log_fatal_error_callback usage to Python example. 2018-01-24 19:11:39 +03:00
memprof Replace assert with if to prevent warning about unused variable. 2018-01-21 16:50:35 +03:00
sqlite Omit some unused sqlite parts. 2018-01-21 16:44:17 +03:00
td Send update with an empty User for unknown users. 2018-01-26 22:53:20 +03:00
tdactor Fix clang 3.4 Debug build CE. 2018-01-10 21:48:44 +03:00
tddb Update copyright year. 2018-01-02 16:45:09 +03:00
tdnet Optionally ignore EACCES in realpath. 2018-01-26 16:47:46 +03:00
tdtl tdtl: pass class_name to constructor generators. 2018-01-09 18:56:58 +03:00
tdutils Fix CE. 2018-01-26 17:05:02 +03:00
test Allow to create chats without network request. 2018-01-24 00:45:26 +03:00
.clang-format Project import generated by Copybara. 2017-12-31 23:08:40 +03:00
.gitattributes Mark SQLite as linguist-vendored. 2018-01-06 23:50:12 +03:00
.gitignore Project import generated by Copybara. 2017-12-31 23:08:40 +03:00
.travis.yml Project import generated by Copybara. 2017-12-31 23:08:40 +03:00
.ycm_extra_conf.py Project import generated by Copybara. 2017-12-31 23:08:40 +03:00
bitbucket-pipelines.yml Project import generated by Copybara. 2017-12-31 23:08:40 +03:00
CMakeLists.txt Add set_fatal_error_callback to public Log interface. 2018-01-24 18:45:57 +03:00
Doxyfile Project import generated by Copybara. 2017-12-31 23:08:40 +03:00
format.ps1 Add -verbose option to clang-format. 2018-01-21 17:23:52 +03:00
format.sh Add -verbose option to clang-format. 2018-01-21 17:23:52 +03:00
gen_git_commit_h.ps1 Project import generated by Copybara. 2017-12-31 23:08:40 +03:00
gen_git_commit_h.sh Project import generated by Copybara. 2017-12-31 23:08:40 +03:00
LICENSE_1_0.txt Project import generated by Copybara. 2017-12-31 23:08:40 +03:00
README.md Allow to create chats without network request. 2018-01-24 00:45:26 +03:00
src.ps1 Fix exemple formatting. 2018-01-22 22:38:55 +03:00
src.sh Fix exemple formatting. 2018-01-22 22:38:55 +03:00
tdclientjson_export_list Add set_fatal_error_callback to public Log interface. 2018-01-24 18:45:57 +03:00
TdConfig.cmake Project import generated by Copybara. 2017-12-31 23:08:40 +03:00

TDLib

This repository contains the code of the Telegram Database library (TDLib).

Table of Content

About

TDLib is a cross-platform, fully functional Telegram client.

Features

TDLib has many advantages. Notably TDLib is:

  • Cross-platform: TDLib can be used on Android, iOS, Windows, macOS, Linux, Windows Phone, WebAssembly, watchOS, tvOS, Tizen, Cygwin. It should also work on other *nix systems with or without minimal effort.
  • Multilanguage: TDLib can be easily used with any programming language that is able to execute C functions. Additionally it already has native bindings to Java (using JNI) and C# (using C++/CLI).
  • Easy to use: TDLib takes care of all network implementation details, encryption and local data storage.
  • High-performance: in the Telegram Bot API, each TDLib instance handles more than 18000 active bots simultaneously.
  • Well-documented: all TDLib API methods and public interfaces are fully documented.
  • Consistent: TDLib guarantees that all updates will be delivered in the right order.
  • Reliable: TDLib remains stable on slow and unstable Internet connections.
  • Secure: all local data is encrypted using a user-provided encryption key.
  • Fully-asynchronous: requests to TDLib don't block each other or anything else, responses will be sent when they are available.

License

The Telegram Database library is licensed under the terms of the Boost Software License. See LICENSE for more information.

Build

Dependencies

TDLib depends on:

  • C++14 compatible compiler (clang 3.4+, GCC 4.9+, MSVC 19.0+ (Visual Studio 2015+), Intel C++ Compiler 17+)
  • OpenSSL
  • zlib
  • gperf
  • CMake (3.0.2+)
  • php (optional, for docs generation)
  • doxygen (optional, for docs generation)

Build with CMake

mkdir build
cd build
cmake ..
cmake --build .
cmake --build . --target install

Using TDLib in CMake C++ projects

For C++ projects that use CMake, the best approach is to build TDLib as part of your project.

There are several libraries that you could use in your CMake project:

  • Td::TdJson, Td::TdJsonStatic — dynamic and static version of a json interface. Has a simple C interface, so it can be easily used with any language that supports C bindings.
  • Td::TdStatic — static library with C++ interface.
  • Td::TdCoreStatic — static library with low-level C++ interface intended mostly for internal usage.

For example, part of your CMakeList.txt may look like this:

add_subdirectory(td)
target_link_library(YourLibrary Td::TdJson)

Or you could install TDLib and then reference it in your CMakeLists.txt like this:

find_package(Td 1.0.5)
target_link_library(YourLibrary Td::TdJson)

See example/cpp/CMakeLists.txt.

Using TDLib from other languages

TDLib provides efficient native C++, Java, and C# (will be released soon) interfaces. But for most use cases we suggest to use the JSON interface. It can be easily used with any language that supports C bindinds. See example/python/tdjson_example.py for an example of such usage.

Installing dependencies

OS X

  • Install the latest XCode command line tools.
  • Install other dependencies, for example, using Homebrew:
brew install gperf cmake openssl
  • After that you may need to manually specify path to the installed OpenSSL to CMake, e.g.,
cmake -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl/ ..

Windows

  • Download and install gperf. Add the path to gperf to the PATH variable.
  • Install vcpkg.
  • Run the following commands:
C:\src\vcpkg> .\vcpkg install openssl zlib
  • Build TDLib with cmake as explained above, but instead of cmake .. use cmake -DCMAKE_TOOLCHAIN_FILE=C:\src\vcpkg\scripts\buildsystems\vcpkg.cmake ...

Linux

Install all dependencies using your package manager.

TDLib usage

Take a look at our examples and documentation.