Phloppy\Stream\StreamInterface

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
	close()	0	1	?
	isConnected()	0	1	?
	connect()	0	1	?
	readLine()	0	1	?
	readBytes()	0	1	?
	write()	0	1	?
	getNodeUrl()	0	1	?

<?php

namespace Phloppy\Stream;

use Phloppy\Exception\ConnectException;

interface StreamInterface
{

    /**
     * Close the stream.
     *
     * @return bool True on success.
     */
    public function close();

function close() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    /**
     * Check if the stream is connected.
     *
     * @return boolean True if the stream is connected.
     */
    public function isConnected();


    /**
     * Establish a connection.
     *
     * @return void
     * @throws ConnectException
     */
    public function connect();


    /**
     * Read a line from the stream.
     *
     * @return string
     */
    public function readLine();


    /**
     * Read bytes off from the stream.
     *
     * @param int|null $maxlen
     *
     * @return string The response.
     */
    public function readBytes($maxlen = null);


    /**
     * Write the given message to the stream.
     *
     * @param string   $msg
     * @param int|null $len
     *
     * @return StreamInterface the instance.
     */
    public function write($msg, $len = null);


    /**
     * return the internal stream url.
     *
     * @return string
     */
    public function getNodeUrl();
}