danog\MadelineProto\Settings\Connection

Back to index

Author: Daniil Gentili daniil@daniil.it

Connection settings.

Method list:

• __construct()
• init(): void
• getProtocol(): string
• setProtocol(class-string<\danog\MadelineProto\Stream\MTProtoBufferInterface> $protocol): \danog\MadelineProto\Settings\Connection
• getIpv6(): bool
• setIpv6(bool $ipv6): \danog\MadelineProto\Settings\Connection
• getSslSubdomains(): array
• setSslSubdomains(array $sslSubdomains): \danog\MadelineProto\Settings\Connection
• getMaxMediaSocketCount(): int
• setMaxMediaSocketCount(int $maxMediaSocketCount): \danog\MadelineProto\Settings\Connection
• getRobinPeriod(): int
• setRobinPeriod(int $robinPeriod): \danog\MadelineProto\Settings\Connection
• getProxies(): array<class-string<\danog\MadelineProto\Stream\StreamInterface>, array>
• addProxy(class-string<\danog\MadelineProto\Stream\StreamInterface> $proxy, array $extra = []): \danog\MadelineProto\Settings\Connection
• setProxies(array<class-string<\danog\MadelineProto\Stream\StreamInterface>, list<array>> $proxies): \danog\MadelineProto\Settings\Connection
• clearProxies(): \danog\MadelineProto\Settings\Connection
• removeProxy(string $proxy, array $extra): \danog\MadelineProto\Settings\Connection
• getObfuscated(): bool
• setObfuscated(bool $obfuscated): \danog\MadelineProto\Settings\Connection
• getTestMode(): bool
• setTestMode(bool $testMode): \danog\MadelineProto\Settings\Connection
• getTransport(): class-string<\danog\MadelineProto\Stream\RawStreamInterface>
• setTransport(class-string<\danog\MadelineProto\Stream\RawStreamInterface> $transport): \danog\MadelineProto\Settings\Connection
• getRetry(): bool
• setRetry(bool $retry): \danog\MadelineProto\Settings\Connection
• getTimeout(): float
• setTimeout(float $timeout): \danog\MadelineProto\Settings\Connection
• getPingInterval(): int
• setPingInterval(int $pingInterval): \danog\MadelineProto\Settings\Connection
• getUseDoH(): bool
• setUseDoH(bool $useDoH): \danog\MadelineProto\Settings\Connection
• getBindTo(): ?string
• setBindTo((null|string) $bindTo): \danog\MadelineProto\Settings\Connection
• getRsaKeys(): array
• setRsaKeys(array $rsaKeys): \danog\MadelineProto\Settings\Connection
• getTestRsaKeys(): array
• setTestRsaKeys(array $testRsaKeys): \danog\MadelineProto\Settings\Connection

Methods:

__construct()

init(): void

getProtocol(): string

Get protocol identifier.

setProtocol(class-string<\danog\MadelineProto\Stream\MTProtoBufferInterface> $protocol): \danog\MadelineProto\Settings\Connection

Set protocol identifier.

Available MTProto transport protocols (smaller overhead is better):

• \danog\MadelineProto\Stream\MTProtoTransport\AbridgedStream: Lightest protocol available

  • Overhead: Very small
    
  • Minimum envelope length: 1 byte (length)
    
  • Maximum envelope length: 4 bytes (length)
    

• \danog\MadelineProto\Stream\MTProtoTransport\IntermediateStream: I guess they like having multiple protocols

  • Overhead: small
    
  • Minimum envelope length: 4 bytes (length)
    
  • Maximum envelope length: 4 bytes (length)
    

• \danog\MadelineProto\Stream\MTProtoTransport\IntermediatePaddedStream: Padded version of the intermediate protocol, to use with obfuscation enabled to bypass ISP blocks

  • Overhead: small-medium
    
  • Minimum envelope length: random
    
  • Maximum envelope length: random
    

