/*
* Appender.java February 2008
*
* Copyright (C) 2008, Niall Gallagher <niallg@users.sf.net>
*
* 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.simpleframework.transport;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.CharBuffer;
import java.nio.channels.ByteChannel;
import java.nio.charset.Charset;
/**
* The <code>Appender</code> represents a packet that wraps a pooled
* byte buffer. This implementation provides write access to the
* underlying buffer, so it can modify its contents if required. This
* means that the <code>append</code> methods can add data to the
* buffer, and that the buffer can be compacted if required.
*
* @author Niall Gallagher
*/
class Appender implements Packet {
/**
* This is the buffer used to store the contents of the packet.
*/
private ByteBuffer buffer;
/**
* This is the manager object that is used to recycle buffers.
*/
private Recycler manager;
/**
* This represents the sequence number used by this packet.
*/
private long sequence;
/**
* This determines whether the packet has been closed already.
*/
private boolean closed;
/**
* Constructor for the <code>Appender</code> object. This creates
* a packet with a recyclable buffer. This appender can not be
* recycled as it is provided with no recycler.
*
* @param buffer this is the buffer used by this packet
* @param sequence this is the unique sequence number for this
*/
public Appender(ByteBuffer buffer, long sequence) {
this(buffer, null, sequence);
}
/**
* Constructor for the <code>Appender</code> object. This creates
* a packet with a recyclable buffer. The buffer provided can be
* modified up until such point as it is recycled. To recycle the
* buffer the packet must be closed.
*
* @param buffer this is the buffer used by this packet
* @param manager this is the buffer pool to pass the buffer to
* @param sequence this is the unique sequence number for this
*/
public Appender(ByteBuffer buffer, Recycler manager, long sequence) {
this.sequence = sequence;
this.manager = manager;
this.buffer = buffer;
}
/**
* The sequence number represents the order with which this is
* to be delivered to the underlying network. This allows safer
* transfer of packets in an asynchronous environment where it may
* be possible for a packet to be written out of sequence. The
* sequence number also determines the order of closure.
*
* @return this returns an increasing packet sequence number
*/
public long sequence() {
return sequence;
}
/**
* This is used to determine how much space is left to append
* data to this packet. This is typically equivalent to capacity
* minus the length. However in the event that the packet uses
* a private memory store that can not be written to then this
* can return zero regardless of the capacity and length.
*
* @return the space left within the buffer to append data to
*/
public int space() {
if(closed) {
return 0;
}
return buffer.remaining();
}
/**
* This represents the capacity of the backing store. The buffer
* is full when length is equal to capacity and it can typically
* be appended to when the length is less than the capacity. The
* only exception is when <code>space</code> returns zero, which
* means that the packet can not have bytes appended to it.
*
* @return this is the capacity of other backing byte storage
*/
public int capacity() {
if(closed) {
return 0;
}
return buffer.capacity();
}
/**
* This is used to determine how mnay bytes remain within this
* packet. It represents the number of write ready bytes, so if
* the length is greater than zero the packet can be written to
* a byte channel. When length is zero the packet can be closed.
*
* @return this is the number of bytes remaining in this packet
*/
public int length() {
if(closed) {
return 0;
}
return capacity() - space();
}
/**
* This is used to that packets can be entered in to a priority
* queue such that they are ordered based on their sequence
* numbers. Ordering based on sequence numbers ensures that
* packets can be remove and inserted back in to the equeue
* without concern for othe order of their insertion.
*
* @param packet this is the packet that is to be compared
*
* @return this is negative is less than otherwise its positive
*/
public int compareTo(Packet packet) {
long other = packet.sequence();
if(other > sequence) {
return -1;
}
if(sequence > other) {
return 1;
}
return 0;
}
/**
* This method is used to extract the contents of the packet in
* to a duplicate packet. The purpose of this is to ensure that
* when a packet wraps a shared buffer the contents of that
* buffer can be drained in to an allocated buffer, resulting
* in a packet that can be used without read write conflicts.
*
* @return this returns the packets contents in a new buffer
*/
public Packet extract() throws IOException {
return this;
}
/**
* This is used to encode the underlying byte sequence to text.
* Converting the byte sequence to text can be useful when either
* debugging what exactly is being sent. Also, for transports
* that require string delivery of packets this can be used.
*
* @return this returns the bytes sequence as a string object
*/
public String encode() throws IOException {
return encode("ISO-8859-1");
}
/**
* This is used to encode the underlying byte sequence to text.
* Converting the byte sequence to text can be useful when either
* debugging what exactly is being sent. Also, for transports
* that require string delivery of packets this can be used.
*
* @param encoding this is the character set to use for encoding
*
* @return this returns the bytes sequence as a string object
*/
public String encode(String encoding) throws IOException {
ByteBuffer segment = buffer.duplicate();
if(segment != null) {
segment.flip();
}
return encode(encoding, segment);
}
/**
* This is used to encode the underlying byte sequence to text.
* Converting the byte sequence to text can be useful when either
* debugging what exactly is being sent. Also, for transports
* that require string delivery of packets this can be used.
*
* @param encoding this is the character set to use for encoding
* @param segment this is the buffer that is to be encoded
*
* @return this returns the bytes sequence as a string object
*/
private String encode(String encoding, ByteBuffer segment) throws IOException {
Charset charset = Charset.forName(encoding);
CharBuffer text = charset.decode(segment);
return text.toString();
}
/**
* This will append bytes within the given buffer to the packet.
* Once invoked the packet will contain the buffer bytes, which
* will have been drained from the buffer. This effectively moves
* the bytes in the buffer to the end of the packet instance.
*
* @param data this is the buffer containing the bytes
*
* @return returns the number of bytes that have been moved
*/
public int append(ByteBuffer data) throws IOException {
int require = data.remaining();
int space = space();
if(require > space) {
require = space;
}
return append(data, require);
}
/**
* This will append bytes within the given buffer to the packet.
* Once invoked the packet will contain the buffer bytes, which
* will have been drained from the buffer. This effectively moves
* the bytes in the buffer to the end of the packet instance.
*
* @param data this is the buffer containing the bytes
* @param count this is the number of bytes that should be used
*
* @return returns the number of bytes that have been moved
*/
public int append(ByteBuffer data, int count) throws IOException {
ByteBuffer segment = data.slice();
if(closed) {
throw new PacketException("Packet has been closed");
}
int mark = data.position();
int size = mark + count;
if(count > 0) {
data.position(size);
segment.limit(count);
buffer.put(segment);
}
return count;
}
/**
* This write method will write the contents of the packet to the
* provided byte channel. If the whole packet can be be written
* then this will simply return the number of bytes that have.
* The number of bytes remaining within the packet after a write
* can be acquired from the <code>length</code> method. Once all
* of the bytes are written the packet must be closed.
*
* @param channel this is the channel to write the packet to
*
* @return this returns the number of bytes that were written
*/
public int write(ByteChannel channel) throws IOException {
int size = length();
if(size <= 0) {
return 0;
}
return write(channel, size);
}
/**
* This write method will write the contents of the packet to the
* provided byte channel. If the whole packet can be be written
* then this will simply return the number of bytes that have.
* The number of bytes remaining within the packet after a write
* can be acquired from the <code>length</code> method. Once all
* of the bytes are written the packet must be closed.
*
* @param channel this is the channel to write the packet to
* @param count the number of bytes to write to the channel
*
* @return this returns the number of bytes that were written
*/
public int write(ByteChannel channel, int count) throws IOException {
if(closed) {
throw new PacketException("Packet has been closed");
}
if(count > 0) {
buffer.flip();
} else {
return 0;
}
return write(channel, buffer);
}
/**
* This write method will write the contents of the packet to the
* provided byte channel. If the whole packet can be be written
* then this will simply return the number of bytes that have.
* The number of bytes remaining within the packet after a write
* can be acquired from the <code>length</code> method. Once all
* of the bytes are written the packet must be closed.
*
* @param channel this is the channel to write the packet to
* @param segment this is the buffer that is to be written
*
* @return this returns the number of bytes that were written
*/
private int write(ByteChannel channel, ByteBuffer segment) throws IOException {
int require = segment.remaining();
int count = 0;
while(count < require) {
int size = channel.write(segment);
if(size <= 0) {
break;
}
count += size;
}
if(count >= 0) {
segment.compact();
}
return count;
}
/**
* The <code>close</code> method for the packet is used to ensure
* that any resources occupied by the packet are released. The
* resources held by this instance include pooled buffers. If the
* packet is not closed on completion then this can result in a
* leak of resources within the associated transport.
*/
public void close() {
if(manager != null) {
manager.recycle(buffer);
}
manager = null;
closed = true;
}
/**
* This method is used to determine if the buffer is shared with
* another thread or service. It is important to know whether a
* packet is shared as it tells the writer whether it needs to
* block the writing thread whilst the packet is pending a write
* to the socket channel.
*
* @return true if the buffer is shared with another service
*/
public boolean isReference() {
return false;
}
/**
* Provides a string representation of the state of the packet.
* This can be useful for debugging the state transitions that a
* packet will go through when being written and appended to.
*
* @return this returns a string representation for the packet
*/
@Override
public String toString() {
return String.format("%s %s", sequence, buffer);
}
}