/*
* NOTE: This copyright does *not* cover user programs that use HQ
* program services by normal system calls through the application
* program interfaces provided as part of the Hyperic Plug-in Development
* Kit or the Hyperic Client Development Kit - this is merely considered
* normal use of the program, and does *not* fall under the heading of
* "derived work".
*
* Copyright (C) [2004-2008], Hyperic, Inc.
* This file is part of HQ.
*
* HQ is free software; you can redistribute it and/or modify
* it under the terms version 2 of the GNU General Public License as
* published by the Free Software Foundation. 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 General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*/
package org.hyperic.hq.transport.util;
import java.io.IOException;
/**
* The service hosted on the remote source that a {@link RemoteInputStream}
* uses to refill its buffer.
*/
public interface InputStreamService {
/**
* Retrieve the next buffer of data for the {@link RemoteInputStream}
*
* @param streamId The remote input stream id.
* @return The buffer of data.
* @throws IOException if there is no remote stream registered for the given stream id
* or if there is no buffered data available to be read.
*/
StreamBuffer getNextBuffer(String streamId) throws IOException;
}