Inherited Methods
Class: VSocket
- VSocket::__construct()
- Class constructor
- VSocket::accept()
- Accept an incomming connection
- VSocket::bind()
- Bind socket
- VSocket::close()
- Close socket
- VSocket::connect()
- Connect to remote socket
- VSocket::disconnect()
- Disconnect
- VSocket::doSelect()
- Monitor sockets for selected change
- VSocket::getDomain()
- Get socket domain
- VSocket::getOption()
- Get a socket option
- VSocket::getPeerName()
- Get peer connection info
- VSocket::getProtocol()
- Get protocol of socket
- VSocket::getProtocolName()
- Get protocol name
- VSocket::getSockName()
- Get Socket connection info
- VSocket::getSupportedProtocols()
- Get list of supported protocols
- VSocket::getType()
- Get socket type
- VSocket::listen()
- Listen for connection
- VSocket::raiseError()
- Generate a socket error
- VSocket::read()
- Read from socket
- VSocket::recv()
- Receive data from socket
- VSocket::recvFrom()
- Receive data from socket even if not connection oriented
- VSocket::send()
- Send data from socket
- VSocket::sendTo()
- Send data from socket even if not connection oriented
- VSocket::setBlock()
- Set socket blocking
- VSocket::setDomain()
- Set the socket domain
- VSocket::setOption()
- Set a socket option
- VSocket::setProtocol()
- Set protocol
- VSocket::setType()
- Set socket type
- VSocket::shutdown()
- Shutdown socket
- VSocket::write()
- Write to socket
Class: VObject
- VObject::__construct()
- Class Constructor
- VObject::bind()
- Bind values to this object
- VObject::delete()
- Delete Object
- VObject::get()
- Get value
- VObject::getAll()
- Get all object values
- VObject::getError()
- Get error message
- VObject::getErrors()
- Get errors
- VObject::getMethods()
- Get object methods
- VObject::getProperties()
- Get object properties
- VObject::save()
- Save Object
- VObject::set()
- Set a value
- VObject::setError()
- Set error value
- VObject::setProperties()
- Set property values
- VObject::setProperty()
- Set property value
- VObject::toString()
- Convert object to string
- VObject::__destruct()
- Class Destructor
- VObject::__toString()
- Return object as a string
Class Details
Virtual Web Platform - FTP Data Line
This class provides the data connection for FTP Clients.
Tags:
- author - Ralph Ritoch <rritoch@gmail.com>
- copyright - (c) Ralph Ritoch - All Rights Reserved
- link - VNetPublishing.Com
- license - VNETLPL Limited Public License
[ Top ]
Class Variables
$passive = null
[line 43]
Tags:
- var - Passive connection
- access - protected
Type: boolean
Overrides:
[ Top ]
$pasv_host = null
[line 50]
Tags:
- var - Host for passive connection
- access - protected
Type: string
Overrides:
[ Top ]
$pasv_port = null
[line 57]
Tags:
- var - Host for passive connection
- access - protected
Type: string
Overrides:
[ Top ]
$timeout = 30
[line 64]
Tags:
- var - Connection timeout
- access - protected
Type: integer
Overrides:
[ Top ]
Class Methods
connect
true|object True connect(
string
$host, [integer
$port = 0])
[line 204]
Establish connection
Tags:
- return - on success, error or warning on failure
- access - public
Overrides VSocket::connect() (Connect to remote socket)
Parameters:
- string $host - Host address
- integer $port - Host port
[ Top ]
getHost
string|obect getHost(
)
[line 74]
Get socket address
Tags:
- return - Host address on success, error or warning on failure
- access - public
Parameters:
[ Top ]
getPort
string|obejct getPort(
)
[line 90]
Get socket port
Tags:
- return - Host port on success, error or warning on failure
- access - public
Parameters:
[ Top ]
read
string|object Data read(
integer|false
$length, [integer
$type = PHP_BINARY_READ])
[line 156]
Read data from data line
Tags:
- return - on success, error or warning on failure
Overrides VSocket::read() (Read from socket)
Parameters:
- integer|false $length - Number of bytes to read or false to read until no data is available
- integer $type - Read type (see php documentation of socket_read)
[ Top ]
setActive
true|object True setActive(
[string
$host = 0], [integer
$port = 0])
[line 107]
Set active state
Tags:
- return - on success, error or warning on failure
Parameters:
- string $host - Host interface to bind to
- integer $port - Host port to bind to
[ Top ]
setPassive
true|object True setPassive(
string
$host, [integer
$port = 22])
[line 125]
Set passive state
Tags:
- return - on success, error or warning on failure
Parameters:
- string $host - Host interface to bind to
- integer $port - Host port to bind to
[ Top ]
setTimeout
void setTimeout(
integer
$timeout)
[line 144]
Set timeout
Tags:
- access - public
Parameters:
- integer $timeout - Timeout in seconds
[ Top ]