• \danog\MadelineProto\Stream\MTProtoTransport\FullStream: The basic MTProto transport protocol

  • Overhead: medium
    

  • Minimum envelope length: 12 bytes (length+seqno+crc)
    

  • Maximum envelope length: 12 bytes (length+seqno+crc)
    

  • Pros:
    

  • Initial integrity check with crc32
    

  • Transport sequence number check

  • Cons:

  • Initial integrity check with crc32 is not that useful since the TCP protocol already uses it internally

  • Transport sequence number check is also not that useful since transport sequence numbers are not encrypted and thus cannot be used to avoid replay attacks, and MadelineProto already uses MTProto sequence numbers and message ids for that.

• \danog\MadelineProto\Stream\MTProtoTransport\HttpStream: MTProto over HTTP for browsers and webhosts

  • Overhead: medium
    
  • Pros:
    
  • Can be used on restricted webhosts or browsers
    
  • Cons:
    
  • Very big envelope length
    

• \danog\MadelineProto\Stream\MTProtoTransport\HttpsStream: MTProto over HTTPS for browsers and webhosts, very secure

  • Overhead: high
    
  • Pros:
    
  • Can be used on restricted webhosts or browsers
    
  • Provides an additional layer of security by trasmitting data over TLS
    
  • Integrity checks with HMAC built into TLS
    
  • Sequence number checks built into TLS
    
  • Cons:
    
  • Very big envelope length
    
  • Requires an additional round of encryption
    

Parameters:

• $protocol: class-string<\danog\MadelineProto\Stream\MTProtoBufferInterface> Protocol identifier
  

See also:

• \danog\MadelineProto\Stream\MTProtoBufferInterface

getIpv6(): bool

Get whether to use ipv6.

setIpv6(bool $ipv6): \danog\MadelineProto\Settings\Connection

Set whether to use ipv6.

Parameters:

• $ipv6: bool Whether to use ipv6
  

getSslSubdomains(): array

Get subdomains of web.telegram.org for https protocol.

setSslSubdomains(array $sslSubdomains): \danog\MadelineProto\Settings\Connection

Set subdomains of web.telegram.org for https protocol.

Parameters:

• $sslSubdomains: array Subdomains of web.telegram.org for https protocol.
  

getMaxMediaSocketCount(): int

Get maximum media socket count.

setMaxMediaSocketCount(int $maxMediaSocketCount): \danog\MadelineProto\Settings\Connection

Set maximum media socket count.

Parameters:

• $maxMediaSocketCount: int Maximum media socket count.
  

getRobinPeriod(): int

Get robin period (seconds).

setRobinPeriod(int $robinPeriod): \danog\MadelineProto\Settings\Connection

Set robin period (seconds).

Parameters:

• $robinPeriod: int Robin period (seconds).
  

getProxies(): array<class-string<\danog\MadelineProto\Stream\StreamInterface>, array>

Get proxy identifiers.

See also:

• \danog\MadelineProto\Stream\StreamInterface

addProxy(class-string<\danog\MadelineProto\Stream\StreamInterface> $proxy, array $extra = []): \danog\MadelineProto\Settings\Connection

Add proxy identifier to list, one of:.

• \danog\MadelineProto\Stream\MTProtoTransport\ObfuscatedStream::class
  
• \danog\MadelineProto\Stream\Proxy\HttpProxy::class
  
• \danog\MadelineProto\Stream\Proxy\SocksProxy::class
  

Parameters:

• $proxy: class-string<\danog\MadelineProto\Stream\StreamInterface> Proxy identifier
  
• $extra: array Extra
  

See also:

• \danog\MadelineProto\Stream\StreamInterface

setProxies(array<class-string<\danog\MadelineProto\Stream\StreamInterface>, list<array>> $proxies): \danog\MadelineProto\Settings\Connection

Set proxies.

The key must be one of:

• \danog\MadelineProto\Stream\MTProtoTransport\ObfuscatedStream::class
  
