Module org.neo4j.driver

Package org.neo4j.driver.internal.spi

Interface ResponseHandler

All Known Subinterfaces:

PullAllResponseHandler, PullResponseHandler

All Known Implementing Classes:

AutoPullResponseHandler, BasicPullResponseHandler, BeginTxResponseHandler, ChannelReleasingResetResponseHandler, CommitTxResponseHandler, HelloResponseHandler, HelloV51ResponseHandler, LegacyPullAllResponseHandler, LogoffResponseHandler, LogonResponseHandler, NoOpResponseHandler, PingResponseHandler, ResetResponseHandler, RollbackTxResponseHandler, RouteMessageResponseHandler, RoutingResponseHandler, RunResponseHandler, TelemetryResponseHandler

public interface ResponseHandler

Method Summary

Modifier and Type	Method	Description
default boolean	canManageAutoRead()	Tells whether this response handler is able to manage auto-read of the underlying connection using Connection.enableAutoRead() and Connection.disableAutoRead().
default 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.
void	onFailure(Throwable error)
void	onRecord(Value[] fields)
void	onSuccess(Map<String,Value> metadata)

Method Details

onSuccess

void onSuccess(Map<String,Value> metadata)

onFailure

void onFailure(Throwable error)

onRecord

void onRecord(Value[] fields)

canManageAutoRead

default boolean canManageAutoRead()

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.

disableAutoReadManagement

default 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.