Package org.apache.pulsar.client.impl

Class ClientCnxIdleState

java.lang.Object

org.apache.pulsar.client.impl.ClientCnxIdleState

public class ClientCnxIdleState
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ClientCnxIdleState.State	Indicates the usage status of the connection and whether it has been released.

Constructor Summary

Constructors

Constructor	Description
ClientCnxIdleState(ClientCnx clientCnx)

Method Summary

Modifier and Type	Method	Description
void	doIdleDetect(long maxIdleSeconds)	Check whether the connection is idle, and if so, set the idle-state to #ClientCnxIdleState.State.IDLE.
ClientCnxIdleState.State	getIdleStat()	Get idle-stat.
boolean	isIdle()
boolean	isReleased()
boolean	isReleasing()
boolean	isUsing()
void	tryMarkIdleAndInitIdleTime()	Try to transform the state of the connection to #ClientCnxIdleState.State.IDLE, state should only be transformed to #ClientCnxIdleState.State.IDLE from state #ClientCnxIdleState.State.USING.
boolean	tryMarkReleasedAndCloseConnection()	Changes the idle-state of the connection to #ClientCnxIdleState.State.RELEASED, This method only changes this connection from the #ClientCnxIdleState.State.RELEASING state to the #ClientCnxIdleState.State.RELEASED state, and close if change state to #ClientCnxIdleState.State.RELEASED success.
boolean	tryMarkReleasing()	Changes the idle-state of the connection to #ClientCnxIdleState.State.RELEASING, This method only changes this connection from the #ClientCnxIdleState.State.IDLE state to the #ClientCnxIdleState.State.RELEASING state.
boolean	tryMarkUsingAndClearIdleTime()	Changes the idle-state of the connection to #ClientCnxIdleState.State.USING as much as possible, This method is used when connection borrow, and reset idleMarkTime if change state to #ClientCnxIdleState.State.USING success.

Methods inherited from class java.lang.Object

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

Constructor Details

ClientCnxIdleState

public ClientCnxIdleState(ClientCnx clientCnx)

Method Details

getIdleStat

public ClientCnxIdleState.State getIdleStat()

Get idle-stat.

Returns:

connection idle-stat

isUsing

public boolean isUsing()

Returns:

Whether this connection is in use.

isIdle

public boolean isIdle()

Returns:

Whether this connection is in idle.

isReleasing

public boolean isReleasing()

Returns:

Whether this connection is in idle and will be released soon.

isReleased

public boolean isReleased()

Returns:

Whether this connection has already been released.

tryMarkIdleAndInitIdleTime

public void tryMarkIdleAndInitIdleTime()

Try to transform the state of the connection to #ClientCnxIdleState.State.IDLE, state should only be transformed to #ClientCnxIdleState.State.IDLE from state #ClientCnxIdleState.State.USING. if the state is successfully transformed, "idleMarkTime" will be assigned to current time.

tryMarkUsingAndClearIdleTime

public boolean tryMarkUsingAndClearIdleTime()

Changes the idle-state of the connection to #ClientCnxIdleState.State.USING as much as possible, This method is used when connection borrow, and reset idleMarkTime if change state to #ClientCnxIdleState.State.USING success.

Returns:

Whether change idle-stat to #ClientCnxIdleState.State.USING success. False is returned only if the connection has already been released.

tryMarkReleasing

public boolean tryMarkReleasing()

Changes the idle-state of the connection to #ClientCnxIdleState.State.RELEASING, This method only changes this connection from the #ClientCnxIdleState.State.IDLE state to the #ClientCnxIdleState.State.RELEASING state.

Returns:

Whether change idle-stat to #ClientCnxIdleState.State.RELEASING success.

tryMarkReleasedAndCloseConnection

public boolean tryMarkReleasedAndCloseConnection()

Changes the idle-state of the connection to #ClientCnxIdleState.State.RELEASED, This method only changes this connection from the #ClientCnxIdleState.State.RELEASING state to the #ClientCnxIdleState.State.RELEASED state, and close if change state to #ClientCnxIdleState.State.RELEASED success.

Returns:

Whether change idle-stat to #ClientCnxIdleState.State.RELEASED and close connection success.

doIdleDetect

public void doIdleDetect(long maxIdleSeconds)

Check whether the connection is idle, and if so, set the idle-state to #ClientCnxIdleState.State.IDLE. If the state is already idle and the is reached, set the state to #ClientCnxIdleState.State.RELEASING.