org.egothor.robot.escape

Interface Escape

All Known Implementing Classes:

RotateEscape, SimpleEscape

public interface Escape

This interface defines a component that stores indexed ByteBuffers (often externally).

Author:

galambos

Method Summary

Modifier and Type	Method and Description
void	commit(long handle) The previous blocks saved by save(long, java.lang.String, java.lang.String, java.nio.ByteBuffer) method should be commited.
void	drop(long handle) The previous blocks saved by save(long, java.lang.String, java.lang.String, java.nio.ByteBuffer) method should be forgotten.
long	save(long handle, ByteBuffer buf) Save the consequent buffer related to a stream of the key.
long	save(long id, String key, String contentType, ByteBuffer buf) Save the very first buffer related to a stream of the key.
void	shutdown() Closes (shuts down) this interface.

Method Detail

save

long save(long id,
          String key,
          String contentType,
          ByteBuffer buf)
   throws IOException

Save the very first buffer related to a stream of the key. It clears the buffer on a successful operation.

Throws:

IOException

save

long save(long handle,
          ByteBuffer buf)
   throws IOException

Save the consequent buffer related to a stream of the key. It clears the buffer on a successful operation.

Returns:

the original handle for your convinience

Throws:

IOException

drop

void drop(long handle)
   throws IOException

The previous blocks saved by save(long, java.lang.String, java.lang.String, java.nio.ByteBuffer) method should be forgotten.

Throws:

IOException

commit

void commit(long handle)
     throws IOException

The previous blocks saved by save(long, java.lang.String, java.lang.String, java.nio.ByteBuffer) method should be commited.

Throws:

IOException

shutdown

void shutdown()

Closes (shuts down) this interface.