Package org.apache.pulsar.client.impl

Class ClientCnx

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

org.apache.pulsar.common.protocol.PulsarDecoder

org.apache.pulsar.common.protocol.PulsarHandler

org.apache.pulsar.client.impl.ClientCnx

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

public class ClientCnx
extends PulsarHandler

Channel handler for the Pulsar client.

Please see PulsarDecoder javadoc for important details about handle* method parameter instance lifecycle.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	ClientCnx.State

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
protected final Authentication	authentication
protected AuthenticationDataProvider	authenticationDataProvider
protected final int	protocolVersion
protected String	proxyToTargetBrokerAddress
protected String	remoteHostName
protected ClientCnx.State	state

Fields inherited from class org.apache.pulsar.common.protocol.PulsarHandler

ctx

Fields inherited from class org.apache.pulsar.common.protocol.PulsarDecoder

proxyMessage

Constructor Summary

Constructors

Constructor	Description
ClientCnx(ClientConfigurationData conf, io.netty.channel.EventLoopGroup eventLoopGroup)
ClientCnx(ClientConfigurationData conf, io.netty.channel.EventLoopGroup eventLoopGroup, int protocolVersion)

Method Summary

Modifier and Type	Method	Description
void	channelActive(io.netty.channel.ChannelHandlerContext ctx)
void	channelInactive(io.netty.channel.ChannelHandlerContext ctx)
void	close()
protected void	closeWithException(Throwable e)
io.netty.channel.ChannelHandlerContext	ctx()
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
long	getDuplicatedResponseCount()
static PulsarClientException	getPulsarClientException(ServerError error, String errorMsg)
protected void	handleAckResponse(CommandAckResponse ackResponse)
protected void	handleActiveConsumerChange(CommandActiveConsumerChange change)
protected void	handleAddPartitionToTxnResponse(CommandAddPartitionToTxnResponse command)
protected void	handleAddSubscriptionToTxnResponse(CommandAddSubscriptionToTxnResponse command)
protected void	handleAuthChallenge(CommandAuthChallenge authChallenge)
protected void	handleCloseConsumer(CommandCloseConsumer closeConsumer)
protected void	handleCloseProducer(CommandCloseProducer closeProducer)
protected void	handleCommandWatchTopicListSuccess(CommandWatchTopicListSuccess commandWatchTopicListSuccess)
protected void	handleCommandWatchTopicUpdate(CommandWatchTopicUpdate commandWatchTopicUpdate)
protected void	handleConnected(CommandConnected connected)
protected void	handleEndTxnOnPartitionResponse(CommandEndTxnOnPartitionResponse command)
protected void	handleEndTxnOnSubscriptionResponse(CommandEndTxnOnSubscriptionResponse command)
protected void	handleEndTxnResponse(CommandEndTxnResponse command)
protected void	handleError(CommandError error)
protected void	handleGetLastMessageIdSuccess(CommandGetLastMessageIdResponse success)
protected void	handleGetOrCreateSchemaResponse(CommandGetOrCreateSchemaResponse commandGetOrCreateSchemaResponse)
protected void	handleGetSchemaResponse(CommandGetSchemaResponse commandGetSchemaResponse)
protected void	handleGetTopicsOfNamespaceSuccess(CommandGetTopicsOfNamespaceResponse success)
protected void	handleLookupResponse(CommandLookupTopicResponse lookupResult)
protected void	handleMessage(CommandMessage cmdMessage, io.netty.buffer.ByteBuf headersAndPayload)
protected void	handleNewTxnResponse(CommandNewTxnResponse command)
protected void	handlePartitionResponse(CommandPartitionedTopicMetadataResponse lookupResult)
protected void	handleProducerSuccess(CommandProducerSuccess success)
protected void	handleReachedEndOfTopic(CommandReachedEndOfTopic commandReachedEndOfTopic)
protected void	handleSendError(CommandSendError sendError)
protected void	handleSendReceipt(CommandSendReceipt sendReceipt)
protected void	handleSuccess(CommandSuccess success)
protected void	handleTcClientConnectResponse(CommandTcClientConnectResponse response)
protected void	handleTopicMigrated(CommandTopicMigrated commandTopicMigrated)
boolean	idleCheck()	Check client connection is now free.
protected boolean	isHandshakeCompleted()
static boolean	isKnownException(Throwable t)
CompletableFuture<Void>	newAckForReceipt(io.netty.buffer.ByteBuf request, long requestId)
void	newAckForReceiptWithFuture(io.netty.buffer.ByteBuf request, long requestId, TimedCompletableFuture<Void> future)
protected io.netty.buffer.ByteBuf	newConnectCommand()
CompletableFuture<GetTopicsResult>	newGetTopicsOfNamespace(io.netty.buffer.ByteBuf request, long requestId)
CompletableFuture<BinaryProtoLookupService.LookupDataResult>	newLookup(io.netty.buffer.ByteBuf request, long requestId)
CompletableFuture<CommandWatchTopicListSuccess>	newWatchTopicList(BaseCommand commandWatchTopicList, long requestId)
CompletableFuture<CommandSuccess>	newWatchTopicListClose(BaseCommand commandWatchTopicListClose, long requestId)
void	registerTransactionBufferHandler(TransactionBufferHandler handler)
CompletableFuture<CommandGetLastMessageIdResponse>	sendGetLastMessageId(io.netty.buffer.ByteBuf request, long requestId)
CompletableFuture<byte[]>	sendGetOrCreateSchema(io.netty.buffer.ByteBuf request, long requestId)
CompletableFuture<CommandGetSchemaResponse>	sendGetRawSchema(io.netty.buffer.ByteBuf request, long requestId)
CompletableFuture<Optional<SchemaInfo>>	sendGetSchema(io.netty.buffer.ByteBuf request, long requestId)

