NvPSFKafka.h File Reference

#include <stddef.h>

Go to the source code of this file.

Classes
struct	NvPSFKafkaStatus

Typedefs
typedef struct NvPSFKafkaHandle_t	NvPSFKafkaHandle

Enumerations
enum	NvPSFKafkaErr { NvPSFKAFKA_SUCCESS = 0 , NvPSFKAFKA_FAIL = 1 }
enum	NvPSFKafkaEndpointType { KAFKA_PRODUCER = 0 , KAFKA_CONSUMER = 1 }

Functions
NvPSFKafkaStatus	NvPSFKafkaCreate (const char *brokers, const char *topic, NvPSFKafkaEndpointType endpointType, const char *group_id, NvPSFKafkaHandle **out_handle)
	Create a Kafka producer or consumer handle. More...
NvPSFKafkaStatus	NvPSFKafkaDestroy (NvPSFKafkaHandle *handle)
	Destroy a Kafka handle and free resources. More...
NvPSFKafkaStatus	NvPSFKafkaSend (NvPSFKafkaHandle *handle, const void *msg, size_t msgLen)
	Send a message to Kafka (producer only). More...
NvPSFKafkaStatus	NvPSFKafkaReceive (NvPSFKafkaHandle *handle, void *buffer, size_t bufferLen, size_t *outLen)
	Receive a message from Kafka (consumer only). More...
NvPSFKafkaStatus	NvPSFKafkaSeekToEnd (NvPSFKafkaHandle *handle)
	Seek to the end of partitions after subscription (consumer only). More...

Typedef Documentation

NvPSFKafkaHandle

typedef struct NvPSFKafkaHandle_t NvPSFKafkaHandle

Enumeration Type Documentation

NvPSFKafkaEndpointType

enum NvPSFKafkaEndpointType

Enumerator
KAFKA_PRODUCER
KAFKA_CONSUMER

             {
    KAFKA_PRODUCER = 0,
    KAFKA_CONSUMER = 1
} NvPSFKafkaEndpointType;

NvPSFKafkaErr

enum NvPSFKafkaErr

Enumerator
NvPSFKAFKA_SUCCESS
NvPSFKAFKA_FAIL

             {
    NvPSFKAFKA_SUCCESS = 0,
    NvPSFKAFKA_FAIL = 1
} NvPSFKafkaErr;

Function Documentation

NvPSFKafkaCreate()

NvPSFKafkaStatus NvPSFKafkaCreate	(	const char *	brokers,
		const char *	topic,
		NvPSFKafkaEndpointType	endpointType,
		const char *	group_id,
		NvPSFKafkaHandle **	out_handle
	)

Create a Kafka producer or consumer handle.

Parameters

brokers	Comma-separated list of broker addresses.
topic	Kafka topic name.
endpointType	Producer or Consumer.
group_id	(Consumer only) Consumer group ID, NULL for producer.
out_handle	Pointer to handle pointer to be set on success.

Returns

NvPSFKafkaStatus indicating success or failure.

NvPSFKafkaDestroy()

NvPSFKafkaStatus NvPSFKafkaDestroy

(

NvPSFKafkaHandle *

handle

)

Destroy a Kafka handle and free resources.

Parameters

handle

Pointer to NvPSFKafkaHandle.

Returns

NvPSFKafkaStatus indicating success or failure.

NvPSFKafkaReceive()

NvPSFKafkaStatus NvPSFKafkaReceive	(	NvPSFKafkaHandle *	handle,
		void *	buffer,
		size_t	bufferLen,
		size_t *	outLen
	)

Receive a message from Kafka (consumer only).

Parameters

handle	NvPSFKafkaHandle for consumer.
buffer	Buffer to store received message.
bufferLen	Size of buffer.
outLen	Pointer to size_t to store actual message length.

Returns

NvPSFKafkaStatus indicating success or failure and number of bytes received.

NvPSFKafkaSeekToEnd()

NvPSFKafkaStatus NvPSFKafkaSeekToEnd

(

NvPSFKafkaHandle *

handle

)

Seek to the end of partitions after subscription (consumer only).

Parameters

handle

NvPSFKafkaHandle for consumer.

Returns

NvPSFKafkaStatus indicating success or failure.

NvPSFKafkaSend()

NvPSFKafkaStatus NvPSFKafkaSend	(	NvPSFKafkaHandle *	handle,
		const void *	msg,
		size_t	msgLen
	)

Send a message to Kafka (producer only).

Parameters

handle	NvPSFKafkaHandle for producer.
msg	Pointer to message data.
msgLen	Length of message.

Returns

NvPSFKafkaStatus indicating success or failure.