From fbc1e6351ec716685a4aab4a42712e3dcac49891 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Wed, 2 Nov 2022 14:18:55 +0000 Subject: [PATCH] Update content of files --- data/web/core.telegram.org/resources/cidr.txt | 14 - data/web/core.telegram.org/tdlib/docs.html | 210 ++++++++ .../tdlib/docs/td__json__client_8h.html | 502 ++++++++++++++++++ 3 files changed, 712 insertions(+), 14 deletions(-) delete mode 100644 data/web/core.telegram.org/resources/cidr.txt create mode 100644 data/web/core.telegram.org/tdlib/docs.html create mode 100644 data/web/core.telegram.org/tdlib/docs/td__json__client_8h.html diff --git a/data/web/core.telegram.org/resources/cidr.txt b/data/web/core.telegram.org/resources/cidr.txt deleted file mode 100644 index 0512b4b0ab..0000000000 --- a/data/web/core.telegram.org/resources/cidr.txt +++ /dev/null @@ -1,14 +0,0 @@ -91.108.56.0/22 -91.108.4.0/22 -91.108.8.0/22 -91.108.16.0/22 -91.108.12.0/22 -149.154.160.0/20 -91.105.192.0/23 -91.108.20.0/22 -185.76.151.0/24 -2001:b28:f23d::/48 -2001:b28:f23f::/48 -2001:67c:4e8::/48 -2001:b28:f23c::/48 -2a0a:f280::/32 diff --git a/data/web/core.telegram.org/tdlib/docs.html b/data/web/core.telegram.org/tdlib/docs.html new file mode 100644 index 0000000000..a6dad42d1a --- /dev/null +++ b/data/web/core.telegram.org/tdlib/docs.html @@ -0,0 +1,210 @@ + + + + + + + + +TDLib: TDLib + + + + + + + + + + + + +
+
+
+
+
+ + +
+
+
+
+ + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+
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, FreeBSD, OpenBSD, NetBSD, illumos, 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 Java (using JNI) bindings and .NET (using C++/CLI and C++/CX) bindings.
    • +
  • 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 24000 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 unreliable 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

+

See our Getting Started tutorial for a description of basic TDLib concepts.

+

Take a look at our examples.

+

See a TDLib build instructions generator for detailed instructions on how to build TDLib.

+

See description of our JSON, C++, Java and .NET interfaces.

+

See the td_api.tl scheme or the automatically generated HTML documentation for a list of all available TDLib methods and classes.

+

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 documentation generation)
    • +
+

Building

+

The simplest way to build TDLib is to use our TDLib build instructions generator. You need only to choose your programming language and target operating system to receive complete build instructions.

+

In general, you need to install all TDLib dependencies, enter directory containing TDLib sources and compile them using CMake:

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

To build TDLib on low memory devices you can run SplitSource.php script before compiling main TDLib source code and compile only needed targets:

mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build . --target prepare_cross_compiling
cd ..
php SplitSource.php
cd build
cmake --build . --target tdjson
cmake --build . --target tdjson_static
cd ..
php SplitSource.php --undo

In our tests clang 6.0 with libc++ required less than 500 MB of RAM per file and GCC 4.9/6.3 used less than 1 GB of RAM per file.

+

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 install it system-wide.

+

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

+
    +
  • Td::TdJson, Td::TdJsonStatic — dynamic and static version of a JSON interface. This has a simple C interface, so it can be easily used with any programming language that is able to execute C functions. See td_json_client documentation for more information.
    • +
  • Td::TdStatic — static library with C++ interface for general usage. See ClientManager and Client documentation for more information.
    • +
+

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.8.0 REQUIRED)
target_link_libraries(YourTarget PRIVATE Td::TdStatic)

See example/cpp/CMakeLists.txt.

+

Using in Java projects

+

TDLib provides native Java interface through JNI. To enable it, specify option -DTD_ENABLE_JNI=ON to CMake.

