Packet.java

/*
 * RED5 Open Source Flash Server - http://code.google.com/p/red5/
 * 
 * Copyright 2006-2012 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.message;

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

import org.apache.mina.core.buffer.IoBuffer;
import org.red5.server.net.rtmp.event.IRTMPEvent;

/**
 * RTMP packet. Consists of packet header, data and event context.
 */
public class Packet implements Externalizable {

	private static final long serialVersionUID = -6415050845346626950L;

	/**
	 * Header
	 */
	private Header header;

	/**
	 * RTMP event
	 */
	private IRTMPEvent message;

	/**
	 * Packet data
	 */
	private IoBuffer data;

	public Packet() {
	}

	/**
	 * Create packet with given header
	 * @param header       Packet header
	 */
	public Packet(Header header) {
		this.header = header;
		data = IoBuffer.allocate(header.getSize()).setAutoExpand(true);
	}

	/**
	 * Create packet with given header and event context
	 * @param header     RTMP header
	 * @param event      RTMP message
	 */
	public Packet(Header header, IRTMPEvent event) {
		this.header = header;
		this.message = event;
	}

	/**
	 * Getter for header
	 *
	 * @return  Packet header
	 */
	public Header getHeader() {
		return header;
	}

	/**
	 * Setter for event context
	 *
	 * @param message  RTMP event context
	 */
	public void setMessage(IRTMPEvent message) {
		this.message = message;
	}

	/**
	 * Getter for event context
	 *
	 * @return RTMP event context
	 */
	public IRTMPEvent getMessage() {
		return message;
	}

	/**
	 * Setter for data
	 *
	 * @param buffer Packet data
	 */
	public void setData(IoBuffer buffer) {
		this.data.put(buffer.buf()).flip();
	}

	/**
	 * Getter for data
	 *
	 * @return Packet data
	 */
	public IoBuffer getData() {
		return data;
	}

	/**
	 * Returns whether or not the packet has a data buffer.
	 * 
	 * @return true if data buffer exists and false otherwise
	 */
	public boolean hasData() {
		return data != null;
	}

	/**
	 * Clears the data buffer.
	 */
	public void clearData() {
		if (data != null) {
			data.clear();
			data.free();
			data = null;
		}
	}

	public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
		header = (Header) in.readObject();
		message = (IRTMPEvent) in.readObject();
		message.setHeader(header);
		message.setTimestamp(header.getTimer());
	}

	public void writeExternal(ObjectOutput out) throws IOException {
		out.writeObject(header);
		out.writeObject(message);
	}

}