io.goshawkdb.client

Class Connection

java.lang.Object

io.goshawkdb.client.Connection

All Implemented Interfaces:

java.lang.AutoCloseable

public class Connection
extends java.lang.Object
implements java.lang.AutoCloseable

Objects of this type represent connections to a GoshawkDB node and are created through use of the ConnectionFactory. A connection can only run one transaction at a time, and nested transactions are supported.

Method Summary

Modifier and Type	Method and Description
void	awaitClose() Blocks until the connection has been closed.
void	close() Close the connection.
boolean	isConnected() Test to see if we're connected to the GoshawkDB node
<R> TransactionResult<R>	runTransaction(TransactionFunction<R> fun) Run a transaction.

Methods inherited from class java.lang.Object

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

Method Detail

isConnected

public boolean isConnected()

Test to see if we're connected to the GoshawkDB node

Returns:

true iff the connection is active and fully established to the GoshawkDB node.

awaitClose

public void awaitClose()
                throws java.lang.InterruptedException

Blocks until the connection has been closed. Does not cause the connection to close, merely waits until it has been closed.

Throws:

java.lang.InterruptedException - if an interruption occurs.

close

public void close()
           throws java.lang.InterruptedException

Close the connection. Blocks until the connection has been closed.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.InterruptedException - if an interruption occurs whilst we're waiting for the connection to close.

runTransaction

public <R> TransactionResult<R> runTransaction(TransactionFunction<R> fun)

Run a transaction.

Type Parameters:

R - The type of the result of the transaction function.

Parameters:

fun - The transaction function to run. This will be automatically restarted as many times as necessary until the transaction either commits or chooses to abort.

Returns:

The result of the transaction function.

Throws:

java.lang.Exception - The transaction may through exceptions.