+

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

+

Using in .NET projects

+

TDLib provides native .NET interface through C++/CLI and C++/CX. To enable it, specify option -DTD_ENABLE_DOTNET=ON to CMake. .NET Core supports C++/CLI only since version 3.1 and only on Windows, so if older .NET Core is used or portability is needed, then TDLib JSON interface should be used through P/Invoke instead.

+

See example/csharp for example of using TDLib from C# and detailed build and usage instructions. See example/uwp for example of using TDLib from C# UWP application and detailed build and usage instructions for Visual Studio Extension "TDLib for Universal Windows Platform".

+

When TDLib is built with TD_ENABLE_DOTNET option enabled, C++ documentation is removed from some files. You need to checkout these files to return C++ documentation back:

git checkout td/telegram/Client.h td/telegram/Log.h td/tl/TlObject.h

Using from other programming languages

+

TDLib provides efficient native C++, Java, and .NET interfaces. But for most use cases we suggest to use the JSON interface, which can be easily used with any programming language that is able to execute C functions. See td_json_client documentation for detailed JSON interface description, the td_api.tl scheme or the automatically generated HTML documentation for a list of all available TDLib methods and classes.

+

TDLib JSON interface adheres to semantic versioning and versions with the same major version number are binary and backward compatible, but the underlying TDLib API can be different for different minor and even patch versions. If you need to support different TDLib versions, then you can use a value of the version option to find exact TDLib version to use appropriate API methods.

+

See example/python/tdjson_example.py for an example of such usage.

+

License

+

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

+
+
+ + +
+
+
+
+
Telegram
+
+ Telegram is a cloud-based mobile and desktop messaging app with a focus on security and speed. +
+
+
About
+ +
+
+
Mobile Apps
+ +
+
+
Desktop Apps
+ +
+
+
Platform
+ +
+
+
+
+
About
+
+
+
Blog
+
+
+
Apps
+
+
+
Platform
+
+
+
Twitter
+
+
+
+ + + diff --git a/data/web/core.telegram.org/tdlib/docs/td__json__client_8h.html b/data/web/core.telegram.org/tdlib/docs/td__json__client_8h.html new file mode 100644 index 0000000000..e3c9c656b8 --- /dev/null +++ b/data/web/core.telegram.org/tdlib/docs/td__json__client_8h.html @@ -0,0 +1,502 @@ + + + + + + + + +TDLib: td/telegram/td_json_client.h File Reference + + + + + + + + + + + + +
+
+
+
+
+ + +
+
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Typedefs | +Functions
+
+
td_json_client.h File Reference
+
+
+

Description

+

C interface for interaction with TDLib via JSON-serialized objects. Can be used to easily integrate TDLib with any programming language which supports calling C functions and is able to work with JSON.

+

The JSON serialization of TDLib API objects is straightforward: all API objects are represented as JSON objects with the same keys as the API object field names. The object type name is stored in the special field "@type" which is optional in places where type is uniquely determined by the context. Fields of Bool type are stored as Boolean, fields of int32, int53, and double types are stored as Number, fields of int64 and string types are stored as String, fields of bytes type are base64 encoded and then stored as String, fields of array type are stored as Array.

+

The main TDLib interface is asynchronous. To match requests with a corresponding response, the field "@extra" can be added to the request object. The corresponding response will have an "@extra" field with exactly the same value. Each returned object will have an "@client_id" field, containing the identifier of the client for which a response or an update was received.

+

A TDLib client instance can be created through td_create_client_id. Requests can be sent using td_send and the received client identifier. New updates and responses to requests can be received through td_receive from any thread after the first request has been sent to the client instance. This function must not be called simultaneously from two different threads. Also note that all updates and responses to requests must be applied in the order they were received for consistency. Some TDLib requests can be executed synchronously from any thread using td_execute. TDLib client instances are destroyed automatically after they are closed. All TDLib client instances must be closed before application termination to ensure data consistency.

