How to use

PutMessageResult

in

org.apache.rocketmq.store

private boolean putBackHalfMsgQueue(MessageExt msgExt, long offset) {
  PutMessageResult putMessageResult = putBackToHalfQueueReturnResult(msgExt);
  if (putMessageResult != null
    && putMessageResult.getPutMessageStatus() == PutMessageStatus.PUT_OK) {
    msgExt.setQueueOffset(
      putMessageResult.getAppendMessageResult().getLogicsOffset());
    msgExt.setCommitLogOffset(
      putMessageResult.getAppendMessageResult().getWroteOffset());
    msgExt.setMsgId(putMessageResult.getAppendMessageResult().getMsgId());
    log.info(
      "Send check message, the offset={} restored in queueOffset={} "
        + "commitLogOffset={} "
        + "newMsgId={} realMsgId={} topic={}",
      offset, msgExt.getQueueOffset(), msgExt.getCommitLogOffset(), msgExt.getMsgId(),
      msgExt.getUserProperty(MessageConst.PROPERTY_UNIQ_CLIENT_MESSAGE_ID_KEYIDX),
      msgExt.getTopic());
    return true;
  } else {
    log.error(
      "PutBackToHalfQueueReturnResult write failed, topic: {}, queueId: {}, "
        + "msgId: {}",
      msgExt.getTopic(), msgExt.getQueueId(), msgExt.getMsgId());
    return false;
  }
}

