<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_Memory

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $

 */

/**

 * Memory value container interface

 *

 * @category   Zend

 * @package    Zend_Memory

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

interface Zend_Memory_Container_Interface

{

    /**

     * Get string value reference

     *

     * _Must_ be used for value access before PHP v 5.2

     * or _may_ be used for performance considerations

     *

     * @return &string

     */

    public function &getRef();

    /**

     * Signal, that value is updated by external code.

     *

     * Should be used together with getRef()

     */

    public function touch();

    /**

     * Lock object in memory.

     */

    public function lock();

    /**

     * Unlock object

     */

    public function unlock();

    /**

     * Return true if object is locked

     *

     * @return boolean

     */

    public function isLocked();

}