程序包 org.apache.pulsar.client.impl

类 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

所有已实现的接口:

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.

嵌套类概要

嵌套类

修饰符和类型	类	说明
protected static enum	ClientCnx.State

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

字段概要

字段

修饰符和类型	字段	说明
protected final Authentication	authentication
protected AuthenticationDataProvider	authenticationDataProvider
protected final int	protocolVersion
protected String	proxyToTargetBrokerAddress
protected String	remoteHostName
protected ClientCnx.State	state

从类继承的字段 org.apache.pulsar.common.protocol.PulsarHandler

ctx

从类继承的字段 org.apache.pulsar.common.protocol.PulsarDecoder

proxyMessage

构造器概要

构造器

构造器	说明
ClientCnx(InstrumentProvider instrumentProvider, ClientConfigurationData conf, io.netty.channel.EventLoopGroup eventLoopGroup)
ClientCnx(InstrumentProvider instrumentProvider, ClientConfigurationData conf, io.netty.channel.EventLoopGroup eventLoopGroup, int protocolVersion)

方法概要

修饰符和类型	方法	说明
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)
void	userEventTriggered(io.netty.channel.ChannelHandlerContext ctx, Object evt)

从类继承的方法 org.apache.pulsar.common.protocol.PulsarHandler

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

从类继承的方法 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

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

从类继承的方法 java.lang.Object

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

从接口继承的方法 io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

字段详细资料

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

构造器详细资料

ClientCnx

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

ClientCnx

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

方法详细资料

channelActive

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

指定者:

channelActive 在接口中 io.netty.channel.ChannelInboundHandler

覆盖:

channelActive 在类中 PulsarHandler

抛出:

Exception

newConnectCommand

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

抛出:

Exception

channelInactive

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

指定者:

channelInactive 在接口中 io.netty.channel.ChannelInboundHandler

覆盖:

channelInactive 在类中 PulsarHandler

抛出:

Exception

exceptionCaught

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

指定者:

exceptionCaught 在接口中 io.netty.channel.ChannelHandler

指定者:

exceptionCaught 在接口中 io.netty.channel.ChannelInboundHandler

覆盖:

exceptionCaught 在类中 io.netty.channel.ChannelInboundHandlerAdapter

抛出:

Exception

isKnownException

public static boolean isKnownException(Throwable t)

getDuplicatedResponseCount

public long getDuplicatedResponseCount()

handleConnected

protected void handleConnected(CommandConnected connected)

覆盖:

handleConnected 在类中 PulsarDecoder

handleAuthChallenge

protected void handleAuthChallenge(CommandAuthChallenge authChallenge)

覆盖:

handleAuthChallenge 在类中 PulsarDecoder

handleSendReceipt

protected void handleSendReceipt(CommandSendReceipt sendReceipt)

覆盖:

handleSendReceipt 在类中 PulsarDecoder

handleAckResponse

protected void handleAckResponse(CommandAckResponse ackResponse)

覆盖:

handleAckResponse 在类中 PulsarDecoder

handleMessage

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

覆盖:

handleMessage 在类中 PulsarDecoder

handleActiveConsumerChange

protected void handleActiveConsumerChange(CommandActiveConsumerChange change)

覆盖:

handleActiveConsumerChange 在类中 PulsarDecoder

handleSuccess

protected void handleSuccess(CommandSuccess success)

覆盖:

handleSuccess 在类中 PulsarDecoder

handleGetLastMessageIdSuccess

protected void handleGetLastMessageIdSuccess(CommandGetLastMessageIdResponse success)

覆盖:

handleGetLastMessageIdSuccess 在类中 PulsarDecoder

handleProducerSuccess

protected void handleProducerSuccess(CommandProducerSuccess success)

覆盖:

handleProducerSuccess 在类中 PulsarDecoder

handleLookupResponse

protected void handleLookupResponse(CommandLookupTopicResponse lookupResult)

覆盖:

handleLookupResponse 在类中 PulsarDecoder

handlePartitionResponse

protected void handlePartitionResponse(CommandPartitionedTopicMetadataResponse lookupResult)

覆盖:

