Skip to main content

Definition

Assembly: CloudNimble.SimpleMessageBus.Core.dll Namespace: CloudNimble.SimpleMessageBus.Core Inheritance: System.Object

Syntax

CloudNimble.SimpleMessageBus.Core.KafkaOptions

Summary

Specifies the options required to leverage Apache Kafka as the SimpleMessageBus backing queue.

Constructors

.ctor

Creates a new instance with default values from KafkaConstants.

Syntax

public KafkaOptions()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

AuthenticationMode

The SASL authentication mechanism when using SASL protocols.

Syntax

public CloudNimble.SimpleMessageBus.Core.KafkaAuthenticationMode AuthenticationMode { get; set; }

Property Value

Type: CloudNimble.SimpleMessageBus.Core.KafkaAuthenticationMode

BrokerList

The Kafka broker list (e.g., “localhost:9092” or “broker1:9092,broker2:9092”).

Syntax

public string BrokerList { get; set; }

Property Value

Type: string

ConsumerGroup

The consumer group ID for message consumption.

Syntax

public string ConsumerGroup { get; set; }

Property Value

Type: string

MaxBatchSize

Maximum number of messages to process in a batch. Default is 64.

Syntax

public int MaxBatchSize { get; set; }

Property Value

Type: int

Password

SASL password for authentication.

Syntax

public string Password { get; set; }

Property Value

Type: string

Protocol

The security protocol for broker communication.

Syntax

public CloudNimble.SimpleMessageBus.Core.KafkaBrokerProtocol Protocol { get; set; }

Property Value

Type: CloudNimble.SimpleMessageBus.Core.KafkaBrokerProtocol

SslCaLocation

Path to CA certificate file for SSL/TLS verification.

Syntax

public string SslCaLocation { get; set; }

Property Value

Type: string

TopicName

The name of the Kafka topic for messages.

Syntax

public string TopicName { get; set; }

Property Value

Type: string

Username

SASL username for authentication.

Syntax

public string Username { get; set; }

Property Value

Type: string

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

NameTypeDescription
objobject?-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?