• \danog\MadelineProto\Stream\Proxy\HttpProxy::class
  
• \danog\MadelineProto\Stream\Proxy\SocksProxy::class
  

The value must be a list of extra (URI, username, password) for that proxy.

Parameters:

• $proxies: array<class-string<\danog\MadelineProto\Stream\StreamInterface>, list<array>> Proxies
  

See also:

• \danog\MadelineProto\Stream\StreamInterface

clearProxies(): \danog\MadelineProto\Settings\Connection

Clear proxies.

removeProxy(string $proxy, array $extra): \danog\MadelineProto\Settings\Connection

Remove specific proxy pair.

Parameters:

• $proxy: string
  
• $extra: array
  

getObfuscated(): bool

Get whether to use the obfuscated protocol: useful to bypass ISP blocks.

setObfuscated(bool $obfuscated): \danog\MadelineProto\Settings\Connection

Set whether to use the obfuscated protocol: useful to bypass ISP blocks.

Parameters:

• $obfuscated: bool Whether to use the obfuscated protocol.
  

getTestMode(): bool

Get whether we’re in test mode.

setTestMode(bool $testMode): \danog\MadelineProto\Settings\Connection

Set whether we’re in test mode.

Parameters:

• $testMode: bool Whether we’re in test mode.
  

getTransport(): class-string<\danog\MadelineProto\Stream\RawStreamInterface>

Get transport identifier.

See also:

• \danog\MadelineProto\Stream\RawStreamInterface

setTransport(class-string<\danog\MadelineProto\Stream\RawStreamInterface> $transport): \danog\MadelineProto\Settings\Connection

Sets the transport protocol to use when connecting to telegram. Not supported by HTTP and HTTPS protocols, obfuscation must be enabled.

• danog\MadelineProto\Stream\Transport: Default TCP transport
  
• danog\MadelineProto\Stream\WsTransport: Plain websocket transport
  
• danog\MadelineProto\Stream\WssTransport: TLS websocket transport
  

Parameters:

• $transport: class-string<\danog\MadelineProto\Stream\RawStreamInterface> Transport identifier.
  

See also:

• \danog\MadelineProto\Stream\RawStreamInterface

getRetry(): bool

Get whether to retry connection.

setRetry(bool $retry): \danog\MadelineProto\Settings\Connection

Set whether to retry connection.

Parameters:

• $retry: bool Whether to retry connection.
  

getTimeout(): float

Get connection timeout.

setTimeout(float $timeout): \danog\MadelineProto\Settings\Connection

Set connection timeout.

Parameters:

• $timeout: float Connection timeout.
  

getPingInterval(): int

Get ping interval.

setPingInterval(int $pingInterval): \danog\MadelineProto\Settings\Connection

Set ping interval.

Parameters:

• $pingInterval: int Ping interval
  

getUseDoH(): bool

Get whether to use DNS over HTTPS.

setUseDoH(bool $useDoH): \danog\MadelineProto\Settings\Connection

Set whether to use DNS over HTTPS.

Parameters:

• $useDoH: bool Whether to use DNS over HTTPS
  

getBindTo(): ?string

Get bind on specific address and port.

setBindTo((null|string) $bindTo): \danog\MadelineProto\Settings\Connection

Set bind on specific address and port.

Parameters:

• $bindTo: (null|string) Bind on specific address and port.
  

getRsaKeys(): array

Get RSA keys.

setRsaKeys(array $rsaKeys): \danog\MadelineProto\Settings\Connection

Set RSA keys.

Parameters:

• $rsaKeys: array RSA keys
  

getTestRsaKeys(): array

Get test RSA keys.

setTestRsaKeys(array $testRsaKeys): \danog\MadelineProto\Settings\Connection

Set test RSA keys.

Parameters:

• $testRsaKeys: array Test RSA keys
  

Generated by danog/phpdoc