Go to file
levlam b339833ef9 Add Java example.
GitOrigin-RevId: 09903810042bd576bff2f59f4cd4cb498af13749
2018-01-28 13:58:33 +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 Java example. 2018-01-28 13:58:33 +03:00
memprof Replace assert with if to prevent warning about unused variable. 2018-01-21 16:50:35 +03:00
sqlite Remove unused sqlite dependency on libdl. 2018-01-27 22:44:31 +03:00
td Add td::jni::get_jni_env wrapper. 2018-01-28 13:20:43 +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 Add Java example. 2018-01-28 13:58:33 +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 Add td::jni::get_jni_env wrapper. 2018-01-28 13:20:43 +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

TDLib (Telegram Database library) is a cross-platform library for building Telegram clients. It can be easily used from almost any programming language.

Table of Contents

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 are 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 are sent when they are available.

Examples and documentation

Take a look at our examples and documentation.

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 (build only)
  • CMake (3.0.2+, build only)
  • PHP (optional, for docs generation)
  • Doxygen (optional, for docs generation)

Building

Install all TDLib dependencies as described in Installing dependencies. Then enter directory containing TDLib sources and compile them using CMake:

mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build .

Installing dependencies

OS X

  • Install the latest XCode command line tools.
  • Install other dependencies, for example, using Homebrew:
brew install gperf cmake openssl
  • Build TDLib with CMake as explained in building. You may need to manually specify path to the installed OpenSSL to CMake, e.g.,
cmake -DCMAKE_BUILD_TYPE=Release -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl/ ..

Windows

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

Linux

  • Install all dependencies using your package manager.

Using in CMake C++ projects

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

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 programming 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 CMakeLists.txt may look like this:

add_subdirectory(td)
target_link_libraries(YourTarget PRIVATE Td::TdStatic)

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

find_package(Td 1.0.5 REQUIRED)
target_link_libraries(YourTarget PRIVATE Td::TdStatic)

See example/cpp/CMakeLists.txt.

Using in Java projects

TDLib provides native Java interface through JNI.

See example/java for example of using TDLib from Java and detailed build and usage instructions.

Using from other programming 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.

License

The TDLib is licensed under the terms of the Boost Software License. See LICENSE_1_0.txt for more information.