001/*
002 * JGrapes Event Driven Framework
003 * Copyright (C) 2024 Michael N. Lipp
004 * 
005 * This program is free software; you can redistribute it and/or modify it 
006 * under the terms of the GNU Affero General Public License as published by 
007 * the Free Software Foundation; either version 3 of the License, or 
008 * (at your option) any later version.
009 * 
010 * This program is distributed in the hope that it will be useful, but 
011 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
012 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License 
013 * for more details.
014 * 
015 * You should have received a copy of the GNU Affero General Public License along 
016 * with this program; if not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jgrapes.io.util;
020
021import java.nio.Buffer;
022import org.jgrapes.io.events.Input;
023
024/**
025 * May be implemented by classes that can consume input events to support
026 * generic usage.
027 * 
028 * @since 2.8.0
029 */
030public interface InputConsumer {
031
032    /**
033     * Feed data to the consumer. The call blocks while data from a previous
034     * invocation has not been fully read. The buffer passed as argument
035     * is locked (see {@link ManagedBuffer#lockBuffer()}) until all
036     * data has been consumed.
037     * 
038     * Calling this method with `null` indicates the end of the feed.
039     *
040     * @param buffer the buffer
041     */
042    <W extends Buffer> void feed(ManagedBuffer<W> buffer);
043
044    /**
045     * Calls {@link #feed(ManagedBuffer)} with the provided event's
046     * buffer.
047     * 
048     * Calling this method with `null` indicates the end of the feed.
049     *
050     * @param event the event
051     */
052    default <W extends Buffer> void feed(Input<W> event) {
053        if (event == null) {
054            feed((ManagedBuffer<W>) null);
055        } else {
056            feed(event.buffer());
057        }
058    }
059
060}