\TTransport

Base interface for a transport agent.

Summary

Methods
Properties
Constants
isOpen()
open()
close()
read()
readAll()
write()
flush()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

isOpen()

isOpen() : boolean

Whether this transport is open.

Returns

boolean —

true if open

open()

open() 

Open the transport for reading/writing

Throws

\TTransportException

if cannot open

close()

close() 

Close the transport.

read()

read(integer  $len) : string

Read some data into the array.

Parameters

integer $len

How much to read

Throws

\TTransportException

if cannot read any more data

Returns

string —

The data that has been read

readAll()

readAll(  $len) : string

Guarantees that the full amount of data is read.

Parameters

$len

Throws

\TTransportException

if cannot read data

Returns

string —

The data, of exact length

write()

write(string  $buf) 

Writes the given data out.

Parameters

string $buf

The data to write

Throws

\TTransportException

if writing fails

flush()

flush() 

Flushes any pending data out of a buffer

Throws

\TTransportException

if a writing error occurs