Inheritance diagram for AbstractClient:Abstract client socket.
Public Methods | |
| string | __toString () |
The peer's name as <address>:<port>, or <pid>:0 for Unix sockets, or ?<id> if a name can't be derived (e.g. More... | |
| $this | connect (string $address, int $port=0) |
| Connects the socket to a peer. More... | |
| array | getPeerName () |
The peer's address and port, or Unix PID and port 0. More... | |
| int | send (string $data, int $flags=0) |
| Sends data to the remote peer. More... | |
| $this | write (string $data) |
| Sends all data (forced blocking). More... | |
| Public Methods inherited from AbstractSocket | |
| __construct ($resource) | |
| Validates and sets the underlying socket resource. More... | |
| __destruct () | |
| Closes the socket if it's open. More... | |
| $this | await (int $channel) |
| Blocks until the socket becomes available on a given channel. More... | |
| $this | awaitOutOfBand () |
| $this | awaitReadable () |
| $this | awaitWritable () |
| $this | close () |
| Closes the underlying resource if it's open. More... | |
| int | getDomain () |
The AF_* address family constant. More... | |
| int | getId () |
| mixed | getOption (int $option) |
| Retrieves an option value. More... | |
| resource | getResource () |
| array | getSockName () |
The local address and port, or Unix file path and port 0. More... | |
| bool | isOpen () |
| bool | isOutOfBand () |
| Polls for whether the socket can perform a non-blocking out-of-band read. More... | |
| bool | isReadable () |
| Polls for whether the socket can perform a non-blocking read. More... | |
| bool | isReady (int $channel, ?float $timeout=0) |
| Selects for channel availability. More... | |
| bool | isWritable () |
| Polls for whether the socket can perform a non-blocking write. More... | |
| $this | setBlocking (bool $blocking) |
| Enables or disables blocking. More... | |
| $this | setOption (int $option, $value) |
| Sets an option on the underlying resource. More... | |
| $this | setTimeout (float $timeout) |
| Sets the I/O timeout length in seconds. More... | |
| $this | shutdown (int $channel) |
| Shuts down I/O for a single channel. More... | |
Additional Inherited Members | |
| Public Properties inherited from SocketInterface | |
| const | CH_EXCEPT = 2 |
| Out-of-band channel. More... | |
| const | CH_READ = 0 |
| Read channel. More... | |
| const | CH_WRITE = 1 |
| Write channel. More... | |
| Protected Properties inherited from AbstractSocket | |
| resource | $resource |
| The underlying PHP resource. More... | |
| Public Static Methods inherited from AbstractSocket | |
| static self | create (int $domain=AF_INET,... $extra) |
| Creates an instance of the called class. More... | |
| static int | getType () |
The SOCK_* type constant for the class. More... | |
| string __toString | ( | ) |
The peer's name as <address>:<port>, or <pid>:0 for Unix sockets, or ?<id> if a name can't be derived (e.g.
the socket is closed).
| $this connect | ( | string | $address, |
| int | $port = 0 |
||
| ) |
Connects the socket to a peer.
For datagram sockets this sets the target recipient.
For non-blocking sockets, the SOCKET_EINPROGRESS and SOCKET_EWOULDBLOCK errors are ignored and cleared, because they're expected.
| string | $address | The remote network address, or local Unix file name. |
| int | $port | The remote port. Unix sockets ignore this entirely. |
| SocketError |
| array getPeerName | ( | ) |
The peer's address and port, or Unix PID and port 0.
[ 0 => address, 1 => port ] | SocketError |
| int send | ( | string | $data, |
| int | $flags = 0 |
||
| ) |
Sends data to the remote peer.
| string | $data | |
| int | $flags | MSG_* |
| SocketError |
| $this write | ( | string | $data | ) |
Sends all data (forced blocking).
| string | $data |
| SocketError | int total bytes sent is set as the extra data. |
1.8.17