com.javanut.pronghorn.pipe.stream.StreamingReadVisitor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pronghorn-pipes Show documentation

Ring buffer based queuing utility for applications that require high performance and/or a small footprint. Well suited for embedded and stream based processing.

There is a newer version: 1.1.27

Show newest version

package com.javanut.pronghorn.pipe.stream;

import java.nio.ByteBuffer;

public interface StreamingReadVisitor {

	/**
	 * While this is true no more fragments will be read.  
	 * Since fragments are atomic the current one will continue to its natural end.
	 * 
	 */
	boolean paused();

	void visitTemplateOpen(String name, long id); 
	
	void visitTemplateClose(String name, long id);
	
	void visitFragmentOpen(String name, long id, int cursor);

	void visitFragmentClose(String name, long id);

	void visitSequenceOpen(String name, long id, int length);
	
	void visitSequenceClose(String name, long id);	

	void visitSignedInteger(String name, long id, int value);

	void visitUnsignedInteger(String name, long id, long value);

	void visitSignedLong(String name, long id, long value);

	///caution Java does not support unsigned long and high bit may be set
	void visitUnsignedLong(String name, long id, long value);

	void visitDecimal(String name, long id, int exp, long mant);
	
	//the ASCII text is written to the target Appendable 
	 A targetASCII(String name, long id);
	void visitASCII(String name, long id, CharSequence value);
	
	//the UTF8 text is written to the target Appendable 
	 A  targetUTF8(String name, long id);
	void visitUTF8(String name, long id, CharSequence target);
	
	//the bytes are are written to the target ByteBuffer that is also returned.
	ByteBuffer targetBytes(String name, long id, int length);
	void visitBytes(String name, long id, ByteBuffer value);

	void startup();

	void shutdown();
	
}