org.graphstream.stream.binary.ByteEncoder Maven / Gradle / Ivy

/*
 * This file is part of GraphStream .
 * 
 * GraphStream is a library whose purpose is to handle static or dynamic
 * graph, create them from scratch, file or any source and display them.
 * 
 * This program is free software distributed under the terms of two licenses, the
 * CeCILL-C license that fits European law, and the GNU Lesser General Public
 * License. You can  use, modify and/ or redistribute the software under the terms
 * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following
 * URL  or under the terms of the GNU LGPL 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 * 
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms.
 */

/**
 * @since 2009-04-17
 * 
 * @author Guilhelm Savin 
 * @author Hicham Brahimi 
 */
package org.graphstream.stream.binary;

import org.graphstream.stream.Sink;

import java.nio.ByteBuffer;

/**
 * Define an encoder that transform received events into a binary buffer.
 * 
 * A ByteEncoder is a sink that will produce a {@link ByteBuffer} from each
 * received event. Then these buffer can be sent to an end-point using a
 * {@link ByteEncoder.Transport}.
 * 
 * This is a generic way to define the encoding of events into bytes buffer. The
 * main protocol used in GraphStream to do such things is NetStream, with is
 * dedicated encoder {@link org.graphstream.stream.netstream.NetStreamEncoder}.
 *
 * @since 31/01/16.
 */
public interface ByteEncoder extends Sink {
	/**
	 * Add a new transport to this encoder.
	 *
	 * @param transport
	 *            the new transport
	 */
	void addTransport(Transport transport);

	/**
	 * Remove an existing transport from this encoder.
	 *
	 * @param transport
	 *            the transport to remove
	 */
	void removeTransport(Transport transport);

	/**
	 * Define the object that will be called after an event has been transformed
	 * into a binary buffer.
	 */
	interface Transport {
		/**
		 * Called by the encoder once an event has been encoded. The buffer's position
		 * and limit should be correctly set so the Transport just has to read it.
		 *
		 * @param buffer
		 *            buffer that has to be transported
		 */
		void send(ByteBuffer buffer);
	}
}