SDK overview

更新时间:
复制 MD 格式

This topic introduces the SDKs for Message Queue for Apache Kafka and their supported programming languages.

Introduction

A Software Development Kit (SDK) is a set of tools for developing applications. It includes resources such as samples, libraries, toolchains, and build scripts. You can use an SDK to develop and compile applications directly in its environment without additional configuration.

SDKs

Message Queue for Apache Kafka provides SDKs for the following programming languages. Use these links to view update histories, download installation packages, and find reference documentation.
SDKDemoSupported protocolReferenceREADME file
Java SDKJava SDK Demo
  • PLAINTEXT
  • SASL_SSL/PLAIN
  • SASL_PLAINTEXT/PLAIN
  • SASL_PLAINTEXT/SCRAM
Send and receive messages using an instance endpointREADME.md
Python SDKPython SDK Demo
  • PLAINTEXT
  • SASL_SSL/PLAIN
Send and receive messages using the Python SDK
C++ SDKC++ SDK Demo
  • PLAINTEXT
  • SASL_SSL/PLAIN
Send and receive messages using the C++ SDK
Go SDKGo SDK Demo
  • PLAINTEXT
  • SASL_SSL/PLAIN
  • SASL_PLAINTEXT/PLAIN
  • SASL_PLAINTEXT/SCRAM
Send and receive messages using the Go SDKREADME.md
PHP SDKPHP SDK Demo
  • PLAINTEXT
  • SASL_SSL/PLAIN
Send and receive messages using the PHP SDK
Ruby SDKRuby SDK Demo
  • PLAINTEXT
  • SASL_SSL/PLAIN
Send and receive messages using the Ruby SDKREADME.md
Node.js SDKNode.js SDK Demo
  • PLAINTEXT
  • SASL_PLAIN
Send and receive messages using the Node.js SDKREADME.md
C# SDKN/A
  • PLAINTEXT
  • SASL_SSL/PLAIN
  • SASL_PLAINTEXT/PLAIN
  • SASL_PLAINTEXT/SCRAM
Send and receive messages using the C# SDKREADME.md

Usage notes

Instance endpoints

Your client application connects to Message Queue for Apache Kafka using various endpoints to send and receive messages.

  • Default Endpoint: Allows clients to connect to a Message Queue for Apache Kafka instance to send and receive messages.
  • SSL Endpoint: Connect to a Message Queue for Apache Kafka instance by using an SSL endpoint and use the PLAIN mechanism to send and receive messages. The PLAIN mechanism is a simple username and password authentication method. Message Queue for Apache Kafka optimizes the PLAIN mechanism, which lets you dynamically add SASL users without restarting the instance.
    Important If your instance uses a 1024-bit SSL certificate and you require stronger security, you can upgrade it to a 4096-bit certificate. For more information, see Upgrade the SSL certificate algorithm.
  • SASL Endpoint: In a VPC, you can connect to Message Queue for Apache Kafka using a SASL endpoint and use the PLAIN or SCRAM mechanism to send and receive messages. SASL supports the following authentication mechanisms:
    • PLAIN: A simple username and password authentication method. The PLAIN mechanism in Message Queue for Apache Kafka allows you to dynamically add SASL users without restarting the instance.
    • Message Queue for Apache KafkaSCRAM-SHA-256: A secure authentication mechanism that uses a hash algorithm on both the client and server to verify usernames and passwords. This mechanism provides higher security than the PLAIN mechanism. It also lets you dynamically add SASL users without an instance restart.

For more information about endpoints, see Endpoint comparison.

Demo usage

Select the demo that matches your instance. Configure the demo file and run it to send and receive messages. For detailed instructions, see the documentation for the specific language.

References