+

General pattern of usage:

int client_id = td_create_client_id();
// share the client_id with other threads, which will be able to send requests via td_send
const double WAIT_TIMEOUT = 10.0; // seconds
while (true) {
const char *result = td_receive(WAIT_TIMEOUT);
if (result) {
// parse the result as a JSON object and process it as an incoming update or the answer to a previously sent request
}
}

Alternatively, you can use old TDLib JSON interface, which will be removed in TDLib 2.0.0.

+

Objects and functions serialization to JSON is the same for both JSON interfaces.

+

The main TDLib interface is asynchronous. To match requests with a corresponding response a field "@extra" can be added to the request object. The corresponding response will have an "@extra" field with exactly the same value.

+

A TDLib client instance can be created through td_json_client_create. Requests then can be sent using td_json_client_send from any thread. New updates and request responses can be received through td_json_client_receive from any thread. This function must not be called simultaneously from two different threads. Also note that all updates and request responses must be applied in the order they were received to ensure consistency. Given this information, it's advisable to call this function from a dedicated thread. Some service TDLib requests can be executed synchronously from any thread by using td_json_client_execute. The TDLib client instance can be destroyed via td_json_client_destroy.

+

General pattern of usage:

void *client = td_json_client_create();
// somehow share the client with other threads, which will be able to send requests via td_json_client_send
const double WAIT_TIMEOUT = 10.0; // seconds
int is_closed = 0; // should be set to 1, when updateAuthorizationState with authorizationStateClosed is received
while (!is_closed) {
const char *result = td_json_client_receive(client, WAIT_TIMEOUT);
if (result) {
// parse the result as JSON object and process it as an incoming update or an answer to a previously sent request
}
}
td_json_client_destroy(client);
+

Go to the source code of this file.

+ + + + +

+Typedefs

typedef void(* td_log_message_callback_ptr) (int verbosity_level, const char *message)
 
+ + + + + + + + + + + + + + + + + + + + + +

+Functions

int td_create_client_id ()
 
void td_send (int client_id, const char *request)
 
const char * td_receive (double timeout)
 
const char * td_execute (const char *request)
 
void td_set_log_message_callback (int max_verbosity_level, td_log_message_callback_ptr callback)
 
void * td_json_client_create ()
 
void td_json_client_send (void *client, const char *request)
 
const char * td_json_client_receive (void *client, double timeout)
 
const char * td_json_client_execute (void *client, const char *request)
 
void td_json_client_destroy (void *client)
 
+

Typedef Documentation

+ +

◆ td_log_message_callback_ptr

+ +
+
+ + + + +
typedef void(* td_log_message_callback_ptr) (int verbosity_level, const char *message)
+
+

A type of callback function that will be called when a message is added to the internal TDLib log.

+
Parameters
+ + + +
verbosity_levelLog verbosity level with which the message was added (-1 - 1024). If 0, then TDLib will crash as soon as the callback returns. None of the TDLib methods can be called from the callback.
messageNull-terminated string with the logged message.
+
+
+ +
+
+

Function Documentation

+ +

◆ td_create_client_id()

+ +
+
+ + + + + + + +
int td_create_client_id ()
+
+

Returns an opaque identifier of a new TDLib instance. The TDLib instance will not send updates until the first request is sent to it.

Returns
Opaque identifier of a new TDLib instance.
+ +
+
+ +

◆ td_send()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void td_send (int client_id,
const char * request 
)
+
+

Sends request to the TDLib client. May be called from any thread.

Parameters
+ + + +
[in]client_idTDLib client identifier.
[in]requestJSON-serialized null-terminated request to TDLib.
+
+
+ +
+
+ +

◆ td_receive()

+ +
+
+ + + + + + + + +
const char* td_receive (double timeout)
+
+

Receives incoming updates and request responses. Must not be called simultaneously from two different threads. The returned pointer can be used until the next call to td_receive or td_execute, after which it will be deallocated by TDLib.

