PHP Classes

File: src/Generics/Streams/InputStream.php

Recommend this page to a friend!
  Classes of Maik Greubel   PHP Generics   src/Generics/Streams/InputStream.php   Download  
File: src/Generics/Streams/InputStream.php
Role: Class source
Content type: text/plain
Description: Input stream interface
Class: PHP Generics
Framework for accessing streams, sockets and logs
Author: By
Last change: Update of src/Generics/Streams/InputStream.php
Date: 6 months ago
Size: 642 bytes
 

Contents

Class file image Download
<?php

/**
 * This file is part of the PHP Generics package.
 *
 * @package Generics
 */
namespace Generics\Streams;

/**
 * This interface describes the implementation of an input stream.
 *
 * @author Maik Greubel <greubel@nkey.de>
 */
interface InputStream extends Stream
{

   
/**
     * Read bytes from stream.
     *
     * @param int $length
     * Number of bytes to read
     * @param int $offset
     * The offset where to start reading
     * @throws StreamException in case of stream is closed
     * @return string The readen buffer
     */
   
public function read($length = 1, $offset = null): string;
}