org.red5.server.messaging.OOBControlMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ant-media-server-common Show documentation
Classes common for multiple Ant Media projects
The newest version!
/*
 * 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.messaging;

import java.io.Serializable;
import java.util.Map;

/**
 * Out-of-band control message used by inter-components communication which are connected with pipes. 
 * Out-of-band data is a separate data stream used for specific purposes (in TCP it's referenced as "urgent data"), like lifecycle control.
 *
 * 'Target' is used to represent the receiver who may be interested for receiving. 
 * It's a string of any form. XXX shall we design a standard form for Target, like "class.instance"?
 *
 * @author The Red5 Project
 * @author Steven Gong ([email protected])
 */
public class OOBControlMessage implements Serializable {

    private static final long serialVersionUID = -6037348177653934300L;

    /**
     * Target
     */
    private String target;

    /**
     * Service name
     */
    private String serviceName;

    /**
     * Service params name
     */
    private Map serviceParamMap;

    /**
     * Result
     */
    private Object result;

    /**
     * Getter for property 'serviceName'.
     *
     * @return Value for property 'serviceName'.
     */
    public String getServiceName() {
        return serviceName;
    }

    /**
     * Setter for property 'serviceName'.
     *
     * @param serviceName
     *            Value to set for property 'serviceName'.
     */
    public void setServiceName(String serviceName) {
        this.serviceName = serviceName;
    }

    /**
     * Getter for property 'serviceParamMap'.
     *
     * @return Value for property 'serviceParamMap'.
     */
    public Map getServiceParamMap() {
        return serviceParamMap;
    }

    /**
     * Setter for property 'serviceParamMap'.
     *
     * @param serviceParamMap
     *            Value to set for property 'serviceParamMap'.
     */
    public void setServiceParamMap(Map serviceParamMap) {
        this.serviceParamMap = serviceParamMap;
    }

    /**
     * Getter for property 'target'.
     *
     * @return Value for property 'target'.
     */
    public String getTarget() {
        return target;
    }

    /**
     * Setter for property 'target'.
     *
     * @param target
     *            Value to set for property 'target'.
     */
    public void setTarget(String target) {
        this.target = target;
    }

    /**
     * Getter for property 'result'.
     *
     * @return Value for property 'result'.
     */
    public Object getResult() {
        return result;
    }

    /**
     * Setter for property 'result'.
     *
     * @param result
     *            Value to set for property 'result'.
     */
    public void setResult(Object result) {
        this.result = result;
    }
}