org.neo4j.bolt.v1.runtime

Enum BoltStateMachine.State

java.lang.Object

java.lang.Enum<BoltStateMachine.State>

org.neo4j.bolt.v1.runtime.BoltStateMachine.State

All Implemented Interfaces:

Serializable, Comparable<BoltStateMachine.State>

Enclosing class:

BoltStateMachine

public static enum BoltStateMachine.State
extends Enum<BoltStateMachine.State>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECTED Following the socket connection and a small handshake exchange to establish protocol version, the machine begins in the CONNECTED state.
FAILED The FAILED state occurs when a recoverable error is encountered.
INTERRUPTED If the state machine has been INTERRUPTED then a RESET message has entered the queue and is waiting to be processed.
READY The READY state indicates that the connection is ready to accept a new RUN request.
STREAMING When STREAMING, a result is available as a stream of records.

Method Summary

Modifier and Type	Method and Description
BoltStateMachine.State	ackFailure(BoltStateMachine machine)
BoltStateMachine.State	discardAll(BoltStateMachine machine)
BoltStateMachine.State	init(BoltStateMachine machine, String userAgent, Map<String,Object> authToken)
BoltStateMachine.State	interrupt(BoltStateMachine machine)
BoltStateMachine.State	pullAll(BoltStateMachine machine)
BoltStateMachine.State	reset(BoltStateMachine machine)
BoltStateMachine.State	run(BoltStateMachine machine, String statement, org.neo4j.values.virtual.MapValue params)
static BoltStateMachine.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static BoltStateMachine.State[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONNECTED

public static final BoltStateMachine.State CONNECTED

Following the socket connection and a small handshake exchange to establish protocol version, the machine begins in the CONNECTED state. The only valid transition from here is through a correctly authorised INIT into the READY state. Any other action results in disconnection.

READY

public static final BoltStateMachine.State READY

The READY state indicates that the connection is ready to accept a new RUN request. This is the "normal" state for a connection and becomes available after successful authorisation and when not executing another statement. It is this that ensures that statements must be executed in series and each must wait for the previous statement to complete.

STREAMING

public static final BoltStateMachine.State STREAMING

When STREAMING, a result is available as a stream of records. These must be PULLed or DISCARDed before any further statements can be executed.

FAILED

public static final BoltStateMachine.State FAILED

The FAILED state occurs when a recoverable error is encountered. This might be something like a Cypher SyntaxError or ConstraintViolation. To exit the FAILED state, either a RESET or and ACK_FAILURE must be issued. All stream will be IGNORED until this is done.

INTERRUPTED

public static final BoltStateMachine.State INTERRUPTED

If the state machine has been INTERRUPTED then a RESET message has entered the queue and is waiting to be processed. The initial interrupt forces the current statement to stop and all subsequent requests to be IGNORED until the RESET itself is processed.

Method Detail

values

public static BoltStateMachine.State[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BoltStateMachine.State c : BoltStateMachine.State.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BoltStateMachine.State valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

init

public BoltStateMachine.State init(BoltStateMachine machine,
                                   String userAgent,
                                   Map<String,Object> authToken)
                            throws BoltConnectionFatality

Throws:

BoltConnectionFatality

ackFailure

public BoltStateMachine.State ackFailure(BoltStateMachine machine)
                                  throws BoltConnectionFatality

Throws:

BoltConnectionFatality

interrupt

public BoltStateMachine.State interrupt(BoltStateMachine machine)
                                 throws BoltConnectionFatality

Throws:

BoltConnectionFatality

reset

public BoltStateMachine.State reset(BoltStateMachine machine)
                             throws BoltConnectionFatality

Throws:

BoltConnectionFatality

run

public BoltStateMachine.State run(BoltStateMachine machine,
                                  String statement,
                                  org.neo4j.values.virtual.MapValue params)
                           throws BoltConnectionFatality

Throws:

BoltConnectionFatality

discardAll

public BoltStateMachine.State discardAll(BoltStateMachine machine)
                                  throws BoltConnectionFatality

Throws:

BoltConnectionFatality

pullAll

public BoltStateMachine.State pullAll(BoltStateMachine machine)
                               throws BoltConnectionFatality

Throws:

BoltConnectionFatality