Module org.neo4j.bolt.connection

Package org.neo4j.bolt.connection

Interface BoltConnection

public interface BoltConnection

Method Summary

Modifier and Type	Method	Description
CompletionStage<AuthInfo>	authInfo()
CompletionStage<Void>	close()
Optional<Duration>	defaultReadTimeout()
CompletionStage<Void>	forceClose(String reason)
BoltProtocolVersion	protocolVersion()
BoltServerAddress	serverAddress()
String	serverAgent()
boolean	serverSideRoutingEnabled()	Returns whether server-side routing is enabled for this connection.
CompletionStage<Void>	setReadTimeout(Duration duration)
BoltConnectionState	state()
boolean	telemetrySupported()
CompletionStage<Void>	write(List<Message> messages)
default CompletionStage<Void>	write(Message messages)
CompletionStage<Void>	writeAndFlush(ResponseHandler handler, List<Message> messages)
default CompletionStage<Void>	writeAndFlush(ResponseHandler handler, Message messages)

Method Details

writeAndFlush

default CompletionStage<Void> writeAndFlush(ResponseHandler handler,
 Message messages)

writeAndFlush

CompletionStage<Void> writeAndFlush(ResponseHandler handler,
 List<Message> messages)

write

default CompletionStage<Void> write(Message messages)

write

CompletionStage<Void> write(List<Message> messages)

forceClose

CompletionStage<Void> forceClose(String reason)

close

CompletionStage<Void> close()

setReadTimeout

CompletionStage<Void> setReadTimeout(Duration duration)

state

BoltConnectionState state()

authInfo

CompletionStage<AuthInfo> authInfo()

serverAgent

String serverAgent()

serverAddress

BoltServerAddress serverAddress()

protocolVersion

BoltProtocolVersion protocolVersion()

telemetrySupported

boolean telemetrySupported()

serverSideRoutingEnabled

boolean serverSideRoutingEnabled()

Returns whether server-side routing is enabled for this connection.

Since this may only be detected reliably from Bolt 5.8 and higher, it may return false for previous Bolt versions even if server-side routing is enabled.

In addition, this MUST return false when no routing context is sent to the server. The absense of routing context prohibits server-side routing from routing even if it is enabled on the server.

Returns:

true if enabled, false otherwise

defaultReadTimeout

Optional<Duration> defaultReadTimeout()