PEAR Handbuch
Zurück		Nach vorne

Net_Socket

Net_Socket -- Generalized Socket class

Description

Socket enables comfortable handling Socket connections.

Beispiel 1. Using Socket

$socket = new Net_Socket() ;
// open connection
$socket->connect("http://www.example.com", 80, true, 30);
// Send data including linebreak
$socket->writeLine("String with data");
// receive data until linebreak
$result = $socket->readLine();
// receive a number of data
$result = $socket->read(512);
// close connection
$socket->disconnect();

Net_Socket::connect

mixed Net_Socket::connect (string $addr, integer $port, boolean [$persistent], integer [$timeout])

Connect to the specified port. If called when the socket is already connected, it disconnects and connects again.

$addr - IP address or host name
$port - TCP port number
$persistent - whether the connection is persistent (kept open between requests by the web server). Default is false, no persistent connection
$timeout - how long to wait for data

Returns

mixed - true on success or a PEAR_Error

Net_Socket::disconnect

mixed Net_Socket::disconnect ()

Disconnects from the peer, closes the socket.

mixed - true on success or a PEAR_Error otherwise

Net_Socket::isBlocking

boolean Net_Socket::isBlocking ()

Find out if the socket is in blocking mode.

Returns

boolean - the current blocking mode

Net_Socket::setBlocking

void Net_Socket::setBlocking (boolean $mode)

Sets whether the socket connection should be blocking or not. A read call to a non-blocking socket will return immediately if there is no data available, whereas it will block until there is data for blocking sockets.

Warnung

If you use readAll() on a connection in blocking mode, the function will be not terminated until the socket connection will be closed.

$mode - true for blocking sockets, false for nonblocking

Net_Socket::setTimeout

mixed Net_Socket::setTimeout (integer $seconds, integer $microseconds)

Sets the timeout value on socket descriptor, expressed in the sum of seconds and microseconds

$seconds - seconds part
$microseconds - microseconds part

Returns

mixed - true on success or a PEAR_Error on failure

Net_Socket::getStatus

mixed Net_Socket::getStatus ()

Returns information about an existing socket resource. Currently returns four entries in the result array:

timed_out (bool) - The socket timed out waiting for data
blocked (bool) - The socket was blocked
eof (bool) - Indicates EOF event
unread_bytes (int) - Number of bytes left in the socket buffer

Returns

mixed - result array on success or a PEAR_Error on failure

Net_Socket::gets

mixed Net_Socket::gets (integer $size)

Returns a string containing data from the socket connection

$size - max number of chars to recieve

Returns

mixed - the data as string or a PEAR_Error on failure

Net_Socket::read

mixed Net_Socket::read (integer $size)

Read a specified amount of data. This is guaranteed to return, and has the added benefit of getting everything in one fread() chunk; if you know the size of the data you're getting beforehand, this is definitely the way to go.

$size - max number of bytes to read from the socket

Returns

mixed - the data as string or a PEAR_Error if not connected

Net_Socket::write

mixed Net_Socket::write (string $data)

Write data to a socket connection

$data - the data to write

Returns

mixed - PEAR_Error, if not connected or the message of the write function

Net_Socket::writeLine

mixed Net_Socket::writeLine (string $data)

Write a line of data to a socket connection, followed by a trailing "\r\n".

$data - the data to write

Returns

mixed - fputs result, or an PEAR_Error

Net_Socket::eof

boolean Net_Socket::eof ()

fire true if the connection is closed or input stream finished

boolean - true, if no connection exists anymore

Net_Socket::readByte

mixed Net_Socket::readByte ()

Read a byte from the socket stream

mixed - data from the socket, or a PEAR_Error if not connected.

Net_Socket::readWord

mixed Net_Socket::readWord ()

Reads a word from the socket stream Word means a binary word, not a word in a language

mixed - data from the socket, or a PEAR_Error if not connected.

Net_Socket::readInt

mixed Net_Socket::readInt ()

Reads a integer number from the socket stream. The length of a integer is 4 bytes

mixed - data from the socket, or a PEAR_Error if not connected.

Net_Socket::readIPAddress

mixed Net_Socket::readIPAddress ()

Reads a IP from the socket stream The function expect a integer which will converted to a IP address. This function only works with IPv4 addresses.

mixed - data from the socket, or a PEAR_Error if not connected.

Net_Socket::readLine

mixed Net_Socket::readLine ()

Read until either the end of the socket or a newline, whichever comes first. Strips the trailing newline from the returned data.

mixed - All available data up to a newline, without that newline, or until the end of the socket as string. else a PEAR_Error when not connected.

Net_Socket::readAll

mixed Net_Socket::readAll ()

Read until the socket closes. THIS FUNCTION WILL NOT EXIT if the socket is in blocking mode until the socket closes.

mixed - All data until the socket closes as string, or PEAR_Error if not connected.

Zurück	Zum Anfang	Nach vorne
Networking functions	Nach oben	PEAR System