org.red5.server.net.rtmpt.BaseRTMPTConnection 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
Show all versions of ant-media-server Show documentation
Ant Media Server supports RTMP, RTSP, MP4, HLS, WebRTC, Adaptive Streaming, etc.
/*
* 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.rtmpt;
import java.util.Arrays;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicLong;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.mina.core.buffer.IoBuffer;
import org.red5.server.api.Red5;
import org.red5.server.net.rtmp.RTMPConnection;
import org.red5.server.net.rtmp.codec.RTMP;
import org.red5.server.net.rtmp.codec.RTMPProtocolDecoder;
import org.red5.server.net.rtmp.codec.RTMPProtocolEncoder;
import org.red5.server.net.rtmp.message.Packet;
import org.red5.server.net.rtmpt.codec.RTMPTProtocolDecoder;
import org.red5.server.net.rtmpt.codec.RTMPTProtocolEncoder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Base RTMPT client / session.
*
* @author The Red5 Project
* @author Paul Gregoire ([email protected])
*/
public abstract class BaseRTMPTConnection extends RTMPConnection {
private static final Logger log = LoggerFactory.getLogger(BaseRTMPTConnection.class);
/**
* Protocol decoder
*/
private transient RTMPTProtocolDecoder decoder;
/**
* Protocol encoder
*/
private transient RTMPTProtocolEncoder encoder;
/**
* Closing flag
*/
private volatile boolean closing;
/**
* Number of read bytes
*/
private AtomicLong readBytes = new AtomicLong(0);
/**
* Number of written bytes
*/
private AtomicLong writtenBytes = new AtomicLong(0);
/**
* Byte buffer
*/
private volatile IoBuffer buffer;
/**
* List of pending outgoing messages. Default size is 8192.
*/
protected transient volatile LinkedBlockingQueue pendingOutMessages = new LinkedBlockingQueue(8192);
/**
* Maximum incoming messages to process at a time per client
*/
protected int maxInMessagesPerProcess = 16;
/**
* Maximum amount of time in milliseconds to wait before allowing an offer to fail
*/
protected long maxQueueOfferTime = 500L;
/**
* Maximum offer attempts before failing on incoming or outgoing queues
*/
protected int maxQueueOfferAttempts = 4;
public BaseRTMPTConnection(String type) {
super(type);
this.buffer = IoBuffer.allocate(0).setAutoExpand(true);
}
/**
* Return any pending messages up to a given size.
*
* @param targetSize
* the size the resulting buffer should have
* @return a buffer containing the data to send or null if no messages are pending
*/
abstract public IoBuffer getPendingMessages(int targetSize);
/** {@inheritDoc} */
@Override
public void close() {
closing = true;
if (pendingOutMessages.size() > 0) {
if (log.isTraceEnabled()) {
log.trace("Clearing pending messages out: {}", pendingOutMessages.size());
}
pendingOutMessages.clear();
}
// clean up buffer
if (buffer != null) {
buffer.free();
buffer = null;
}
super.close();
}
/**
* Getter for property 'closing'.
*
* @return Value for property 'closing'.
*/
public boolean isClosing() {
return closing;
}
/** {@inheritDoc} */
@Override
public long getReadBytes() {
return readBytes.get();
}
public void updateReadBytes(int read) {
readBytes.addAndGet(read);
}
/** {@inheritDoc} */
@Override
public long getWrittenBytes() {
return writtenBytes.get();
}
public void updateWrittenBytes(int wrote) {
writtenBytes.addAndGet(wrote);
}
/** {@inheritDoc} */
@Override
public long getPendingMessages() {
log.debug("Checking pending queue size. Session id: {} closing: {} state: {}", sessionId, closing, state);
if (state.getState() == RTMP.STATE_DISCONNECTED) {
log.debug("Connection is disconnected");
pendingOutMessages.clear();
}
return pendingOutMessages.size();
}
/**
* Decode data sent by the client.
*
* @param data
* the data to decode
* @return a list of decoded objects
*/
public List decode(IoBuffer data) {
log.debug("decode");
if (closing || state.getState() == RTMP.STATE_DISCONNECTED) {
// connection is being closed, don't decode any new packets
return Collections.EMPTY_LIST;
}
if (log.isTraceEnabled()) {
log.trace("Current bytes read at decode: {}", data.limit());
}
buffer.put(data);
buffer.flip();
return decoder.decodeBuffer(this, buffer);
}
/**
* Send RTMP packet down the connection.
*
* @param packet
* the packet to send
*/
@Override
public void write(final Packet packet) {
if (log.isDebugEnabled()) {
log.debug("write - packet: {}", packet);
}
//log.trace("state: {}", state);
if (closing || state.getState() == RTMP.STATE_DISCONNECTED) {
// connection is being closed, don't send any new packets
log.debug("No write completed due to connection disconnecting");
} else {
IoBuffer data = null;
try {
// set the connection local before attempting to encode
if (log.isDebugEnabled()) {
log.debug("Local: {} this: {}", Red5.getConnectionLocal(), this);
}
Red5.setConnectionLocal(this);
// encode the data
data = encoder.encodePacket(packet);
if (data != null) {
// add to pending
log.debug("Adding outgoing message packet");
PendingData pendingData = new PendingData(data, packet);
try {
int attempt = 0;
while (!pendingOutMessages.offer(pendingData, maxQueueOfferTime, TimeUnit.MILLISECONDS)) {
log.trace("Packet was not added to out queue");
attempt++;
if (attempt >= maxQueueOfferAttempts) {
break;
}
}
} catch (InterruptedException ex) {
log.warn("Offering packet to out queue failed", ex);
ex.printStackTrace();
Thread.currentThread().interrupt();
}
} else {
log.warn("Response buffer was null after encoding");
}
} catch (Exception e) {
log.error("Could not encode message {}", packet, e);
}
}
}
/**
* Send raw data down the connection.
*
* @param packet
* the buffer containing the raw data
*/
@Override
public void writeRaw(IoBuffer packet) {
if (log.isDebugEnabled()) {
log.debug("write - io buffer: {}", packet);
}
PendingData pendingData = new PendingData(packet);
try {
int attempt = 0;
while (!pendingOutMessages.offer(pendingData, maxQueueOfferTime, TimeUnit.MILLISECONDS)) {
log.trace("Packet was not added to out queue");
attempt++;
if (attempt >= maxQueueOfferAttempts) {
break;
}
}
} catch (InterruptedException ex) {
log.warn("Offering io buffer to out queue failed", ex);
ex.printStackTrace();
Thread.currentThread().interrupt();
}
}
protected IoBuffer foldPendingMessages(int targetSize) {
log.debug("foldPendingMessages - target size: {}", targetSize);
IoBuffer result = null;
if (!pendingOutMessages.isEmpty()) {
int available = pendingOutMessages.size();
// create list to hold outgoing data
LinkedList sendList = new LinkedList();
pendingOutMessages.drainTo(sendList, Math.min(164, available));
result = IoBuffer.allocate(targetSize).setAutoExpand(true);
for (PendingData pendingMessage : sendList) {
result.put(pendingMessage.getBuffer());
Packet packet = pendingMessage.getPacket();
if (packet != null) {
try {
handler.messageSent(this, packet);
// mark packet as being written
writingMessage(packet);
} catch (Exception e) {
log.error("Could not notify stream subsystem about sent message", e);
}
} else {
log.trace("Pending message did not have a packet");
}
}
sendList.clear();
result.flip();
// send byte length
if (log.isDebugEnabled()) {
log.debug("Send size: {}", result.limit());
}
}
return result;
}
public void setDecoder(RTMPProtocolDecoder decoder) {
this.decoder = (RTMPTProtocolDecoder) decoder;
}
public void setEncoder(RTMPProtocolEncoder encoder) {
this.encoder = (RTMPTProtocolEncoder) encoder;
}
/**
* @param maxInMessagesPerProcess
* the maxInMessagesPerProcess to set
*/
public void setMaxInMessagesPerProcess(int maxInMessagesPerProcess) {
this.maxInMessagesPerProcess = maxInMessagesPerProcess;
}
/**
* @param maxQueueOfferTime
* the maxQueueOfferTime to set
*/
public void setMaxQueueOfferTime(long maxQueueOfferTime) {
this.maxQueueOfferTime = maxQueueOfferTime;
}
/**
* @param maxQueueOfferAttempts
* the maxQueueOfferAttempts to set
*/
public void setMaxQueueOfferAttempts(int maxQueueOfferAttempts) {
this.maxQueueOfferAttempts = maxQueueOfferAttempts;
}
/**
* Holder for data destined for a requester that is not ready to be sent.
*/
private static class PendingData {
// simple packet
private final Packet packet;
// encoded packet data
private final byte[] byteBuffer;
private PendingData(IoBuffer buffer, Packet packet) {
int size = buffer.limit();
this.byteBuffer = new byte[size];
buffer.get(byteBuffer);
this.packet = packet;
if (log.isTraceEnabled()) {
log.trace("Buffer: {}", Arrays.toString(ArrayUtils.subarray(byteBuffer, 0, 32)));
}
}
private PendingData(IoBuffer buffer) {
int size = buffer.limit();
this.byteBuffer = new byte[size];
buffer.get(byteBuffer);
this.packet = null;
if (log.isTraceEnabled()) {
log.trace("Buffer: {}", Arrays.toString(ArrayUtils.subarray(byteBuffer, 0, 32)));
}
}
public byte[] getBuffer() {
if (log.isTraceEnabled()) {
log.trace("Get buffer: {}", Arrays.toString(ArrayUtils.subarray(byteBuffer, 0, 32)));
}
return byteBuffer;
}
public Packet getPacket() {
return packet;
}
@SuppressWarnings("unused")
public int getBufferSize() {
if (byteBuffer != null) {
return byteBuffer.length;
}
return 0;
}
}
}