danog
/
MadelineProtoDocs
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
MadelineProtoDocs/docs/PHPInternal/danog/MadelineProto/Stream/BufferedProxyStreamInterfac...

2.2 KiB
Raw Blame History

title: danog\MadelineProto\Stream\BufferedProxyStreamInterface: Buffered proxy stream interface. description:

danog\MadelineProto\Stream\BufferedProxyStreamInterface

Back to index

Author: Daniil Gentili daniil@daniil.it

Buffered proxy stream interface.

Method list:

  • getReadBuffer(int $length): \Amp\Promise
  • getWriteBuffer(int $length): \Amp\Promise
  • getName(): string
  • getStream(): \danog\MadelineProto\Stream\RawStreamInterface
  • connect(\danog\MadelineProto\Stream\ConnectionContext $ctx): \Generator
  • disconnect(): void
  • getSocket(): \Amp\Socket\EncryptableSocket
  • setExtra(mixed $extra): void

Methods:

getReadBuffer(int $length): \Amp\Promise

Get read buffer asynchronously.

Parameters:

  • $length: int Length of payload, as detected by this layer

Fully typed return value:

\Amp\Promise<\danog\MadelineProto\Stream\BufferInterface>

See also:

getWriteBuffer(int $length): \Amp\Promise

Get write buffer asynchronously.

Parameters:

  • $length: int Total length of data that is going to be piped in the buffer

See also:

  • \Amp\Promise

getName(): string

Get stream name. Is supposed to return CLASS

getStream(): \danog\MadelineProto\Stream\RawStreamInterface

Get underlying stream resource.

See also:

connect(\danog\MadelineProto\Stream\ConnectionContext $ctx): \Generator

Connect to a server.

Parameters:

  • $ctx: \danog\MadelineProto\Stream\ConnectionContext The connection context

See also:

disconnect(): void

Disconnect from the server.

getSocket(): \Amp\Socket\EncryptableSocket

Get underlying AMPHP socket resource.

See also:

  • \Amp\Socket\EncryptableSocket

setExtra(mixed $extra): void

Set extra proxy data.

Parameters:

  • $extra: mixed Proxy data

Generated by danog/phpdoc