Documentation

WaitingStream
in package
implements StreamInterface uses StreamDecoratorTrait

FinalYes

Table of Contents

Interfaces

StreamInterface

Methods

__construct()  : mixed
__toString()  : string
close()  : void
detach()  : resource|null
eof()  : bool
getContents()  : string
getMetadata()  : array<string|int, mixed>|mixed|null
getSize()  : int|null
isReadable()  : bool
isSeekable()  : bool
isWritable()  : bool
read()  : string
seek()  : void
tell()  : int
write()  : int

Methods

__construct()

public __construct(StreamInterface $stream, int $waitInMicroseconds[, array<string|int, mixed>|null $heartbeat = null ]) : mixed
Parameters
$stream : StreamInterface
$waitInMicroseconds : int
$heartbeat : array<string|int, mixed>|null = null

__toString()

public __toString() : string
Return values
string

detach()

public detach() : resource|null
Return values
resource|null

getContents()

public getContents() : string
Return values
string

getMetadata()

public getMetadata([string|null $key = null ]) : array<string|int, mixed>|mixed|null
Parameters
$key : string|null = null
Return values
array<string|int, mixed>|mixed|null

getSize()

public getSize() : int|null
Return values
int|null

read()

public read(int $length) : string
Parameters
$length : int
Return values
string

seek()

public seek(int $offset[, int $whence = SEEK_SET ]) : void
Parameters
$offset : int
$whence : int = SEEK_SET
Tags
throws
BadMethodCallException

write()

public write(string $string) : int
Parameters
$string : string
Tags
throws
BadMethodCallException
Return values
int
On this page

Search results