net.officefloor.server.SocketServicer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of officeserver_default Show documentation

Default OfficeFloor HTTP Server implementation

There is a newer version: 3.40.0

/*
 * OfficeFloor - http://www.officefloor.net
 * Copyright (C) 2005-2018 Daniel Sagenschneider
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package net.officefloor.server;

import java.net.Socket;
import java.nio.ByteBuffer;

import net.officefloor.server.stream.StreamBuffer;
import net.officefloor.server.stream.StreamBufferPool;

/**
 * Services the {@link Socket}.
 * 
 * @author Daniel Sagenschneider
 */
public interface SocketServicer {

	/**
	 * Services the {@link Socket}.
	 * 
	 * @param readBuffer  {@link StreamBuffer} containing the just read bytes. Note
	 *                    that this could be the same {@link StreamBuffer} as
	 *                    previous, with just further bytes written.
	 * @param bytesRead   Number of bytes read.
	 * @param isNewBuffer Indicates if the {@link StreamBuffer} is a new
	 *                    {@link StreamBuffer}. Due to {@link StreamBufferPool}, the
	 *                    same {@link StreamBuffer} may be re-used. This flag
	 *                    indicates if a new {@link StreamBuffer} with new data,
	 *                    even if same {@link StreamBuffer} instance.
	 */
	void service(StreamBuffer readBuffer, long bytesRead, boolean isNewBuffer);

	/**
	 * Releases this {@link SocketServicer} from use.
	 */
	default void release() {
	}

}