org.apache.pulsar.functions.instance.processors

Interface MessageProcessor

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AtLeastOnceProcessor

@InterfaceStability.Evolving
public interface MessageProcessor
extends AutoCloseable

A processor that processes messages, used by JavaInstanceRunnable.

Method Summary

Modifier and Type	Method and Description
void	close()
static MessageProcessor	create(org.apache.pulsar.client.api.PulsarClient client, org.apache.pulsar.functions.proto.Function.FunctionDetails functionDetails)
Source	getSource() Return the source.
void	postReceiveMessage(Record record)
Record	recieveMessage() Get the next message to process
void	sendOutputMessage(Record srcRecord, org.apache.pulsar.client.api.MessageBuilder outputMsgBuilder) Send the output message to the output topic.
void	setupInput(Class<?> inputType) Setup the source.
void	setupOutput(org.apache.pulsar.functions.api.SerDe outputSerDe) Setup the output with a provided outputSerDe.

Method Detail

create

static MessageProcessor create(org.apache.pulsar.client.api.PulsarClient client,
                               org.apache.pulsar.functions.proto.Function.FunctionDetails functionDetails)

postReceiveMessage

void postReceiveMessage(Record record)

setupInput

void setupInput(Class<?> inputType)
         throws Exception

Setup the source. Implementation is responsible for initializing the source and for calling open method for source

Parameters:

inputType - the input type of the function

Throws:

Exception

getSource

Source getSource()

Return the source.

Returns:

the source.

setupOutput

void setupOutput(org.apache.pulsar.functions.api.SerDe outputSerDe)
          throws Exception

Setup the output with a provided outputSerDe. The implementation of this processor is responsible for setting up the output

Parameters:

outputSerDe - output serde.

Throws:

Exception

sendOutputMessage

void sendOutputMessage(Record srcRecord,
                       org.apache.pulsar.client.api.MessageBuilder outputMsgBuilder)
                throws org.apache.pulsar.client.api.PulsarClientException,
                       Exception

Send the output message to the output topic. The output message is computed from inputMsg.

If the outputMsgBuilder is null, the implementation doesn't have to send any messages to the output. The implementation can decide to acknowledge the input message based on its process guarantees.

Parameters:

srcRecord - record from source

outputMsgBuilder - output message builder. it can be null.

Throws:

org.apache.pulsar.client.api.PulsarClientException

Exception

recieveMessage

Record recieveMessage()
               throws Exception

Get the next message to process

Returns:

the next input message

Throws:

Exception

close

void close()

Specified by:

close in interface AutoCloseable