1<?php
2
3/**
4 * Hoa
5 *
6 *
7 * @license
8 *
9 * New BSD License
10 *
11 * Copyright © 2007-2017, Hoa community. All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions are met:
15 *     * Redistributions of source code must retain the above copyright
16 *       notice, this list of conditions and the following disclaimer.
17 *     * Redistributions in binary form must reproduce the above copyright
18 *       notice, this list of conditions and the following disclaimer in the
19 *       documentation and/or other materials provided with the distribution.
20 *     * Neither the name of the Hoa nor the names of its contributors may be
21 *       used to endorse or promote products derived from this software without
22 *       specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37namespace Hoa\Stream\IStream;
38
39/**
40 * Interface \Hoa\Stream\IStream\Bufferable.
41 *
42 * Interface for bufferable streams. It's complementary to native buffer support
43 * of Hoa\Stream (please, see *StreamBuffer*() methods). Classes implementing
44 * this interface are able to create nested buffers, flush them etc.
45 *
46 * @copyright  Copyright © 2007-2017 Hoa community
47 * @license    New BSD License
48 */
49interface Bufferable extends Stream
50{
51    /**
52     * Start a new buffer.
53     * The callable acts like a light filter.
54     *
55     * @param   mixed   $callable    Callable.
56     * @param   int     $size        Size.
57     * @return  int
58     */
59    public function newBuffer($callable = null, $size = null);
60
61    /**
62     * Flush the buffer.
63     *
64     * @return  void
65     */
66    public function flush();
67
68    /**
69     * Delete buffer.
70     *
71     * @return  bool
72     */
73    public function deleteBuffer();
74
75    /**
76     * Get bufffer level.
77     *
78     * @return  int
79     */
80    public function getBufferLevel();
81
82    /**
83     * Get buffer size.
84     *
85     * @return  int
86     */
87    public function getBufferSize();
88}
89