Module org.neo4j.driver

Package org.neo4j.driver.internal.handlers

Class LegacyPullAllResponseHandler

java.lang.Object

org.neo4j.driver.internal.handlers.AbstractRecordStateResponseHandler

org.neo4j.driver.internal.handlers.LegacyPullAllResponseHandler

All Implemented Interfaces:

PullAllResponseHandler, ResponseHandler

public class LegacyPullAllResponseHandler
extends AbstractRecordStateResponseHandler
implements PullAllResponseHandler

This is the Pull All response handler that handles pull all messages in Bolt v3 and previous protocol versions.

Nested Class Summary

Nested classes/interfaces inherited from class org.neo4j.driver.internal.handlers.AbstractRecordStateResponseHandler

AbstractRecordStateResponseHandler.RecordState

Field Summary

Fields

Modifier and Type	Field	Description
protected final Connection	connection
protected final MetadataExtractor	metadataExtractor

Fields inherited from class org.neo4j.driver.internal.handlers.AbstractRecordStateResponseHandler

recordState

Constructor Summary

Constructors

Constructor	Description
LegacyPullAllResponseHandler(Query query, RunResponseHandler runResponseHandler, Connection connection, MetadataExtractor metadataExtractor, PullResponseCompletionListener completionListener)

Method Summary

Modifier and Type	Method	Description
boolean	canManageAutoRead()	Tells whether this response handler is able to manage auto-read of the underlying connection using Connection.enableAutoRead() and Connection.disableAutoRead().
CompletionStage<ResultSummary>	consumeAsync()
void	disableAutoReadManagement()	If this response handler is able to manage auto-read of the underlying connection, then this method signals it to stop changing auto-read setting for the connection.
<T> CompletionStage<List<T>>	listAsync(Function<Record,T> mapFunction)
CompletionStage<Record>	nextAsync()
void	onFailure(Throwable error)
void	onRecord(Value[] fields)
void	onSuccess(Map<String,Value> metadata)
CompletionStage<Record>	peekAsync()
void	prePopulateRecords()
CompletionStage<Throwable>	pullAllFailureAsync()

Methods inherited from class org.neo4j.driver.internal.handlers.AbstractRecordStateResponseHandler

generateGqlStatusObject

Methods inherited from class java.lang.Object

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

Field Details

metadataExtractor

protected final MetadataExtractor metadataExtractor

connection

protected final Connection connection

Constructor Details

LegacyPullAllResponseHandler

public LegacyPullAllResponseHandler(Query query,
 RunResponseHandler runResponseHandler,
 Connection connection,
 MetadataExtractor metadataExtractor,
 PullResponseCompletionListener completionListener)

Method Details

canManageAutoRead

public boolean canManageAutoRead()

Description copied from interface: ResponseHandler

Tells whether this response handler is able to manage auto-read of the underlying connection using Connection.enableAutoRead() and Connection.disableAutoRead().

Implementations can use auto-read management to apply network-level backpressure when receiving a stream of records. There should only be a single such handler active for a connection at one point in time. Otherwise, handlers can interfere and turn on/off auto-read racing with each other. InboundMessageDispatcher is responsible for tracking these handlers and disabling auto-read management to maintain just a single auto-read managing handler per connection.

Specified by:

canManageAutoRead in interface ResponseHandler

onSuccess

public void onSuccess(Map<String,Value> metadata)

Specified by:

onSuccess in interface ResponseHandler

onFailure

public void onFailure(Throwable error)

Specified by:

onFailure in interface ResponseHandler

onRecord

public void onRecord(Value[] fields)

Specified by:

onRecord in interface ResponseHandler

disableAutoReadManagement

public void disableAutoReadManagement()

Description copied from interface: ResponseHandler

If this response handler is able to manage auto-read of the underlying connection, then this method signals it to stop changing auto-read setting for the connection.

Specified by:

disableAutoReadManagement in interface ResponseHandler

peekAsync

public CompletionStage<Record> peekAsync()

Specified by:

peekAsync in interface PullAllResponseHandler

nextAsync

public CompletionStage<Record> nextAsync()

Specified by:

nextAsync in interface PullAllResponseHandler

consumeAsync

public CompletionStage<ResultSummary> consumeAsync()

Specified by:

consumeAsync in interface PullAllResponseHandler

listAsync

public <T> CompletionStage<List<T>> listAsync(Function<Record,T> mapFunction)

Specified by:

listAsync in interface PullAllResponseHandler

prePopulateRecords

public void prePopulateRecords()

Specified by:

prePopulateRecords in interface PullAllResponseHandler

pullAllFailureAsync

public CompletionStage<Throwable> pullAllFailureAsync()

Specified by:

pullAllFailureAsync in interface PullAllResponseHandler