Parameters
+ + +
[in]timeoutThe maximum number of seconds allowed for this function to wait for new data.
+
+
+
Returns
JSON-serialized null-terminated incoming update or request response. May be NULL if the timeout expires.
+ +
+
+ +

◆ td_execute()

+ +
+
+ + + + + + + + +
const char* td_execute (const char * request)
+
+

Synchronously executes a TDLib request. A request can be executed synchronously, only if it is documented with "Can be called synchronously". The returned pointer can be used until the next call to td_receive or td_execute, after which it will be deallocated by TDLib.

Parameters
+ + +
[in]requestJSON-serialized null-terminated request to TDLib.
+
+
+
Returns
JSON-serialized null-terminated request response.
+ +
+
+ +

◆ td_set_log_message_callback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void td_set_log_message_callback (int max_verbosity_level,
td_log_message_callback_ptr callback 
)
+
+

Sets the callback that will be called when a message is added to the internal TDLib log. None of the TDLib methods can be called from the callback. By default the callback is not set.

+
Parameters
+ + + +
[in]max_verbosity_levelThe maximum verbosity level of messages for which the callback will be called.
[in]callbackCallback that will be called when a message is added to the internal TDLib log. Pass nullptr to remove the callback.
+
+
+ +
+
+ +

◆ td_json_client_create()

+ +
+
+ + + + + + + +
void* td_json_client_create ()
+
+

Creates a new instance of TDLib.

Returns
Pointer to the created instance of TDLib.
+ +
+
+ +

◆ td_json_client_send()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void td_json_client_send (void * client,
const char * request 
)
+
+

Sends request to the TDLib client. May be called from any thread.

Parameters
+ + + +
[in]clientThe client.
[in]requestJSON-serialized null-terminated request to TDLib.
+
+
+ +
+
+ +

◆ td_json_client_receive()

+ +
+
+ + + + + + + + + + + + + + + + + + +
const char* td_json_client_receive (void * client,
double timeout 
)
+
+

Receives incoming updates and request responses from the TDLib client. May be called from any thread, but must not be called simultaneously from two different threads. Returned pointer will be deallocated by TDLib during next call to td_json_client_receive or td_json_client_execute in the same thread, so it can't be used after that.

Parameters
+ + + +
[in]clientThe client.
[in]timeoutThe maximum number of seconds allowed for this function to wait for new data.
+
+
+
Returns
JSON-serialized null-terminated incoming update or request response. May be NULL if the timeout expires.
+ +
+
+ +

◆ td_json_client_execute()

+ +
+
+ + + + + + + + + + + + + + + + + + +
const char* td_json_client_execute (void * client,
const char * request 
)
+
+

Synchronously executes TDLib request. May be called from any thread. Only a few requests can be executed synchronously. Returned pointer will be deallocated by TDLib during next call to td_json_client_receive or td_json_client_execute in the same thread, so it can't be used after that.

Parameters
+ + + +
[in]clientThe client. Currently ignored for all requests, so NULL can be passed.
[in]requestJSON-serialized null-terminated request to TDLib.
+
+
+
Returns
JSON-serialized null-terminated request response.
+ +
+
+ +

◆ td_json_client_destroy()

+ +
+
+ + + + + + + + +
void td_json_client_destroy (void * client)
+
+

Destroys the TDLib client instance. After this is called the client instance must not be used anymore.

Parameters
+ + +
[in]clientThe client.
+
+
+ +
+
+
+ + +
+
+
+
+
Telegram
+
+ Telegram is a cloud-based mobile and desktop messaging app with a focus on security and speed. +
+
+
About
+ +
+
+
Mobile Apps
+ +
+
+
Desktop Apps
+ +
+
+
Platform
+ +
+
+
+
+
About
+
+
+
Blog
+
+
+
Apps
+
+
+
Platform
+
+
+
Twitter
+
+
+
+ + +