org.apache.rocketmq.client.apis.consumer.MessageListener Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.rocketmq.client.apis.consumer;
import org.apache.rocketmq.client.apis.message.MessageView;
/**
* MessageListener is used only for the push consumer to process message consumption synchronously.
*
* Refer to {@link PushConsumer}, push consumer will get message from server and dispatch the message to the
* backend thread pool to consumer message concurrently.
*/
public interface MessageListener {
/**
* The callback interface to consume the message.
*
*
You should process the {@link MessageView} and return the corresponding {@link ConsumeResult}.
* The consumption is successful only when {@link ConsumeResult#SUCCESS } is returned, null pointer is returned
* or exception is thrown would cause message consumption failure too.
*/
ConsumeResult consume(MessageView messageView);
}