Methods inherited from class org.apache.pulsar.common.protocol.PulsarHandler

cancelKeepAliveTask, getRemoteEndpointProtocolVersion, handlePing, handlePong, messageReceived, sendPing, setRemoteEndpointProtocolVersion

Methods inherited from class org.apache.pulsar.common.protocol.PulsarDecoder

channelRead, handleAck, handleAddPartitionToTxn, handleAddSubscriptionToTxn, handleAuthResponse, handleCommandWatchTopicList, handleCommandWatchTopicListClose, handleConnect, handleConsumerStats, handleConsumerStatsResponse, handleEndTxn, handleEndTxnOnPartition, handleEndTxnOnSubscription, handleFlow, handleGetLastMessageId, handleGetOrCreateSchema, handleGetSchema, handleGetTopicsOfNamespace, handleLookup, handleNewTxn, handlePartitionMetadataRequest, handleProducer, handleRedeliverUnacknowledged, handleSeek, handleSend, handleSubscribe, handleTcClientConnectRequest, handleUnsubscribe, interceptCommand

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Field Details

authentication

protected final Authentication authentication

state

protected ClientCnx.State state

protocolVersion

protected final int protocolVersion

proxyToTargetBrokerAddress

protected String proxyToTargetBrokerAddress

remoteHostName

protected String remoteHostName

authenticationDataProvider

protected AuthenticationDataProvider authenticationDataProvider

Constructor Details

ClientCnx

public ClientCnx(ClientConfigurationData conf,
 io.netty.channel.EventLoopGroup eventLoopGroup)

ClientCnx

public ClientCnx(ClientConfigurationData conf,
 io.netty.channel.EventLoopGroup eventLoopGroup,
 int protocolVersion)

Method Details

channelActive

public void channelActive(io.netty.channel.ChannelHandlerContext ctx)
                   throws Exception

Specified by:

channelActive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelActive in class PulsarHandler

Throws:

Exception

newConnectCommand

protected io.netty.buffer.ByteBuf newConnectCommand()
                                             throws Exception

Throws:

Exception

channelInactive

public void channelInactive(io.netty.channel.ChannelHandlerContext ctx)
                     throws Exception

Specified by:

channelInactive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelInactive in class PulsarHandler

Throws:

Exception

