org.red5.server.net.rtmp.event.ClientBW Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ant-media-server Show documentation
Ant Media Server supports RTMP, RTSP, MP4, HLS, WebRTC, Adaptive Streaming, etc.
There is a newer version: 2.11.3
/*
 * 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.net.rtmp.event;

import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;

/**
 * Client bandwidth event. Also known as a Peer Bandwidth message.
 */
public class ClientBW extends BaseEvent {

    private static final long serialVersionUID = 5848656135751336839L;

    /**
     * Bandwidth
     */
    private int bandwidth;

    /**
     * Enforcement level or limit type of the bandwidth value based on three values.
     * 
     *      * TYPE_HARD 0
     * TYPE_SOFT 1
     * TYPE_DYNAMIC 2
     * 
     */
    private byte limitType;

    public ClientBW() {
        super(Type.STREAM_CONTROL);
    }

    public ClientBW(int bandwidth, byte limitType) {
        this();
        this.bandwidth = bandwidth;
        this.limitType = limitType;
    }

    /** {@inheritDoc} */
    @Override
    public byte getDataType() {
        return TYPE_CLIENT_BANDWIDTH;
    }

    /**
     * Getter for property 'bandwidth'.
     *
     * @return Value for property 'bandwidth'.
     */
    public int getBandwidth() {
        return bandwidth;
    }

    /**
     * Setter for bandwidth
     *
     * @param bandwidth
     *            New bandwidth
     */
    public void setBandwidth(int bandwidth) {
        this.bandwidth = bandwidth;
    }

    /**
     * Getter for limitType
     *
     * @return limitType for property 'limitType'.
     */
    public byte getLimitType() {
        return limitType;
    }

    /**
     * Setter for property 'limitType'.
     *
     * @param limitType
     *            Value to set for property 'limitType'.
     */
    public void setLimitType(byte limitType) {
        this.limitType = limitType;
    }

    /** {@inheritDoc} */
    @Override
    public String toString() {
        return "ClientBW: " + bandwidth + " limitType: " + limitType;
    }

    /** {@inheritDoc} */
    @Override
    protected void releaseInternal() {

    }

    @Override
    public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
        super.readExternal(in);
        bandwidth = in.readInt();
        limitType = in.readByte();
    }

    @Override
    public void writeExternal(ObjectOutput out) throws IOException {
        super.writeExternal(out);
        out.writeInt(bandwidth);
        out.writeByte(limitType);
    }
}