handlePartitionResponse 在类中 PulsarDecoder

handleReachedEndOfTopic

protected void handleReachedEndOfTopic(CommandReachedEndOfTopic commandReachedEndOfTopic)

覆盖:

handleReachedEndOfTopic 在类中 PulsarDecoder

handleTopicMigrated

protected void handleTopicMigrated(CommandTopicMigrated commandTopicMigrated)

覆盖:

handleTopicMigrated 在类中 PulsarDecoder

handleSendError

protected void handleSendError(CommandSendError sendError)

覆盖:

handleSendError 在类中 PulsarDecoder

handleError

protected void handleError(CommandError error)

覆盖:

handleError 在类中 PulsarDecoder

handleCloseProducer

protected void handleCloseProducer(CommandCloseProducer closeProducer)

覆盖:

handleCloseProducer 在类中 PulsarDecoder

handleCloseConsumer

protected void handleCloseConsumer(CommandCloseConsumer closeConsumer)

覆盖:

handleCloseConsumer 在类中 PulsarDecoder

isHandshakeCompleted

protected boolean isHandshakeCompleted()

指定者:

isHandshakeCompleted 在类中 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)

覆盖:

handleGetTopicsOfNamespaceSuccess 在类中 PulsarDecoder

handleGetSchemaResponse

protected void handleGetSchemaResponse(CommandGetSchemaResponse commandGetSchemaResponse)

覆盖:

handleGetSchemaResponse 在类中 PulsarDecoder

handleGetOrCreateSchemaResponse

protected void handleGetOrCreateSchemaResponse(CommandGetOrCreateSchemaResponse commandGetOrCreateSchemaResponse)

覆盖:

handleGetOrCreateSchemaResponse 在类中 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)

覆盖:

handleNewTxnResponse 在类中 PulsarDecoder

handleAddPartitionToTxnResponse

protected void handleAddPartitionToTxnResponse(CommandAddPartitionToTxnResponse command)

覆盖:

handleAddPartitionToTxnResponse 在类中 PulsarDecoder

handleAddSubscriptionToTxnResponse

protected void handleAddSubscriptionToTxnResponse(CommandAddSubscriptionToTxnResponse command)

覆盖:

handleAddSubscriptionToTxnResponse 在类中 PulsarDecoder

handleEndTxnOnPartitionResponse

protected void handleEndTxnOnPartitionResponse(CommandEndTxnOnPartitionResponse command)

覆盖:

handleEndTxnOnPartitionResponse 在类中 PulsarDecoder

handleEndTxnOnSubscriptionResponse

protected void handleEndTxnOnSubscriptionResponse(CommandEndTxnOnSubscriptionResponse command)

覆盖:

handleEndTxnOnSubscriptionResponse 在类中 PulsarDecoder

handleEndTxnResponse

protected void handleEndTxnResponse(CommandEndTxnResponse command)

覆盖:

handleEndTxnResponse 在类中 PulsarDecoder

handleTcClientConnectResponse

protected void handleTcClientConnectResponse(CommandTcClientConnectResponse response)

覆盖:

handleTcClientConnectResponse 在类中 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)

覆盖:

handleCommandWatchTopicListSuccess 在类中 PulsarDecoder

handleCommandWatchTopicUpdate

protected void handleCommandWatchTopicUpdate(CommandWatchTopicUpdate commandWatchTopicUpdate)

覆盖:

handleCommandWatchTopicUpdate 在类中 PulsarDecoder

registerTransactionBufferHandler

public void registerTransactionBufferHandler(TransactionBufferHandler handler)

getPulsarClientException

public static PulsarClientException getPulsarClientException(ServerError error,
 String errorMsg)

close

public void close()

userEventTriggered

public void userEventTriggered(io.netty.channel.ChannelHandlerContext ctx,
 Object evt)
                        throws Exception

指定者:

userEventTriggered 在接口中 io.netty.channel.ChannelInboundHandler

覆盖:

userEventTriggered 在类中 io.netty.channel.ChannelInboundHandlerAdapter

抛出:

Exception

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.

返回:

true if the connection is eligible.