42 lines
887 B
PHP
42 lines
887 B
PHP
|
<?php
|
||
|
|
|
||
|
|
namespace Pheanstalk;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* A mockable wrapper around PHP "socket" or "file pointer" access.
|
||
|
|
* Only the subset of socket actions required by Pheanstalk are provided.
|
||
|
|
*
|
||
|
|
* @author Paul Annesley
|
||
|
|
* @package Pheanstalk
|
||
|
|
* @license http://www.opensource.org/licenses/mit-license.php
|
||
|
|
*/
|
||
|
|
interface Socket
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* Writes data to the socket.
|
||
|
|
* @param string $data
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function write($data);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Reads up to $length bytes from the socket.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function read($length);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Reads up to the next new-line, or $length - 1 bytes.
|
||
|
|
* Trailing whitespace is trimmed.
|
||
|
|
*
|
||
|
|
* @param int
|
||
|
|
*/
|
||
|
|
public function getLine($length = null);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Disconnect the socket; subsequent usage of the socket will fail.
|
||
|
|
*/
|
||
|
|
public function disconnect();
|
||
|
|
}
|