Stream extends Stream
Table of Contents
Methods
- __construct() : mixed
- __toString() : string
- close() : void
- connect() : void
- Connects asynchronously.
- copyTo() : mixed
- detach() : mixed
- enableCrypto() : bool|int
- Enables SSL on an open socket.
- eof() : bool
- getAddress() : string
- Retuns the address to connect.
- getContents() : string
- getMetadata() : mixed
- getResource() : null|resource
- gets() : false|string
- getSize() : int|null
- isReadable() : bool
- isSeekable() : bool
- isWritable() : bool
- read() : string
- rewind() : void
- seek() : void
- setBlocking() : bool
- Sets blocking mode on a socket.
- tell() : int
- timedOut() : bool
- Checks if the socket was timed out.
- write() : int
Methods
__construct()
public
__construct(string $address[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $address : string
- $options : array<string|int, mixed> = []
__toString()
public
__toString() : string
Tags
Return values
stringclose()
public
close() : void
Tags
connect()
Connects asynchronously.
public
connect() : void
copyTo()
public
copyTo(mixed $stream) : mixed
Parameters
- $stream : mixed
detach()
public
detach() : mixed
Tags
enableCrypto()
Enables SSL on an open socket.
public
enableCrypto([bool $enable = true ]) : bool|int
Parameters
- $enable : bool = true
Return values
bool|inteof()
public
eof() : bool
Tags
Return values
boolgetAddress()
Retuns the address to connect.
public
getAddress() : string
Return values
stringgetContents()
public
getContents() : string
Tags
Return values
stringgetMetadata()
public
getMetadata([string|null $key = null ]) : mixed
Parameters
- $key : string|null = null
Tags
getResource()
public
getResource() : null|resource
Return values
null|resourcegets()
public
gets() : false|string
Return values
false|stringgetSize()
public
getSize() : int|null
Tags
Return values
int|nullisReadable()
public
isReadable() : bool
Tags
Return values
boolisSeekable()
public
isSeekable() : bool
Tags
Return values
boolisWritable()
public
isWritable() : bool
Tags
Return values
boolread()
public
read(int $length) : string
Parameters
- $length : int
Tags
Return values
stringrewind()
public
rewind() : void
Tags
seek()
public
seek(int $offset[, int $whence = SEEK_SET ]) : void
Parameters
- $offset : int
- $whence : int = SEEK_SET
Tags
setBlocking()
Sets blocking mode on a socket.
public
setBlocking([bool $enable = true ]) : bool
Parameters
- $enable : bool = true
Return values
booltell()
public
tell() : int
Tags
Return values
inttimedOut()
Checks if the socket was timed out.
public
timedOut() : bool
Return values
boolwrite()
public
write(string $string) : int
Parameters
- $string : string