com.ceph.rados

Class Completion

java.lang.Object

com.ceph.rados.RadosBase

com.ceph.rados.Completion

All Implemented Interfaces:

Closeable, AutoCloseable

public class Completion
extends RadosBase
implements Closeable

Constructor Summary

Constructors

Constructor and Description
Completion(boolean notifyOnComplete, boolean notifyOnSafe) Constructs a completion to use with asynchronous operations.

Method Summary

Modifier and Type	Method and Description
void	close() Release a completion
boolean	equals(Object that)
int	getId()
com.sun.jna.Pointer	getPointer()
int	hashCode()
boolean	isComplete()
boolean	isSafe()
void	onComplete() Override this function to implement callback handling.
void	onSafe() Override this function to implement callback handling.
void	waitForComplete() Block until the operation completes.
void	waitForSafe() Block until the operation is safe.

Methods inherited from class com.ceph.rados.RadosBase

handleReturnCode, throwException

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Completion

public Completion(boolean notifyOnComplete,
                  boolean notifyOnSafe)
           throws RadosException

Constructs a completion to use with asynchronous operations.

The complete and safe callbacks correspond to operations being acked and committed, respectively. The callbacks are called in order of receipt, so the safe callback may be triggered before the complete callback, and vice versa. This is affected by journalling on the OSDs.

NOTE: Read operations only get a complete callback.

Parameters:

notifyOnComplete - If true, onComplete() is called when the operation is in memory on all replicas

notifyOnSafe - If true, onSafe() is called when the operation is on stable storage on all replicas

Throws:

RadosException

Method Detail

waitForComplete

public void waitForComplete()
                     throws RadosException

Block until the operation completes. This means it is in memory on all replicas.

Throws:

RadosException

waitForSafe

public void waitForSafe()
                 throws RadosException

Block until the operation is safe. This means it is on stable storage on all replicas.

Throws:

RadosException

onComplete

public void onComplete()

Override this function to implement callback handling. If notifyOnSafe is true, this function is called when the operation is in memory on all replicas.

onSafe

public void onSafe()

Override this function to implement callback handling. If notifyOnComplete is true, this function is called when the operation is on stable storage on all replicas.

close

public void close()
           throws IOException

Release a completion

Call this when you no longer need the completion. It may not be freed immediately if the operation is not acked and committed.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getId

public int getId()

Returns:

A unique ID identifying the completion.

isSafe

public boolean isSafe()

Returns:

True if the safe callback is enabled has occurred, else false.

isComplete

public boolean isComplete()

Returns:

True if the complete callback is enabled has occurred, else false.

getPointer

public com.sun.jna.Pointer getPointer()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object that)

Overrides:

equals in class Object