Class: VSocket

Source Location: /libraries/vwp/net/socket.php

Class Overview [line 38]

VType
   |
   --VObject
      |
      --VSocket

Virtual Web Platform - Socket support

Author(s):

Version:

Copyright:

  • (c) Ralph Ritoch - All Rights Reserved

Variables

Constants

Methods

Child classes:

VTelnet
Virtual Web Platform - Telnet Protocol (RFC-854)
VSMTP
SMTP Server Support library
VFTPClientDataLine
Virtual Web Platform - FTP Data Line

Inherited Variables

Class: VObject

VObject::$_nosave_errors
VObject::$_nosave_original_state

Inherited Constants

Inherited Methods

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 - Socket support

This file provides the default API for Socket communication.

Tags:

[ Top ]

Class Variables

$errmsg =  null

[line 95]

Tags:

  • var - Last error message
  • access - public

Type: integer

Overrides:

[ Top ]

$errno =  null

[line 88]

Tags:

  • var - Last err
  • access - public

Type: integer

Overrides:

[ Top ]

$_arguments =  null

[line 46]

Tags:

  • var - Arguments
  • access - protected

Type: array

Overrides:

[ Top ]

$_busy =  false

[line 81]

Tags:

  • var - Socket busy
  • access - protected

Type: boolean

Overrides:

[ Top ]

$_domain =  null

[line 60]

Tags:

  • var - Socket domain
  • access - protected

Type: integer

Overrides:

[ Top ]

$_protocol =  null

[line 74]

Tags:

  • var - Socket protocol
  • access - protected

Type: integer

Overrides:

[ Top ]

$_socket =  null

[line 53]

Tags:

  • var - System socket
  • access - protected

Type: mixed

Overrides:

[ Top ]

$_type =  null

[line 67]

Tags:

  • var - Socket type
  • access - protected

Type: integer

Overrides:

[ Top ]

Class Methods

static doSelect

static integer|object Number doSelect( &$read, &$write, &$except, integer $tv_sec, [integer $tv_usec = 0], array $read, array $write, array $except)

[line 465]

Monitor sockets for selected change

Tags:

  • return - of changed sockets on success, error or warning on failure
  • access - public

Parameters:

  • array $read - Sockets to monitor for data
  • array $write - Sockets to monitor for writeability
  • array $except - Sockets to montior for exceptions
  • integer $tv_sec - Timeout in seconds
  • integer $tv_usec - Timeout microseconds
  • &$read -
  • &$write -
  • &$except -

[ Top ]

static getSupportedProtocols

static array getSupportedProtocols( )

[line 208]

Get list of supported protocols

Tags:

  • return - Protocol names indexed by protocol number
  • access - public

Parameters:

[ Top ]

__construct

VSocket __construct( [integer $domain = AF_INET], [integer $type = SOCK_STREAM], [integer $protocol = SOL_TCP], [boolean $create = true])

[line 713]

Class constructor

Tags:

  • access - public

Overridden in child classes as:

VTelnet::__construct()
Class constructor
VSMTP::__construct()
Class constructor
VSMTPClient::__construct()
Class Constructor

Overrides VObject::__construct() (Class Constructor)

Parameters:

  • integer $domain - Socket domain
  • integer $type - Socket type
  • integer $protocol - Socket protocol
  • boolean $create - Create socket

[ Top ]

accept

object Socket &accept( )

[line 300]

Accept an incomming connection

Tags:

  • return - on success, error or warning on failure.
  • access - public

Parameters:

[ Top ]

bind

true|object True bind( string $address, [integer $port = 0])

[line 426]

Bind socket

Tags:

  • return - on success, error or warning on failure
  • access - public

Overrides VObject::bind() (Bind values to this object)

Parameters:

  • string $address - Address to bind to
  • integer $port - Port to bind to

[ Top ]

close

void close( [boolean $shutdown = true], [integer $how = 2])

[line 377]

Close socket 

  possible values for how
   0 Shutdown socket reading
   1 Shutdown socket writing
   2 Shutdown socket reading and writing

Tags:

  • access - public

Parameters:

  • boolean $shutdown - Shutdown first
  • integer $how - How to shutdown

[ Top ]

connect

True connect( string $address, [integer $port = 0])

[line 321]

Connect to remote socket

Tags:

  • return - on success, Error or warning on failure
  • access - public

Overridden in child classes as:

VFTPClient::connect()
Connect to FTP Server
VFTPClientDataLine::connect()
Establish connection

Parameters:

  • string $address - Network address
  • integer $port - Network port

[ Top ]

disconnect

boolean|object True disconnect( )

[line 391]

Disconnect

Tags:

  • return - on success, error or warning otherwise.
  • access - public

Overridden in child classes as:

VFTPClient::disconnect()
Disconnect from FTP server

Parameters:

[ Top ]

getDomain

integer getDomain( )

[line 135]

Get socket domain

Tags:

  • return - Domain
  • access - public

Parameters:

[ Top ]

getOption

true|object True getOption( integer $level, integer $optname)

[line 528]

Get a socket option

Tags:

  • return - on success, error or warning on failure
  • access - public

Parameters:

  • integer $level - Protocol level
  • integer $optname - Option name

[ Top ]

getPeerName

array getPeerName( )

[line 164]

Get peer connection info 

  Returns an array where item 1 is the address.
  If there is a port the second item in the array will hold the port number

Tags:

  • return - Peer connection info
  • access - public

Parameters:

[ Top ]

