|o||Provides object-oriented API for producing messages.|
|o||Provides Kafka PRODUCE requests.|
Creates new producer client object.
new() takes arguments in key-value pairs. The following arguments are currently recognized:
Connection => $connection $connection is the Kafka::Connection object responsible for communication with the Apache Kafka cluster. CorrelationId => $correlation_id Optional, int32 signed integer, default = undef .
If CorrelationId is not passed to constructor, its value will be assigned automatically (random negative integer).
An exception is thrown if CorrelationId sent with request does not match CorrelationId received in response.
ClientId => $client_id This is a user supplied identifier (string) for the client application.
If ClientId is not passed to constructor, its value will be automatically assigned (to string producer).
RequiredAcks => $acks The $acks should be an int16 signed integer.
Indicates how many acknowledgements the servers should receive before responding to the request.
If it is $NOT_SEND_ANY_RESPONSE the server does not send any response.
If it is $WAIT_WRITTEN_TO_LOCAL_LOG, the server will wait until the data is written to the local log before sending a response.
If it is $BLOCK_UNTIL_IS_COMMITTED the server will block until the message is committed by all in sync replicas before sending a response.
For any number > 1 the server will block waiting for this number of acknowledgements to occur.
$NOT_SEND_ANY_RESPONSE, $WAIT_WRITTEN_TO_LOCAL_LOG, $BLOCK_UNTIL_IS_COMMITTED can be imported from the Kafka module.
Timeout => $timeout This provides a maximum time the server can await the receipt of the number of acknowledgements in RequiredAcks.
Optional, default = $REQUEST_TIMEOUT.
$REQUEST_TIMEOUT is the default timeout that can be imported from the Kafka module.
The following methods are defined for the Kafka::Producer class:
send( $topic, $partition, $messages, $key, $compression_codec )
Sends a messages on a Kafka::Connection object.
Returns a non-blank value (a reference to a hash with server response description) if the message is successfully sent.
send() takes the following arguments:
$topic The $topic must be a normal non-false string of non-zero length. $partition The $partition must be a non-negative integer. $messages The $messages is an arbitrary amount of data (a simple data string or a reference to an array of the data strings). $key The $key is an optional message key, must be a string. $key may used in the producer for partitioning with each message, so the consumer knows the partitioning key. $compression_codec Optional.
$compression_codec sets the required type of $messages compression, if the compression is desirable.
Supported codecs: $COMPRESSION_NONE, $COMPRESSION_GZIP, $COMPRESSION_SNAPPY. (the defaults that can be imported from the Kafka module.
When error is detected, an exception, represented by object of Kafka::Exception::Producer class, is thrown (see Kafka::Exceptions).
code and a more descriptive message provide information about thrown exception. Consult documentation of the Kafka::Exceptions for the list of all available methods.
Invalid argument Invalid arguments were provided to a new constructor or to other method. Cant send Request cannot be sent. Cant recv Response cannot be received. Cant bind TCP connection cant be established on a given host and port. Cant get metadata IO error is present, errors found in the structure of the reply or the reply contains a non-zero error codes. Description leader not found Information about the server-leader is missing in metadata. Mismatch CorrelationId CorrelationId of response doesnt match one in request. There are no known brokers Information about brokers in the cluster is missing. Cant get metadata Obtained metadata is incorrect or failed to obtain metadata.
The basic operation of the Kafka package modules:
Kafka::Int64 - functions to work with 64 bit elements of the protocol on 32 bit systems.
Kafka::Internals - internal constants and functions used by several package modules.
Main page at <http://kafka.apache.org/>
Sergey Gladkov, <firstname.lastname@example.org>
Copyright (C) 2012-2013 by TrackingSoft LLC.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|perl v5.20.3||KAFKA::PRODUCER (3)||2015-02-06|