Package org.apache.pulsar.client.impl

Class AbstractBatchMessageContainer

java.lang.Object

org.apache.pulsar.client.impl.AbstractBatchMessageContainer

All Implemented Interfaces:

BatchMessageContainer, BatchMessageContainerBase

public abstract class AbstractBatchMessageContainer
extends Object
implements BatchMessageContainerBase

Batch message container framework.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	batchAllocatedSizeBytes
protected CompressionType	compressionType
protected CompressionCodec	compressor
protected long	currentBatchSizeBytes
protected long	currentTxnidLeastBits
protected long	currentTxnidMostBits
protected static final int	INITIAL_BATCH_BUFFER_SIZE
protected static final int	INITIAL_MESSAGES_NUM
protected int	maxBatchSize
protected int	maxBytesInBatch
protected int	maxMessagesNum
protected int	maxNumMessagesInBatch
protected int	numMessagesInBatch
protected ProducerImpl	producer
protected String	topicName

Constructor Summary

Constructors

Constructor	Description
AbstractBatchMessageContainer()

Method Summary

Modifier and Type	Method	Description
protected void	clearTimestamp()
ProducerImpl.OpSendMsg	createOpSendMsg()	Create OpSendMsg, producer use OpSendMsg to send to the broker.
List<ProducerImpl.OpSendMsg>	createOpSendMsgs()	Create list of OpSendMsg, producer use OpSendMsg to send to the broker.
int	getBatchAllocatedSizeBytes()
long	getCurrentBatchSize()
long	getFirstAddedTimestamp()	Get the timestamp in nanoseconds when the 1st message is added into the batch container.
int	getMaxMessagesNum()
int	getNumMessagesInBatch()
boolean	hasSameTxn(MessageImpl<?> msg)	Check whether the added message belong to the same txn with batch message container.
boolean	haveEnoughSpace(MessageImpl<?> msg)	Check the batch message container have enough space for the message want to add.
protected boolean	isBatchFull()
void	setProducer(ProducerImpl<?> producer)	Set producer of the message batch container.
protected void	tryUpdateTimestamp()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pulsar.client.api.BatchMessageContainer

clear, discard, isEmpty, isMultiBatches

Methods inherited from interface org.apache.pulsar.client.impl.BatchMessageContainerBase

add, hasSameSchema

Field Details

compressionType

protected CompressionType compressionType

compressor

protected CompressionCodec compressor

topicName

protected String topicName

producer

protected ProducerImpl producer

maxNumMessagesInBatch

protected int maxNumMessagesInBatch

maxBytesInBatch

protected int maxBytesInBatch

numMessagesInBatch

protected int numMessagesInBatch

currentBatchSizeBytes

protected long currentBatchSizeBytes

batchAllocatedSizeBytes

protected int batchAllocatedSizeBytes

currentTxnidMostBits

protected long currentTxnidMostBits

currentTxnidLeastBits

protected long currentTxnidLeastBits

INITIAL_BATCH_BUFFER_SIZE

protected static final int INITIAL_BATCH_BUFFER_SIZE

See Also:

• Constant Field Values

INITIAL_MESSAGES_NUM

protected static final int INITIAL_MESSAGES_NUM

See Also:

• Constant Field Values

maxBatchSize

protected int maxBatchSize

maxMessagesNum

protected int maxMessagesNum

Constructor Details

AbstractBatchMessageContainer

public AbstractBatchMessageContainer()

Method Details

haveEnoughSpace

public boolean haveEnoughSpace(MessageImpl<?> msg)

Description copied from interface: BatchMessageContainerBase

Check the batch message container have enough space for the message want to add.

Specified by:

haveEnoughSpace in interface BatchMessageContainerBase

Parameters:

msg - the message want to add

Returns:

return true if the container have enough space for the specific message, otherwise return false.

isBatchFull

protected boolean isBatchFull()

getNumMessagesInBatch

public int getNumMessagesInBatch()

Specified by:

getNumMessagesInBatch in interface BatchMessageContainer

getMaxMessagesNum

public int getMaxMessagesNum()

getCurrentBatchSize

public long getCurrentBatchSize()

Specified by:

getCurrentBatchSize in interface BatchMessageContainer

getBatchAllocatedSizeBytes

public int getBatchAllocatedSizeBytes()

Specified by:

getBatchAllocatedSizeBytes in interface BatchMessageContainer

createOpSendMsgs

public List<ProducerImpl.OpSendMsg> createOpSendMsgs()
                                              throws IOException

Description copied from interface: BatchMessageContainerBase

Create list of OpSendMsg, producer use OpSendMsg to send to the broker.

Specified by:

createOpSendMsgs in interface BatchMessageContainerBase

Returns:

list of OpSendMsg

Throws:

IOException

createOpSendMsg

public ProducerImpl.OpSendMsg createOpSendMsg()
                                       throws IOException

Description copied from interface: BatchMessageContainerBase

Create OpSendMsg, producer use OpSendMsg to send to the broker.

Specified by:

createOpSendMsg in interface BatchMessageContainerBase

Returns:

OpSendMsg

Throws:

IOException

setProducer

public void setProducer(ProducerImpl<?> producer)

Description copied from interface: BatchMessageContainerBase

Set producer of the message batch container.

Specified by:

setProducer in interface BatchMessageContainerBase

Parameters:

producer - producer

hasSameTxn

public boolean hasSameTxn(MessageImpl<?> msg)

Description copied from interface: BatchMessageContainerBase

Check whether the added message belong to the same txn with batch message container.

Specified by:

hasSameTxn in interface BatchMessageContainerBase

Parameters:

msg - added message

Returns:

belong to the same txn or not

getFirstAddedTimestamp

public long getFirstAddedTimestamp()

Description copied from interface: BatchMessageContainerBase

Get the timestamp in nanoseconds when the 1st message is added into the batch container.

Specified by:

getFirstAddedTimestamp in interface BatchMessageContainerBase

Returns:

the timestamp in nanoseconds or 0L if the batch container is empty

tryUpdateTimestamp

protected void tryUpdateTimestamp()

clearTimestamp

protected void clearTimestamp()