Module org.neo4j.bolt.connection.netty

Package org.neo4j.bolt.connection.netty.impl.messaging

Interface BoltProtocol

All Known Implementing Classes:

BoltProtocolV3, BoltProtocolV4, BoltProtocolV41, BoltProtocolV42, BoltProtocolV43, BoltProtocolV44, BoltProtocolV5, BoltProtocolV51, BoltProtocolV52, BoltProtocolV53, BoltProtocolV54, BoltProtocolV55, BoltProtocolV56, BoltProtocolV57, BoltProtocolV58, BoltProtocolV6

public interface BoltProtocol

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	beginTransaction(Connection connection, DatabaseName databaseName, AccessMode accessMode, String impersonatedUser, Set<String> bookmarks, Duration txTimeout, Map<String,Value> txMetadata, String txType, NotificationConfig notificationConfig, MessageHandler<BeginSummary> handler, LoggingProvider logging, ValueFactory valueFactory, BoltExchangeObservation observation)
CompletionStage<Void>	commitTransaction(Connection connection, MessageHandler<String> handler, BoltExchangeObservation observation)
MessageFormat	createMessageFormat()
CompletionStage<Void>	discard(Connection connection, long qid, long number, MessageHandler<DiscardSummary> handler, ValueFactory valueFactory, BoltExchangeObservation observation)
static BoltProtocol	forChannel(io.netty.channel.Channel channel)
static BoltProtocol	forVersion(BoltProtocolVersion version)
CompletionStage<io.netty.channel.Channel>	initializeChannel(io.netty.channel.Channel channel, String userAgent, BoltAgent boltAgent, Map<String,Value> authMap, RoutingContext routingContext, NotificationConfig notificationConfig, Clock clock, CompletableFuture<Long> latestAuthMillisFuture, ValueFactory valueFactory, BoltExchangeObservation observation)
default CompletionStage<Void>	logoff(Connection connection, MessageHandler<Void> handler, BoltExchangeObservation observation)
default CompletionStage<Void>	logon(Connection connection, Map<String,Value> authMap, Clock clock, MessageHandler<Void> handler, ValueFactory valueFactory, BoltExchangeObservation observation)
CompletionStage<Void>	pull(Connection connection, long qid, long request, PullMessageHandler handler, ValueFactory valueFactory, BoltExchangeObservation observation)
CompletionStage<Void>	reset(Connection connection, MessageHandler<Void> handler, BoltExchangeObservation observation)
CompletionStage<Void>	rollbackTransaction(Connection connection, MessageHandler<Void> handler, BoltExchangeObservation observation)
CompletionStage<Void>	route(Connection connection, Map<String,Value> routingContext, Set<String> bookmarks, String databaseName, String impersonatedUser, MessageHandler<RouteSummary> handler, Clock clock, LoggingProvider logging, ValueFactory valueFactory, BoltExchangeObservation observation)
CompletionStage<Void>	run(Connection connection, String query, Map<String,Value> parameters, MessageHandler<RunSummary> handler, BoltExchangeObservation observation)
CompletionStage<Void>	runAuto(Connection connection, DatabaseName databaseName, AccessMode accessMode, String impersonatedUser, String query, Map<String,Value> parameters, Set<String> bookmarks, Duration txTimeout, Map<String,Value> txMetadata, NotificationConfig notificationConfig, MessageHandler<RunSummary> handler, LoggingProvider logging, ValueFactory valueFactory, BoltExchangeObservation observation)
CompletionStage<Void>	telemetry(Connection connection, Integer api, MessageHandler<Void> handler, BoltExchangeObservation observation)
BoltProtocolVersion	version()	Returns the protocol version.

Method Details

createMessageFormat

MessageFormat createMessageFormat()

initializeChannel

CompletionStage<io.netty.channel.Channel> initializeChannel(io.netty.channel.Channel channel,
 String userAgent,
 BoltAgent boltAgent,
 Map<String,Value> authMap,
 RoutingContext routingContext,
 NotificationConfig notificationConfig,
 Clock clock,
 CompletableFuture<Long> latestAuthMillisFuture,
 ValueFactory valueFactory,
 BoltExchangeObservation observation)

route

CompletionStage<Void> route(Connection connection,
 Map<String,Value> routingContext,
 Set<String> bookmarks,
 String databaseName,
 String impersonatedUser,
 MessageHandler<RouteSummary> handler,
 Clock clock,
 LoggingProvider logging,
 ValueFactory valueFactory,
 BoltExchangeObservation observation)

beginTransaction

CompletionStage<Void> beginTransaction(Connection connection,
 DatabaseName databaseName,
 AccessMode accessMode,
 String impersonatedUser,
 Set<String> bookmarks,
 Duration txTimeout,
 Map<String,Value> txMetadata,
 String txType,
 NotificationConfig notificationConfig,
 MessageHandler<BeginSummary> handler,
 LoggingProvider logging,
 ValueFactory valueFactory,
 BoltExchangeObservation observation)

commitTransaction

CompletionStage<Void> commitTransaction(Connection connection,
 MessageHandler<String> handler,
 BoltExchangeObservation observation)

rollbackTransaction

CompletionStage<Void> rollbackTransaction(Connection connection,
 MessageHandler<Void> handler,
 BoltExchangeObservation observation)

telemetry

CompletionStage<Void> telemetry(Connection connection,
 Integer api,
 MessageHandler<Void> handler,
 BoltExchangeObservation observation)

runAuto

CompletionStage<Void> runAuto(Connection connection,
 DatabaseName databaseName,
 AccessMode accessMode,
 String impersonatedUser,
 String query,
 Map<String,Value> parameters,
 Set<String> bookmarks,
 Duration txTimeout,
 Map<String,Value> txMetadata,
 NotificationConfig notificationConfig,
 MessageHandler<RunSummary> handler,
 LoggingProvider logging,
 ValueFactory valueFactory,
 BoltExchangeObservation observation)

run

CompletionStage<Void> run(Connection connection,
 String query,
 Map<String,Value> parameters,
 MessageHandler<RunSummary> handler,
 BoltExchangeObservation observation)

pull

CompletionStage<Void> pull(Connection connection,
 long qid,
 long request,
 PullMessageHandler handler,
 ValueFactory valueFactory,
 BoltExchangeObservation observation)

discard

CompletionStage<Void> discard(Connection connection,
 long qid,
 long number,
 MessageHandler<DiscardSummary> handler,
 ValueFactory valueFactory,
 BoltExchangeObservation observation)

reset

CompletionStage<Void> reset(Connection connection,
 MessageHandler<Void> handler,
 BoltExchangeObservation observation)

logoff

default CompletionStage<Void> logoff(Connection connection,
 MessageHandler<Void> handler,
 BoltExchangeObservation observation)

logon

default CompletionStage<Void> logon(Connection connection,
 Map<String,Value> authMap,
 Clock clock,
 MessageHandler<Void> handler,
 ValueFactory valueFactory,
 BoltExchangeObservation observation)

version

BoltProtocolVersion version()

Returns the protocol version. It can be used for version specific error messages.

Returns:

the protocol version.

forChannel

static BoltProtocol forChannel(io.netty.channel.Channel channel)

forVersion

static BoltProtocol forVersion(BoltProtocolVersion version)