org.red5.server.so.ClientSharedObject 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.so;

import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.CopyOnWriteArraySet;
import java.util.concurrent.locks.ReentrantLock;

import org.red5.server.api.IAttributeStore;
import org.red5.server.api.IConnection;
import org.red5.server.api.event.IEvent;
import org.red5.server.api.event.IEventDispatcher;
import org.red5.server.api.event.IEventListener;
import org.red5.server.api.so.IClientSharedObject;
import org.red5.server.api.so.ISharedObjectListener;
import org.red5.server.net.rtmp.Channel;
import org.red5.server.net.rtmp.RTMPConnection;
import org.red5.server.so.ISharedObjectEvent.Type;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Works with client-side shared object
 */
@SuppressWarnings("unchecked")
public class ClientSharedObject extends SharedObject implements IClientSharedObject, IEventDispatcher {

    protected static Logger log = LoggerFactory.getLogger(ClientSharedObject.class);

    /**
     * Initial synchronization flag
     */
    private volatile boolean initialSyncReceived;

    /**
     * Synchronization lock
     */
    private final transient ReentrantLock lock = new ReentrantLock();

    /**
     * Set of listeners
     */
    private transient CopyOnWriteArraySet listeners = new CopyOnWriteArraySet();

    /**
     * Set of event handlers
     */
    private transient ConcurrentMap handlers = new ConcurrentHashMap(1, 0.9f, 1);

    /**
     * Create new client SO with
     * 
     * @param name
     *            Shared Object name
     * @param persistent
     *            Persistence flag
     */
    public ClientSharedObject(String name, boolean persistent) {
        super();
        this.name = name;
        this.persistent = persistent;
    }

    /**
     * Connect the shared object using the passed connection.
     * 
     * @param conn
     *            Attach SO to given connection
     */
    public void connect(IConnection conn) {
        if (conn instanceof RTMPConnection) {
            if (!isConnected()) {
                source = conn;
                SharedObjectMessage msg = new SharedObjectMessage(name, 0, isPersistent());
                msg.addEvent(new SharedObjectEvent(Type.SERVER_CONNECT, null, null));
                Channel c = ((RTMPConnection) conn).getChannel(3);
                c.write(msg);
            } else {
                throw new UnsupportedOperationException("Already connected");
            }
        } else {
            throw new UnsupportedOperationException("Only RTMP connections are supported");
        }
    }

    /** {@inheritDoc} */
    public void disconnect() {
        if (isConnected()) {
            SharedObjectMessage msg = new SharedObjectMessage(name, 0, isPersistent());
            msg.addEvent(new SharedObjectEvent(Type.SERVER_DISCONNECT, null, null));
            Channel c = ((RTMPConnection) source).getChannel(3);
            c.write(msg);
            notifyDisconnect();
            initialSyncReceived = false;
        }
    }

    /** {@inheritDoc} */
    public boolean isConnected() {
        return initialSyncReceived;
    }

    /** {@inheritDoc} */
    public void addSharedObjectListener(ISharedObjectListener listener) {
        listeners.add(listener);
    }

    /** {@inheritDoc} */
    public void removeSharedObjectListener(ISharedObjectListener listener) {
        listeners.remove(listener);
    }

    /** {@inheritDoc} */
    public void dispatchEvent(IEvent e) {
        if (e instanceof ISharedObjectMessage || e.getType() == IEvent.Type.SHARED_OBJECT) {
            ISharedObjectMessage msg = (ISharedObjectMessage) e;
            if (msg.hasSource()) {
                beginUpdate(msg.getSource());
            } else {
                beginUpdate();
            }
            try {
                for (ISharedObjectEvent event : msg.getEvents()) {
                    switch (event.getType()) {
                        case CLIENT_INITIAL_DATA:
                            initialSyncReceived = true;
                            notifyConnect();
                            break;
                        case CLIENT_CLEAR_DATA:
                            attributes.clear();
                            notifyClear();
                            break;
                        case CLIENT_DELETE_DATA:
                        case CLIENT_DELETE_ATTRIBUTE:
                            attributes.remove(event.getKey());
                            notifyDelete(event.getKey());
                            break;
                        case CLIENT_SEND_MESSAGE:
                            notifySendMessage(event.getKey(), (List) event.getValue());
                            break;
                        case CLIENT_UPDATE_DATA:
                            attributes.putAll((Map) event.getValue());
                            notifyUpdate(event.getKey(), (Map) event.getValue());
                            break;
                        case CLIENT_UPDATE_ATTRIBUTE:
                            Object val = event.getValue();
                            // null values are not allowed in concurrent hash maps
                            if (val != null) {
                                attributes.put(event.getKey(), val);
                            }
                            // we will however send the null out to the subscribers
                            notifyUpdate(event.getKey(), val);
                            break;
                        default:
                            log.warn("Unknown SO event: {}", event.getType());
                    }
                }
            } finally {
                endUpdate();
            }
        }
    }

    /**
     * Notify listeners on event
     */
    protected void notifyConnect() {
        for (ISharedObjectListener listener : listeners) {
            listener.onSharedObjectConnect(this);
        }
    }

