Module org.neo4j.driver

Package org.neo4j.driver.internal.handlers.pulln

Class BasicPullResponseHandler

java.lang.Object

org.neo4j.driver.internal.handlers.AbstractRecordStateResponseHandler

org.neo4j.driver.internal.handlers.pulln.BasicPullResponseHandler

All Implemented Interfaces:

PullResponseHandler, ResponseHandler, org.reactivestreams.Subscription

Direct Known Subclasses:

AutoPullResponseHandler

public class BasicPullResponseHandler
extends AbstractRecordStateResponseHandler
implements PullResponseHandler

Provides basic handling of pull responses from sever. The state is managed by BasicPullResponseHandler.State.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	BasicPullResponseHandler.State

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
protected final RunResponseHandler	runResponseHandler

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

recordState

Constructor Summary

Constructors

Constructor	Description
BasicPullResponseHandler(Query query, RunResponseHandler runResponseHandler, Connection connection, MetadataExtractor metadataExtractor, PullResponseCompletionListener completionListener)
BasicPullResponseHandler(Query query, RunResponseHandler runResponseHandler, Connection connection, MetadataExtractor metadataExtractor, PullResponseCompletionListener completionListener, boolean syncSignals)

Method Summary

Modifier and Type	Method	Description
void	cancel()
protected void	discardAll()
void	installRecordConsumer(BiConsumer<Record,Throwable> recordConsumer)	Register a record consumer for each record received.
void	installSummaryConsumer(BiConsumer<ResultSummary,Throwable> summaryConsumer)	Register a summary consumer to be notified when a summary is received.
protected boolean	isDone()
void	onFailure(Throwable error)
void	onRecord(Value[] fields)
void	onSuccess(Map<String,Value> metadata)
void	request(long size)
protected BasicPullResponseHandler.State	state()
protected void	state(BasicPullResponseHandler.State state)
protected void	writePull(long n)

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

Methods inherited from interface org.neo4j.driver.internal.spi.ResponseHandler

canManageAutoRead, disableAutoReadManagement

Field Details

runResponseHandler

protected final RunResponseHandler runResponseHandler

metadataExtractor

protected final MetadataExtractor metadataExtractor

connection

protected final Connection connection

Constructor Details

BasicPullResponseHandler

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

BasicPullResponseHandler

public BasicPullResponseHandler(Query query,
 RunResponseHandler runResponseHandler,
 Connection connection,
 MetadataExtractor metadataExtractor,
 PullResponseCompletionListener completionListener,
 boolean syncSignals)

Method Details

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

request

public void request(long size)

Specified by:

request in interface org.reactivestreams.Subscription

cancel

public void cancel()

Specified by:

cancel in interface org.reactivestreams.Subscription

writePull

protected void writePull(long n)

discardAll

protected void discardAll()

installSummaryConsumer

public void installSummaryConsumer(BiConsumer<ResultSummary,Throwable> summaryConsumer)

Description copied from interface: PullResponseHandler

Register a summary consumer to be notified when a summary is received. STREAMING shall not be started before this consumer is registered. A null summary with no error indicates a SUCCESS message with has_more=true has arrived.

Specified by:

installSummaryConsumer in interface PullResponseHandler

Parameters:

summaryConsumer - register a summary consumer

installRecordConsumer

public void installRecordConsumer(BiConsumer<Record,Throwable> recordConsumer)

Description copied from interface: PullResponseHandler

Register a record consumer for each record received. STREAMING shall not be started before this consumer is registered. A null record with no error indicates the end of streaming.

Specified by:

installRecordConsumer in interface PullResponseHandler

Parameters:

recordConsumer - register a record consumer to be notified for each record received.

isDone

protected boolean isDone()

state

protected BasicPullResponseHandler.State state()

state

protected void state(BasicPullResponseHandler.State state)