getProtocol

integer getProtocol( $name)

[line 111]

Get protocol of socket

Tags:

  • return - Protocol
  • access - public

Parameters:

  • $name -

[ Top ]

getProtocolName

string getProtocolName( )

[line 123]

Get protocol name

Tags:

  • return - protocol name
  • access - public

Parameters:

[ Top ]

getSockName

array getSockName( )

[line 188]

Get Socket connection info 

  Returns an array where item 1 is the address.
  If there is a port the second item in the array will hold the port number

Tags:

  • return - local socket connection info

Parameters:

[ Top ]

getType

integer getType( )

[line 147]

Get socket type

Tags:

  • return - Socket type
  • access - public

Parameters:

[ Top ]

listen

true|object True listen( [integer $backlog = 0])

[line 444]

Listen for connection

Tags:

  • return - on success, error or warning on failure
  • access - public

Parameters:

  • integer $backlog - Backlog size

[ Top ]

raiseError

object Error raiseError( [string $errmsg = null], [string $server = null], [integer $errno = null], [boolean $throw = true])

[line 686]

Generate a socket error

Tags:

  • access - public

Overridden in child classes as:

VTelnet::raiseError()
Generate an error

Parameters:

  • string $errmsg - Error message
  • string $server - Service name
  • integer $errno - Error code
  • boolean $throw - Throw error

[ Top ]

read

string|object Data read( integer $length, [integer $type = PHP_BINARY_READ])

[line 586]

Read from socket

Tags:

  • return - read on success, error or warning on failure
  • access - public

Overridden in child classes as:

VFTPClientDataLine::read()
Read data from data line

Parameters:

  • integer $length - Number of bytes to read
  • integer $type - Read type

[ Top ]

recv

integer|object Number recv( &$buff, integer $len, integer $flags, string $buffer)

[line 624]

Receive data from socket

Tags:

  • return - of bytes received on success, error or warning on failure
  • access - public

Parameters:

  • string $buffer - Buffer
  • integer $len - Number of bytes to get
  • integer $flags - Flags
  • &$buff -

[ Top ]

recvFrom

integer|object Number recvFrom( &$buf, integer $len, integer $flags, &$name, &$port, string $buffer, string $addr, integer $port)

[line 666]

Receive data from socket even if not connection oriented

Tags:

  • return - of bytes received on success, error or warning on failure
  • access - public

Parameters:

  • string $buffer - Buffer
  • integer $len - Number of bytes to send
  • integer $flags - Flags
  • string $addr - Network address
  • integer $port - Network port
  • &$buf -
  • &$name -
  • &$port -

[ Top ]

send

integer|object Number send( $buff, integer $len, integer $flags, string $buffer)

[line 605]

Send data from socket

Tags:

  • return - of bytes sent on success, error or warning on failure
  • access - public

Parameters:

  • string $buffer - Buffer
  • integer $len - Number of bytes to send
  • integer $flags - Flags
  • $buff -

[ Top ]

sendTo

integer|object Number sendTo( $buff, integer $len, integer $flags, string $addr, [integer $port = 0], string $buffer)

[line 645]

Send data from socket even if not connection oriented

Tags:

  • return - of bytes sent on success, error or warning on failure
  • access - public

Parameters:

  • string $buffer - Buffer
  • integer $len - Number of bytes to send
  • integer $flags - Flags
  • string $addr - Network address
  • integer $port - Network port
  • $buff -

[ Top ]

setBlock

true|object True setBlock( boolean $block)

[line 404]

Set socket blocking

Tags:

  • return - on success, error or warning on failure
  • access - public

Parameters:

  • boolean $block - Blocking

[ Top ]

setDomain

true|object True setDomain( integer $domain, [boolean $create = true])

[line 230]

Set the socket domain

Tags:

  • return - on success, error or warning on failure.

Parameters:

  • integer $domain - Socket Domain
  • boolean $create - Build socket

[ Top ]

setOption

true|object True setOption( integer $level, string $optname, mixed $optval)

[line 547]

Set a socket option

Tags:

  • return - on success, error or warning on failure
  • access - public

Parameters:

  • integer $level -
  • string $optname - Option name
  • mixed $optval - Option value

[ Top ]

setProtocol

True setProtocol( integer $protocol, [boolean $create = true])

[line 254]

Set protocol

Tags:

  • return - on success, error or warning on failure
  • access - public

Parameters:

  • integer $protocol - Socket Protocol
  • boolean $create - Create socket

[ Top ]

setType

True setType( integer $type, [boolean $create = true])

[line 278]

Set socket type

Tags:

  • return - on success, error or warning on failure
  • access - public

Parameters:

  • integer $type -
  • boolean $create - Create socket

[ Top ]

shutdown

true|object True shutdown( [integer $how = 2])

[line 352]

Shutdown socket 

  possible values for how
   0 Shutdown socket reading
   1 Shutdown socket writing
   2 Shutdown socket reading and writing

Tags:

  • return - on success, error or warning on failure
  • access - public

Parameters:

  • integer $how - How

[ Top ]

write

integer|object Number write( string $buffer, [integer $length = 0])

[line 565]

Write to socket

Tags:

  • return - of bytes written on success, error or warning on failure
  • access - public

Parameters:

  • string $buffer - Buffer
  • integer $length - Number of bytes to write

[ Top ]

Class Constants

Documentation generated on Mon, 17 Jan 2011 01:57:37 -0600 by phpDocumentor 1.4.3