exceptionCaught

public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
 Throwable cause)
                     throws Exception

Specified by:

exceptionCaught in interface io.netty.channel.ChannelHandler

Specified by:

exceptionCaught in interface io.netty.channel.ChannelInboundHandler

Overrides:

exceptionCaught in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

isKnownException

public static boolean isKnownException(Throwable t)

getDuplicatedResponseCount

public long getDuplicatedResponseCount()

handleConnected

protected void handleConnected(CommandConnected connected)

Overrides:

handleConnected in class PulsarDecoder

handleAuthChallenge

protected void handleAuthChallenge(CommandAuthChallenge authChallenge)

Overrides:

handleAuthChallenge in class PulsarDecoder

handleSendReceipt

protected void handleSendReceipt(CommandSendReceipt sendReceipt)

Overrides:

handleSendReceipt in class PulsarDecoder

handleAckResponse

protected void handleAckResponse(CommandAckResponse ackResponse)

Overrides:

handleAckResponse in class PulsarDecoder

handleMessage

protected void handleMessage(CommandMessage cmdMessage,
 io.netty.buffer.ByteBuf headersAndPayload)

Overrides:

handleMessage in class PulsarDecoder

handleActiveConsumerChange

protected void handleActiveConsumerChange(CommandActiveConsumerChange change)

Overrides:

handleActiveConsumerChange in class PulsarDecoder

handleSuccess

protected void handleSuccess(CommandSuccess success)

Overrides:

handleSuccess in class PulsarDecoder

handleGetLastMessageIdSuccess

protected void handleGetLastMessageIdSuccess(CommandGetLastMessageIdResponse success)

Overrides:

handleGetLastMessageIdSuccess in class PulsarDecoder

handleProducerSuccess

protected void handleProducerSuccess(CommandProducerSuccess success)

Overrides:

handleProducerSuccess in class PulsarDecoder

handleLookupResponse

protected void handleLookupResponse(CommandLookupTopicResponse lookupResult)

Overrides:

handleLookupResponse in class PulsarDecoder

handlePartitionResponse

protected void handlePartitionResponse(CommandPartitionedTopicMetadataResponse lookupResult)

Overrides:

handlePartitionResponse in class PulsarDecoder

handleReachedEndOfTopic

protected void handleReachedEndOfTopic(CommandReachedEndOfTopic commandReachedEndOfTopic)

Overrides:

handleReachedEndOfTopic in class PulsarDecoder

handleTopicMigrated

protected void handleTopicMigrated(CommandTopicMigrated commandTopicMigrated)

Overrides:

handleTopicMigrated in class PulsarDecoder

handleSendError

protected void handleSendError(CommandSendError sendError)

Overrides:

handleSendError in class PulsarDecoder

handleError

protected void handleError(CommandError error)

Overrides:

handleError in class PulsarDecoder

handleCloseProducer

protected void handleCloseProducer(CommandCloseProducer closeProducer)

Overrides:

handleCloseProducer in class PulsarDecoder

handleCloseConsumer

protected void handleCloseConsumer(CommandCloseConsumer closeConsumer)

Overrides:

handleCloseConsumer in class PulsarDecoder

isHandshakeCompleted

protected boolean isHandshakeCompleted()

Specified by:

isHandshakeCompleted in class PulsarHandler

newLookup

public CompletableFuture<BinaryProtoLookupService.LookupDataResult> newLookup(io.netty.buffer.ByteBuf request,
 long requestId)

newGetTopicsOfNamespace

public CompletableFuture<GetTopicsResult> newGetTopicsOfNamespace(io.netty.buffer.ByteBuf request,
 long requestId)

newAckForReceipt

public CompletableFuture<Void> newAckForReceipt(io.netty.buffer.ByteBuf request,
 long requestId)

newAckForReceiptWithFuture

public void newAckForReceiptWithFuture(io.netty.buffer.ByteBuf request,
 long requestId,
 TimedCompletableFuture<Void> future)

handleGetTopicsOfNamespaceSuccess

