org.friendularity.jvision.broker.ImageStreamConsumer Maven / Gradle / Ivy

Go to download
/*
 *  Copyright 2013 by The Friendularity Project (www.friendularity.org).
 * 
 *  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.
 */
package org.friendularity.jvision.broker;

/**
 * Objects wishing to consume a stream of images should implement this interface, then
 * pass themselves to ImageStreamBroker.getDefaultBroker().alwaysAddImageStreamConsumer("name", this)
 * to get the stream
 * 
 * @author Annie
 */
public interface ImageStreamConsumer {
	/**
	 * A new image is available
	 * 
	 * @param img 
	 */
	public void setConsumedImage(ImageStreamImage img);
	
	/**
	 * A new message is available. 
	 * You cannot depend on getting one message per image.
	 * 
	 * @param string 
	 */
	public void setConsumedMessage(String string);
	
	/**
	 * After receiving this message you should not expect any more images.
	 * You needn't unwire yourself from the producer, that will happen right after
	 * this message.
	 * 
	 */
	public void sourceIsEnding();
}