TDLib
Loading...
Searching...
No Matches
td::td_api::testProxy Class Referencefinal

Inherits td::td_api::Function.

Public Types

using ReturnType = object_ptr< ok >
 Typedef for the type returned by the function.
 

Public Member Functions

 testProxy ()
 
 testProxy (string const &server_, int32 port_, object_ptr< ProxyType > &&type_, int32 dc_id_, double timeout_)
 
std::int32_t get_id () const final
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Member Functions inherited from td::TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Public Attributes

string server_
 Proxy server domain or IP address.
 
int32 port_
 Proxy server port.
 
object_ptr< ProxyTypetype_
 Proxy type.
 
int32 dc_id_
 Identifier of a datacenter with which to test connection.
 
double timeout_
 The maximum overall timeout for the request.
 

Static Public Attributes

static const std::int32_t ID = -1197366626
 Identifier uniquely determining a type of the object.
 

Detailed Description

Sends a simple network request to the Telegram servers via proxy; for testing only. Can be called before authorization.

Returns object_ptr<Ok>.

Constructor & Destructor Documentation

◆ testProxy() [1/2]

td::td_api::testProxy::testProxy ( )

Default constructor for a function, which sends a simple network request to the Telegram servers via proxy; for testing only. Can be called before authorization.

Returns object_ptr<Ok>.

◆ testProxy() [2/2]

td::td_api::testProxy::testProxy ( string const &  server_,
int32  port_,
object_ptr< ProxyType > &&  type_,
int32  dc_id_,
double  timeout_ 
)

Creates a function, which sends a simple network request to the Telegram servers via proxy; for testing only. Can be called before authorization.

Returns object_ptr<Ok>.

Parameters
[in]server_Proxy server domain or IP address.
[in]port_Proxy server port.
[in]type_Proxy type.
[in]dc_id_Identifier of a datacenter with which to test connection.
[in]timeout_The maximum overall timeout for the request.

Member Function Documentation

◆ get_id()

std::int32_t td::td_api::testProxy::get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements td::TlObject.

◆ store()

void td::td_api::testProxy::store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements td::TlObject.


The documentation for this class was generated from the following file: