PEAR Manual
Prev |  | Next

# Net_Socket::getStatus()

Net_Socket::getStatus() -- retrieve information about a connection

## Synopsis

    require_once 'Net/Socket.php';

``array Net_Socket::getStatus` ()`

## Description

Returns information about an existing socket resource.

## Return value

`array` - the data as array or a PEAR_Error

The content of the array is:

- `boolean 'timed_out'` - the socket timed out waiting for data

- `boolean 'blocked'` - blocking mode

- `boolean 'eof'` - indicates EOF event

- `integer 'unread_bytes'` - number of bytes left in the socket buffer

## Throws

Table 48-1. Possible PEAR_Error values

Error code | Error message | Reason | Solution
--- | --- | --- | ---
`NULL` | "not connected" | There is no open connection. | You must establish a connection before ( Net_Socket::connect()).

## Note

This function can not be called statically.

Prev | Home | Next
Net_Socket::gets() | Up | Net_Socket::isBlocking()