tdlight/td/telegram/ClientActor.h

104 lines
2.8 KiB
C
Raw Normal View History

//
2021-01-01 13:57:46 +01:00
// Copyright Aliaksei Levin (levlam@telegram.org), Arseny Smirnov (arseny30@gmail.com) 2014-2021
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//
#pragma once
///\file
#include "td/telegram/td_api.h"
#include "td/telegram/td_api.hpp"
2020-11-15 15:38:10 +01:00
#include "td/telegram/TdCallback.h"
#include "td/actor/actor.h"
#include "td/utils/common.h"
#include <memory>
namespace td {
class NetQueryStats;
class Td;
/**
* This is a low-level Actor interface for interaction with TDLib. The interface is a lot more flexible than
2021-09-26 21:17:02 +02:00
* the ClientManager interface, however, for most usages the ClientManager interface should be sufficient.
*/
class ClientActor final : public Actor {
public:
2020-11-15 15:38:10 +01:00
/// Options for ClientActor creation.
struct Options {
2020-11-15 15:38:10 +01:00
/// NetQueryStats object for this client.
std::shared_ptr<NetQueryStats> net_query_stats;
2020-11-15 15:38:10 +01:00
/// Default constructor.
Options() {
}
};
/**
* Creates a ClientActor using the specified callback.
* \param[in] callback Callback for outgoing notifications from TDLib.
2020-11-15 15:38:10 +01:00
* \param[in] options Options to create the TDLib.
*/
explicit ClientActor(unique_ptr<TdCallback> callback, Options options = {});
/**
* Sends one request to TDLib. The answer will be received via callback.
* \param[in] id Request identifier, must be positive.
* \param[in] request The request.
*/
void request(uint64 id, td_api::object_ptr<td_api::Function> request);
/**
* Synchronously executes a TDLib request. Only a few requests can be executed synchronously.
* May be called from any thread.
2020-11-15 15:38:10 +01:00
* \param[in] request Request to the TDLib instance.
* \return The request response.
*/
static td_api::object_ptr<td_api::Object> execute(td_api::object_ptr<td_api::Function> request);
/**
* Destroys the ClientActor and the TDLib instance.
*/
~ClientActor();
/**
* Move constructor.
*/
ClientActor(ClientActor &&other);
/**
* Move assignment operator.
*/
ClientActor &operator=(ClientActor &&other);
ClientActor(const ClientActor &other) = delete;
ClientActor &operator=(const ClientActor &other) = delete;
private:
ActorOwn<Td> td_;
};
2020-11-15 15:38:10 +01:00
/**
* Creates NetQueryStats object, which can be shared between different clients.
*/
std::shared_ptr<NetQueryStats> create_net_query_stats();
/**
* Dumps information about all pending network queries to the internal TDLib log.
* This is useful for library debugging.
*/
void dump_pending_network_queries(NetQueryStats &stats);
/**
* Returns the current number of pending network queries. Useful for library debugging.
* \return Number of currently pending network queries.
*/
uint64 get_pending_network_query_count(NetQueryStats &stats);
} // namespace td