protected void handleGetTopicsOfNamespaceSuccess(CommandGetTopicsOfNamespaceResponse success)

Overrides:

handleGetTopicsOfNamespaceSuccess in class PulsarDecoder

handleGetSchemaResponse

protected void handleGetSchemaResponse(CommandGetSchemaResponse commandGetSchemaResponse)

Overrides:

handleGetSchemaResponse in class PulsarDecoder

handleGetOrCreateSchemaResponse

protected void handleGetOrCreateSchemaResponse(CommandGetOrCreateSchemaResponse commandGetOrCreateSchemaResponse)

Overrides:

handleGetOrCreateSchemaResponse in class PulsarDecoder

ctx

public io.netty.channel.ChannelHandlerContext ctx()

sendGetLastMessageId

public CompletableFuture<CommandGetLastMessageIdResponse> sendGetLastMessageId(io.netty.buffer.ByteBuf request,
 long requestId)

sendGetSchema

public CompletableFuture<Optional<SchemaInfo>> sendGetSchema(io.netty.buffer.ByteBuf request,
 long requestId)

sendGetRawSchema

public CompletableFuture<CommandGetSchemaResponse> sendGetRawSchema(io.netty.buffer.ByteBuf request,
 long requestId)

sendGetOrCreateSchema

public CompletableFuture<byte[]> sendGetOrCreateSchema(io.netty.buffer.ByteBuf request,
 long requestId)

handleNewTxnResponse

protected void handleNewTxnResponse(CommandNewTxnResponse command)

Overrides:

handleNewTxnResponse in class PulsarDecoder

handleAddPartitionToTxnResponse

protected void handleAddPartitionToTxnResponse(CommandAddPartitionToTxnResponse command)

Overrides:

handleAddPartitionToTxnResponse in class PulsarDecoder

handleAddSubscriptionToTxnResponse

protected void handleAddSubscriptionToTxnResponse(CommandAddSubscriptionToTxnResponse command)

Overrides:

handleAddSubscriptionToTxnResponse in class PulsarDecoder

handleEndTxnOnPartitionResponse

protected void handleEndTxnOnPartitionResponse(CommandEndTxnOnPartitionResponse command)

Overrides:

handleEndTxnOnPartitionResponse in class PulsarDecoder

handleEndTxnOnSubscriptionResponse

protected void handleEndTxnOnSubscriptionResponse(CommandEndTxnOnSubscriptionResponse command)

Overrides:

handleEndTxnOnSubscriptionResponse in class PulsarDecoder

handleEndTxnResponse

protected void handleEndTxnResponse(CommandEndTxnResponse command)

Overrides:

handleEndTxnResponse in class PulsarDecoder

handleTcClientConnectResponse

protected void handleTcClientConnectResponse(CommandTcClientConnectResponse response)

Overrides:

handleTcClientConnectResponse in class PulsarDecoder

newWatchTopicList

public CompletableFuture<CommandWatchTopicListSuccess> newWatchTopicList(BaseCommand commandWatchTopicList,
 long requestId)

newWatchTopicListClose

public CompletableFuture<CommandSuccess> newWatchTopicListClose(BaseCommand commandWatchTopicListClose,
 long requestId)

handleCommandWatchTopicListSuccess

protected void handleCommandWatchTopicListSuccess(CommandWatchTopicListSuccess commandWatchTopicListSuccess)

Overrides:

handleCommandWatchTopicListSuccess in class PulsarDecoder

handleCommandWatchTopicUpdate

protected void handleCommandWatchTopicUpdate(CommandWatchTopicUpdate commandWatchTopicUpdate)

Overrides:

handleCommandWatchTopicUpdate in class PulsarDecoder

registerTransactionBufferHandler

public void registerTransactionBufferHandler(TransactionBufferHandler handler)

getPulsarClientException

public static PulsarClientException getPulsarClientException(ServerError error,
 String errorMsg)

close

public void close()

closeWithException

protected void closeWithException(Throwable e)

idleCheck

public boolean idleCheck()

Check client connection is now free. This method will not change the state to idle.

Returns:

true if the connection is eligible.