org.red5.server.api.so.ISharedObject Maven / Gradle / Ivy

Go to download
/*
 * RED5 Open Source Media Server - https://github.com/Red5/
 * 
 * Copyright 2006-2016 by respective authors (see below). All rights reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.red5.server.api.so;

import org.red5.server.api.scope.IBasicScope;
import org.red5.server.api.statistics.ISharedObjectStatistics;

/**
 * Serverside access to shared objects.
 * 
 * @author The Red5 Project
 * @author Joachim Bauch ([email protected])
 */
public interface ISharedObject extends IBasicScope, ISharedObjectBase, ISharedObjectSecurityService {

    /**
     * Prevent shared object from being released. Each call to
     * 
     *      * acquire
     * 
     * 
     * must be paired with a call to
     * 
     *      * release
     * 
     * 
     * so the SO isn't held forever.
     * 
     * This method basically is a no-op for persistent SOs as their data is stored and they can be released without losing their contents.
     */
    public void acquire();

    /**
     * Check if shared object currently is acquired.
     * 
     * @return      * true
     * 
     * 
     *         if the SO is acquired, otherwise
     * 
     *              * false
     * 
     */
    public boolean isAcquired();

    /**
     * Release previously acquired shared object. If the SO is non-persistent, no more clients are connected the SO isn't acquired any more, the data is released.
     */
    public void release();

    /**
     * Return statistics about the shared object.
     * 
     * @return statistics
     */
    public ISharedObjectStatistics getStatistics();

    /**
     * Sets a "dirty" flag to indicate that the attributes have been modified.
     * 
     * @param dirty
     *            if dirty / modified
     */
    public void setDirty(boolean dirty);

}