net.officefloor.server.stream.ServerWriter Maven / Gradle / Ivy
/*-
* #%L
* HTTP Server
* %%
* Copyright (C) 2005 - 2020 Daniel Sagenschneider
* %%
* 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.
* #L%
*/
package net.officefloor.server.stream;
import java.io.IOException;
import java.io.Writer;
import java.nio.ByteBuffer;
import java.nio.channels.FileChannel;
/**
* Server {@link Writer}.
*
* @author Daniel Sagenschneider
*/
public abstract class ServerWriter extends Writer {
/**
*
* Enables writing encoded bytes.
*
* Caution should also be taken to ensure that previous written content is
* not waiting for further surrogate characters.
*
* @param encodedBytes
* Encoded bytes.
* @throws IOException
* If fails to write the bytes.
*/
public abstract void write(byte[] encodedBytes) throws IOException;
/**
*
* Enables writing encoded bytes.
*
* Caution should also be taken to ensure that previous written content is
* not waiting for further surrogate characters.
*
* @param encodedBytes
* {@link ByteBuffer} containing the encoded bytes.
* @throws IOException
* If fails to write the bytes.
*/
public abstract void write(ByteBuffer encodedBytes) throws IOException;
/**
*
* Writes part of the {@link FileChannel} contents.
*
* This is to enable efficient I/O (ie DMA) of writing {@link FileChannel}
* content.
*
* To write the entire {@link FileChannel} contents, invoke
* write(file, 0, -1).
*
* Note that the underlying implementation will need to support
* {@link FileChannel} efficiencies.
*
* Caution should also be taken to ensure that previous written content is
* not waiting for further surrogate characters.
*
* @param file
* {@link FileChannel}.
* @param position
* Position within the {@link FileChannel} to start writing
* content. Must be non-negative number.
* @param count
* Count of bytes to write from the {@link FileChannel}. A
* negative value (typically -1) indicates to write
* the remaining {@link FileChannel} content from position.
* @param callback
* Optional {@link FileCompleteCallback}. May be
* null.
* @throws IOException
* If fails to write the {@link FileChannel} content.
*/
public abstract void write(FileChannel file, long position, long count, FileCompleteCallback callback)
throws IOException;
/**
*
* Writes the entire {@link FileChannel} contents.
*
* This is a convenience method for write(file, 0, -1).
*
* Caution should also be taken to ensure that previous written content is
* not waiting for further surrogate characters.
*
* @param file
* {@link FileChannel}.
* @param callback
* Optional {@link FileCompleteCallback}. May be
* null.
* @throws IOException
* If fails to write the {@link FileChannel} content.
*/
public abstract void write(FileChannel file, FileCompleteCallback callback) throws IOException;
}