public PutMessageResult putMessage(MessageExtBrokerInner msg) {
  if (this.shutdown) {
    log.warn("message store has shutdown, so putMessage is forbidden");
    return new PutMessageResult(PutMessageStatus.SERVICE_NOT_AVAILABLE, null);
    return new PutMessageResult(PutMessageStatus.SERVICE_NOT_AVAILABLE, null);
    return new PutMessageResult(PutMessageStatus.SERVICE_NOT_AVAILABLE, null);
  } else {
    this.printTimes.set(0);
    return new PutMessageResult(PutMessageStatus.MESSAGE_ILLEGAL, null);
    return new PutMessageResult(PutMessageStatus.PROPERTIES_SIZE_EXCEEDED, null);
    return new PutMessageResult(PutMessageStatus.OS_PAGECACHE_BUSY, null);
  if (null == result || !result.isOk()) {
    this.storeStatsService.getPutMessageFailedTimes().incrementAndGet();

public void handleHA(AppendMessageResult result, PutMessageResult putMessageResult, MessageExt messageExt) {
  if (BrokerRole.SYNC_MASTER == this.defaultMessageStore.getMessageStoreConfig().getBrokerRole()) {
    HAService service = this.defaultMessageStore.getHaService();
    if (messageExt.isWaitStoreMsgOK()) {
      // Determine whether to wait
      if (service.isSlaveOK(result.getWroteOffset() + result.getWroteBytes())) {
        GroupCommitRequest request = new GroupCommitRequest(result.getWroteOffset() + result.getWroteBytes());
        service.putRequest(request);
        service.getWaitNotifyObject().wakeupAll();
        boolean flushOK =
          request.waitForFlush(this.defaultMessageStore.getMessageStoreConfig().getSyncFlushTimeout());
        if (!flushOK) {
          log.error("do sync transfer other node, wait return, but failed, topic: " + messageExt.getTopic() + " tags: "
            + messageExt.getTags() + " client address: " + messageExt.getBornHostNameString());
          putMessageResult.setPutMessageStatus(PutMessageStatus.FLUSH_SLAVE_TIMEOUT);
        }
      }
      // Slave problem
      else {
        // Tell the producer, slave not available
        putMessageResult.setPutMessageStatus(PutMessageStatus.SLAVE_NOT_AVAILABLE);
      }
    }
  }
}

public boolean putMessage(MessageExtBrokerInner messageInner) {
  PutMessageResult putMessageResult = store.putMessage(messageInner);
  if (putMessageResult != null
    && putMessageResult.getPutMessageStatus() == PutMessageStatus.PUT_OK) {
    return true;
  } else {
    LOGGER.error("Put message failed, topic: {}, queueId: {}, msgId: {}",
      messageInner.getTopic(), messageInner.getQueueId(), messageInner.getMsgId());
    return false;
  }
}

  return new PutMessageResult(PutMessageStatus.MESSAGE_ILLEGAL, null);
  return new PutMessageResult(PutMessageStatus.MESSAGE_ILLEGAL, null);
    log.error("Create mapped file1 error, topic: {} clientAddr: {}", messageExtBatch.getTopic(), messageExtBatch.getBornHostString());
    beginTimeInLock = 0;
    return new PutMessageResult(PutMessageStatus.CREATE_MAPEDFILE_FAILED, null);
        return new PutMessageResult(PutMessageStatus.CREATE_MAPEDFILE_FAILED, result);
    case PROPERTIES_SIZE_EXCEEDED:
      beginTimeInLock = 0;
      return new PutMessageResult(PutMessageStatus.MESSAGE_ILLEGAL, result);
    case UNKNOWN_ERROR:
      beginTimeInLock = 0;
      return new PutMessageResult(PutMessageStatus.UNKNOWN_ERROR, result);
    default:
      beginTimeInLock = 0;
      return new PutMessageResult(PutMessageStatus.UNKNOWN_ERROR, result);
PutMessageResult putMessageResult = new PutMessageResult(PutMessageStatus.PUT_OK, result);

  && putMessageResult.getPutMessageStatus() == PutMessageStatus.PUT_OK) {
  continue;
} else {

    log.error("create mapped file1 error, topic: " + msg.getTopic() + " clientAddr: " + msg.getBornHostString());
    beginTimeInLock = 0;
    return new PutMessageResult(PutMessageStatus.CREATE_MAPEDFILE_FAILED, null);
        return new PutMessageResult(PutMessageStatus.CREATE_MAPEDFILE_FAILED, result);
    case PROPERTIES_SIZE_EXCEEDED:
      beginTimeInLock = 0;
      return new PutMessageResult(PutMessageStatus.MESSAGE_ILLEGAL, result);
    case UNKNOWN_ERROR:
      beginTimeInLock = 0;
      return new PutMessageResult(PutMessageStatus.UNKNOWN_ERROR, result);
    default:
      beginTimeInLock = 0;
      return new PutMessageResult(PutMessageStatus.UNKNOWN_ERROR, result);
PutMessageResult putMessageResult = new PutMessageResult(PutMessageStatus.PUT_OK, result);

switch (putMessageResult.getPutMessageStatus()) {
if (sendOK) {
  this.brokerController.getBrokerStatsManager().incTopicPutNums(msg.getTopic(), putMessageResult.getAppendMessageResult().getMsgNum(), 1);
  this.brokerController.getBrokerStatsManager().incTopicPutSize(msg.getTopic(),
    putMessageResult.getAppendMessageResult().getWroteBytes());
  this.brokerController.getBrokerStatsManager().incBrokerPutNums(putMessageResult.getAppendMessageResult().getMsgNum());
  responseHeader.setMsgId(putMessageResult.getAppendMessageResult().getMsgId());
  responseHeader.setQueueId(queueIdInt);
  responseHeader.setQueueOffset(putMessageResult.getAppendMessageResult().getLogicsOffset());
    int wroteSize = putMessageResult.getAppendMessageResult().getWroteBytes();
    int incValue = (int)Math.ceil(wroteSize / BrokerStatsManager.SIZE_PER_COUNT) * commercialBaseCount;

final PutMessageResult putMessageResult = this.brokerController.getMessageStore().putMessage(msgInner);
if (putMessageResult != null) {
  switch (putMessageResult.getPutMessageStatus()) {

public PutMessageResult putMessages(MessageExtBatch messageExtBatch) {
  if (this.shutdown) {
    log.warn("DefaultMessageStore has shutdown, so putMessages is forbidden");
    return new PutMessageResult(PutMessageStatus.SERVICE_NOT_AVAILABLE, null);
    return new PutMessageResult(PutMessageStatus.SERVICE_NOT_AVAILABLE, null);
    return new PutMessageResult(PutMessageStatus.SERVICE_NOT_AVAILABLE, null);
  } else {
    this.printTimes.set(0);
    return new PutMessageResult(PutMessageStatus.MESSAGE_ILLEGAL, null);
    return new PutMessageResult(PutMessageStatus.MESSAGE_ILLEGAL, null);
    return new PutMessageResult(PutMessageStatus.OS_PAGECACHE_BUSY, null);
  if (null == result || !result.isOk()) {
    this.storeStatsService.getPutMessageFailedTimes().incrementAndGet();

public void handleDiskFlush(AppendMessageResult result, PutMessageResult putMessageResult, MessageExt messageExt) {
  // Synchronization flush
  if (FlushDiskType.SYNC_FLUSH == this.defaultMessageStore.getMessageStoreConfig().getFlushDiskType()) {
    final GroupCommitService service = (GroupCommitService) this.flushCommitLogService;
    if (messageExt.isWaitStoreMsgOK()) {
      GroupCommitRequest request = new GroupCommitRequest(result.getWroteOffset() + result.getWroteBytes());
      service.putRequest(request);
      boolean flushOK = request.waitForFlush(this.defaultMessageStore.getMessageStoreConfig().getSyncFlushTimeout());
      if (!flushOK) {
        log.error("do groupcommit, wait for flush failed, topic: " + messageExt.getTopic() + " tags: " + messageExt.getTags()
          + " client address: " + messageExt.getBornHostString());
        putMessageResult.setPutMessageStatus(PutMessageStatus.FLUSH_DISK_TIMEOUT);
      }
    } else {
      service.wakeup();
    }
  }
  // Asynchronous flush
  else {
    if (!this.defaultMessageStore.getMessageStoreConfig().isTransientStorePoolEnable()) {
      flushCommitLogService.wakeup();
    } else {
      commitLogService.wakeup();
    }
  }
}

  return new PutMessageResult(PutMessageStatus.MESSAGE_ILLEGAL, null);
  return new PutMessageResult(PutMessageStatus.MESSAGE_ILLEGAL, null);
} catch (RuntimeException e) {
  log.error("encode error:", e);
  return new PutMessageResult(PutMessageStatus.MESSAGE_ILLEGAL, null);
    log.error("Create mapped file1 error, topic: {} clientAddr: {}", messageExtBatch.getTopic(), messageExtBatch.getBornHostString());
    beginTimeInLock = 0;
    return new PutMessageResult(PutMessageStatus.CREATE_MAPEDFILE_FAILED, null);
        return new PutMessageResult(PutMessageStatus.CREATE_MAPEDFILE_FAILED, result);
    case PROPERTIES_SIZE_EXCEEDED:
      beginTimeInLock = 0;
      return new PutMessageResult(PutMessageStatus.MESSAGE_ILLEGAL, result);
    case UNKNOWN_ERROR:
      beginTimeInLock = 0;
      return new PutMessageResult(PutMessageStatus.UNKNOWN_ERROR, result);
    default:
      beginTimeInLock = 0;
      return new PutMessageResult(PutMessageStatus.UNKNOWN_ERROR, result);
PutMessageResult putMessageResult = new PutMessageResult(PutMessageStatus.PUT_OK, result);

switch (putMessageResult.getPutMessageStatus()) {
if (sendOK) {
  this.brokerController.getBrokerStatsManager().incTopicPutNums(msg.getTopic(), putMessageResult.getAppendMessageResult().getMsgNum(), 1);
  this.brokerController.getBrokerStatsManager().incTopicPutSize(msg.getTopic(),
    putMessageResult.getAppendMessageResult().getWroteBytes());
  this.brokerController.getBrokerStatsManager().incBrokerPutNums(putMessageResult.getAppendMessageResult().getMsgNum());
  responseHeader.setMsgId(putMessageResult.getAppendMessageResult().getMsgId());
  responseHeader.setQueueId(queueIdInt);
  responseHeader.setQueueOffset(putMessageResult.getAppendMessageResult().getLogicsOffset());
    int wroteSize = putMessageResult.getAppendMessageResult().getWroteBytes();
    int incValue = (int) Math.ceil(wroteSize / BrokerStatsManager.SIZE_PER_COUNT) * commercialBaseCount;

switch (putMessageResult.getPutMessageStatus()) {
  case PUT_OK:
    String backTopic = msgExt.getTopic();
response.setRemark(putMessageResult.getPutMessageStatus().name());
return response;

public PutMessageResult putMessage(MessageExtBrokerInner msg) {
  if (this.shutdown) {
    log.warn("message store has shutdown, so putMessage is forbidden");
    return new PutMessageResult(PutMessageStatus.SERVICE_NOT_AVAILABLE, null);
    return new PutMessageResult(PutMessageStatus.SERVICE_NOT_AVAILABLE, null);
    return new PutMessageResult(PutMessageStatus.SERVICE_NOT_AVAILABLE, null);
  } else {
    this.printTimes.set(0);
    return new PutMessageResult(PutMessageStatus.MESSAGE_ILLEGAL, null);
    return new PutMessageResult(PutMessageStatus.PROPERTIES_SIZE_EXCEEDED, null);
    return new PutMessageResult(PutMessageStatus.OS_PAGECACHE_BUSY, null);
  this.storeStatsService.getPutCommitLogTimeStats().add(eclipseTime);
  if (null == result || !result.isOk()) {
    this.storeStatsService.getPutMessageFailedTimes().incrementAndGet();

public void handleHA(AppendMessageResult result, PutMessageResult putMessageResult, MessageExt messageExt) {
  if (BrokerRole.SYNC_MASTER == this.defaultMessageStore.getMessageStoreConfig().getBrokerRole()) {
    HAService service = this.defaultMessageStore.getHaService();
    if (messageExt.isWaitStoreMsgOK()) {
      // Determine whether to wait
      if (service.isSlaveOK(result.getWroteOffset() + result.getWroteBytes())) {
        GroupCommitRequest request = new GroupCommitRequest(result.getWroteOffset() + result.getWroteBytes());
        service.putRequest(request);
        service.getWaitNotifyObject().wakeupAll();
        boolean flushOK =
          request.waitForFlush(this.defaultMessageStore.getMessageStoreConfig().getSyncFlushTimeout());
        if (!flushOK) {
          log.error("do sync transfer other node, wait return, but failed, topic: " + messageExt.getTopic() + " tags: "
            + messageExt.getTags() + " client address: " + messageExt.getBornHostNameString());
          putMessageResult.setPutMessageStatus(PutMessageStatus.FLUSH_SLAVE_TIMEOUT);
        }
      }
      // Slave problem
      else {
        // Tell the producer, slave not available
        putMessageResult.setPutMessageStatus(PutMessageStatus.SLAVE_NOT_AVAILABLE);
      }
    }
  }
}

    log.error("create mapped file1 error, topic: " + msg.getTopic() + " clientAddr: " + msg.getBornHostString());
    beginTimeInLock = 0;
    return new PutMessageResult(PutMessageStatus.CREATE_MAPEDFILE_FAILED, null);
        return new PutMessageResult(PutMessageStatus.CREATE_MAPEDFILE_FAILED, result);
    case PROPERTIES_SIZE_EXCEEDED:
      beginTimeInLock = 0;
      return new PutMessageResult(PutMessageStatus.MESSAGE_ILLEGAL, result);
    case UNKNOWN_ERROR:
      beginTimeInLock = 0;
      return new PutMessageResult(PutMessageStatus.UNKNOWN_ERROR, result);
    default:
      beginTimeInLock = 0;
      return new PutMessageResult(PutMessageStatus.UNKNOWN_ERROR, result);
PutMessageResult putMessageResult = new PutMessageResult(PutMessageStatus.PUT_OK, result);

private boolean putBackHalfMsgQueue(MessageExt msgExt, long offset) {
  PutMessageResult putMessageResult = putBackToHalfQueueReturnResult(msgExt);
  if (putMessageResult != null
    && putMessageResult.getPutMessageStatus() == PutMessageStatus.PUT_OK) {
    msgExt.setQueueOffset(
      putMessageResult.getAppendMessageResult().getLogicsOffset());
    msgExt.setCommitLogOffset(
      putMessageResult.getAppendMessageResult().getWroteOffset());
    msgExt.setMsgId(putMessageResult.getAppendMessageResult().getMsgId());
    log.info(
      "Send check message, the offset={} restored in queueOffset={} "
        + "commitLogOffset={} "
        + "newMsgId={} realMsgId={} topic={}",
      offset, msgExt.getQueueOffset(), msgExt.getCommitLogOffset(), msgExt.getMsgId(),
      msgExt.getUserProperty(MessageConst.PROPERTY_UNIQ_CLIENT_MESSAGE_ID_KEYIDX),
      msgExt.getTopic());
    return true;
  } else {
    log.error(
      "PutBackToHalfQueueReturnResult write failed, topic: {}, queueId: {}, "
        + "msgId: {}",
      msgExt.getTopic(), msgExt.getQueueId(), msgExt.getMsgId());
    return false;
  }
}

  && putMessageResult.getPutMessageStatus() == PutMessageStatus.PUT_OK) {
  continue;
} else {

public PutMessageResult putMessages(MessageExtBatch messageExtBatch) {
  if (this.shutdown) {
    log.warn("DefaultMessageStore has shutdown, so putMessages is forbidden");
    return new PutMessageResult(PutMessageStatus.SERVICE_NOT_AVAILABLE, null);
    return new PutMessageResult(PutMessageStatus.SERVICE_NOT_AVAILABLE, null);
    return new PutMessageResult(PutMessageStatus.SERVICE_NOT_AVAILABLE, null);
  } else {
    this.printTimes.set(0);
      if (topic.length() > Byte.MAX_VALUE) {
        log.warn("PutMessages topic length too long " + topic.length());
        return new PutMessageResult(PutMessageStatus.MESSAGE_ILLEGAL, null);
    if (messageExtBatch.getTopic().length() > Byte.MAX_VALUE) {
      log.warn("PutMessages topic length too long " + messageExtBatch.getTopic().length());
      return new PutMessageResult(PutMessageStatus.MESSAGE_ILLEGAL, null);
    return new PutMessageResult(PutMessageStatus.MESSAGE_ILLEGAL, null);
    return new PutMessageResult(PutMessageStatus.OS_PAGECACHE_BUSY, null);
  this.storeStatsService.getPutCommitLogTimeStats().add(eclipseTime);
  if (null == result || !result.isOk()) {
    this.storeStatsService.getPutMessageFailedTimes().incrementAndGet();