ChannelPacketHandler.java

/*
 * Copyright (C) 2006-2008 Alfresco Software Limited.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 * As a special exception to the terms and conditions of version 2.0 of 
 * the GPL, you may redistribute this Program in connection with Free/Libre 
 * and Open Source Software ("FLOSS") applications as described in Alfresco's 
 * FLOSS exception.  You should have recieved a copy of the text describing 
 * the FLOSS exception, and it is also available here: 
 * http://www.alfresco.com/legal/licensing"
 */

package org.alfresco.jlan.smb.server.nio;

import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.channels.SocketChannel;

import org.alfresco.jlan.smb.server.CIFSPacketPool;
import org.alfresco.jlan.smb.server.PacketHandler;

/**
 * Channel Packet Handler Class
 * 
 * <p>
 * Provides the base class for Java SocketChannel based packet handler implementations.
 * 
 * @author gkspencer
 */
public abstract class ChannelPacketHandler extends PacketHandler {

	// Socket channel that this session is using.

	private SocketChannel m_sockChannel;

	// Buffer to read the request header
	
	protected byte[] m_headerBuf = new byte[4];
	
	/**
	 * Class constructor
	 * 
	 * @param sock Socket
	 * @param typ int
	 * @param name String
	 * @param shortName String 2param packetPool CIFSPacketPool
	 * @exception IOException If a network error occurs
	 */
	public ChannelPacketHandler(SocketChannel sockChannel, int typ, String name, String shortName, CIFSPacketPool packetPool)
			throws IOException {

		super(typ, name, shortName, packetPool);

		m_sockChannel = sockChannel;

		// Set socket options

		m_sockChannel.socket().setTcpNoDelay(true);

		// Set the remote address

		setRemoteAddress(m_sockChannel.socket().getInetAddress());
	}

	/**
	 * Return the socket channel
	 * 
	 * @return SocketChannel
	 */
	public final SocketChannel getSocketChannel() {
		return m_sockChannel;
	}
	
	/**
	 * Return the count of available bytes in the receive input stream
	 * 
	 * @return int
	 * @exception IOException If a network error occurs.
	 */
	public int availableBytes()
		throws IOException {

		return 0;
	}

	/**
	 * Read bytes from the socket channel
	 * 
	 * @param pkt byte[]
	 * @param offset int
	 * @param len int
	 * @return int
	 * @exception IOException If a network error occurs.
	 */
	protected int readBytes(byte[] pkt, int offset, int len)
		throws IOException {

		// Wrap the buffer and read into it
		
		ByteBuffer buf = ByteBuffer.wrap( pkt, offset, len);
		return m_sockChannel.read( buf);
	}

	/**
	 * Write bytes to the output socket channel
	 * 
	 * @param pkt byte[]
	 * @param off int
	 * @param len int
	 * @exception IOException If a network error occurs.
	 */
	protected void writeBytes(byte[] pkt, int off, int len)
		throws IOException {

		// Wrap the buffer and output to the socket channel
		
		ByteBuffer buf = ByteBuffer.wrap( pkt, off, len);
		
		while ( buf.hasRemaining())
			m_sockChannel.write( buf);
	}

	/**
	 * Flush the output socket
	 * 
	 * @exception IOException If a network error occurs
	 */
	public void flushPacket()
		throws IOException {
	}

	/**
	 * Close the protocol handler
	 */
	public void closeHandler() {

		// Close the socket channel

		if ( m_sockChannel != null) {
			
			try {
				
				// Close the associated socket
				
				if ( m_sockChannel.socket() != null)
					m_sockChannel.socket().close();
				
				// Close the channel
				
				m_sockChannel.close();
			}
			catch (IOException ex) {
			}
		}
	}
}