    /**
     * Notify listeners on disconnect
     */
    protected void notifyDisconnect() {
        for (ISharedObjectListener listener : listeners) {
            listener.onSharedObjectDisconnect(this);
        }
    }

    /**
     * Notify listeners on update
     * 
     * @param key
     *            Updated attribute key
     * @param value
     *            Updated attribute value
     */
    protected void notifyUpdate(String key, Object value) {
        for (ISharedObjectListener listener : listeners) {
            listener.onSharedObjectUpdate(this, key, value);
        }
    }

    /**
     * Notify listeners on map attribute update
     * 
     * @param key
     *            Updated attribute key
     * @param value
     *            Updated attribute value
     */
    protected void notifyUpdate(String key, Map value) {
        if (value.size() == 1) {
            Map.Entry entry = value.entrySet().iterator().next();
            notifyUpdate(entry.getKey(), entry.getValue());
            return;
        }
        for (ISharedObjectListener listener : listeners) {
            listener.onSharedObjectUpdate(this, key, value);
        }
    }

    /**
     * Notify listeners on attribute delete
     * 
     * @param key
     *            Attribute name
     */
    protected void notifyDelete(String key) {
        for (ISharedObjectListener listener : listeners) {
            listener.onSharedObjectDelete(this, key);
        }
    }

    /**
     * Notify listeners on clear
     */
    protected void notifyClear() {
        for (ISharedObjectListener listener : listeners) {
            listener.onSharedObjectClear(this);
        }
    }

    /**
     * Broadcast send event to listeners
     * 
     * @param method
     *            Method name
     * @param params
     *            Params
     */
    protected void notifySendMessage(String method, List params) {
        for (ISharedObjectListener listener : listeners) {
            listener.onSharedObjectSend(this, method, params);
        }
    }

    /** {@inheritDoc} */
    @Override
    public boolean setAttribute(String name, Object value) {
        if (value != null) {
            ownerMessage.addEvent(Type.SERVER_SET_ATTRIBUTE, name, value);
            notifyModified();
            return true;
        } else {
            return removeAttribute(name);
        }
    }

    /** {@inheritDoc} */
    @Override
    public boolean setAttributes(IAttributeStore values) {
        return setAttributes(values.getAttributes());
    }

    /** {@inheritDoc} */
    @Override
    public boolean setAttributes(Map values) {
        int successes = 0;
        if (values != null) {
            for (Map.Entry entry : values.entrySet()) {
                if (setAttribute(entry.getKey(), entry.getValue())) {
                    successes++;
                }
            }
        }
        // expect every value to have been added
        return (successes == values.size());
    }

    /** {@inheritDoc} */
    @Override
    public boolean removeAttribute(String name) {
        ownerMessage.addEvent(Type.SERVER_DELETE_ATTRIBUTE, name, null);
        notifyModified();
        return true;
    }

    /** {@inheritDoc} */
    @Override
    public void sendMessage(String handler, List arguments) {
        ownerMessage.addEvent(Type.SERVER_SEND_MESSAGE, handler, arguments);
        notifyModified();
    }

    /** {@inheritDoc} */
    @Override
    public void removeAttributes() {
        // TODO: there must be a direct way to clear the SO on the client side
        for (String key : getAttributeNames()) {
            ownerMessage.addEvent(Type.SERVER_DELETE_ATTRIBUTE, key, null);
        }
        notifyModified();
    }

    /** {@inheritDoc} */
    @Override
    public boolean clear() {
        return super.clear();
    }

    /** {@inheritDoc} */
    @Override
    public void close() {
        super.close();
    }

    /** {@inheritDoc} */
    @Override
    public void beginUpdate() {
        lock();
        super.beginUpdate();
    }

    /** {@inheritDoc} */
    @Override
    public void beginUpdate(IEventListener listener) {
        lock();
        super.beginUpdate(listener);
    }

    /** {@inheritDoc} */
    @Override
    public void endUpdate() {
        super.endUpdate();
        unlock();
    }

    /** {@inheritDoc} */
    public void lock() {
        lock.lock();
    }

    /** {@inheritDoc} */
    public void unlock() {
        lock.unlock();
    }

    /** {@inheritDoc} */
    public boolean isLocked() {
        return lock.isLocked();
    }

    /** {@inheritDoc} */
    public void registerServiceHandler(Object handler) {
        registerServiceHandler("", handler);
    }

    /** {@inheritDoc} */
    public void unregisterServiceHandler(String name) {
        handlers.remove(name);
    }

    /** {@inheritDoc} */
    public void registerServiceHandler(String name, Object handler) {
        if (name == null) {
            name = "";
        }
        handlers.put(name, handler);
    }

    /** {@inheritDoc} */
    public Object getServiceHandler(String name) {
        if (name == null) {
            name = "";
        }
        return handlers.get(name);
    }

    /** {@inheritDoc} */
    public Set getServiceHandlerNames() {
        return Collections.unmodifiableSet(handlers.keySet());
    }

    /** {@inheritDoc} */
    public Object getAttribute(String name, Object defaultValue) {
        if (!hasAttribute(name)) {
            setAttribute(name, defaultValue);
        }
        return getAttribute(name);
    }

}