Implementing an AMQP Client

実装されたコンポーネント
コード例

実装されたコンポーネント

AMQPメッセージを送受信するために、フレームワークの一部として次のコンポーネントが実装されています。

AMQPクライアント：AMQPクライアントオブジェクトは、必要な接続を作成するエンティティを記述します。AMQPclientオブジェクトごとに、1つ以上のAMQPセッションオブジェクトを作成できます。
- AMQPセッション：AMQPセッションオブジェクトは、 AMQP送信/受信オブジェクトを処理するエンティティを記述します。AMQPセッションオブジェクトごとに、1つ以上のAMQP送信/受信オブジェクトを作成できます。
  - AMQP送信、AMQP受信：これらの2つのリンクオブジェクトは、メッセージオブジェクトを処理するエンティティを記述します。

AMQPクライアントの実装は、イベント処理に基づいています。したがって、発生したイベントに対応するには、 AMQPクライアントイベントハンドラのクラスで次のインターフェイスを定義して実装する必要があります。

if_amqp_client_event_handler
- if_amqp_session_event_handler
  - if_amqp_sender_event_handler、if_amqp_receiver_event_handler

コード例

次のコード例は、独自のAMQPクライアントオブジェクトを実装するのに役立ちます。

説明

クライアントイベントハンドラクラスのインスタンスを作成したら、 AMQPクライアントインスタンスを作成して維持し、接続を開く必要があります。
AMQPセッションインスタンスを作成して開始します。

AMQPレシーバーオプションインスタンス、AMQPレシーバーインスタンスを作成し、コマンドを使用してそれらをリンクしますattach。

レシーバーを構成するには、次のレシーバーオプションを使用できます。

受信機リンクレベルでのQoS（サービス品質）	オプション
受信者リンク名-指定されていない場合は、一意にするためにGUIDが作成されます	オプション
目標	オプション
ソース	必須、空の文字列も可能です

AMQP送信者オプションインスタンス、AMQP送信者インスタンスを作成し、コマンドを使用してそれらをリンクしますattach。

送信者を構成するには、次の送信者オプションを使用できます。

送信者リンクレベルのQoS（サービス品質）	オプション
送信者リンク名-指定されていない場合は、一意にするためにGUIDが作成されます	オプション
目標	必須
ソース	オプション

メッセージインスタンスを作成し、それぞれの属性を設定します。
メッセージを送信します。
送信したメッセージを受信します。
AMQPクライアントを閉じます。

サンプルコード

REPORT zamqp_code_example.CLASS lcl_amqp_client_event_handler DEFINITION CREATE PUBLIC FINAL.  PUBLIC SECTION.    INTERFACES:      if_amqp_client_event_handler,      if_amqp_session_event_handler,      if_amqp_receiver_event_handler,      if_amqp_sender_event_handler.    CLASS-DATA:      g_text_data TYPE string READ-ONLY,      g_delivery_state TYPE if_amqp_types=>ty_amqp_delivery_state READ-ONLY.  PRIVATE SECTION.ENDCLASS.CLASS lcl_amqp_client_event_handler IMPLEMENTATION.  METHOD if_amqp_receiver_event_handler~on_message.    TRY.        g_text_data = i_amqp_message->get_text( ).      CATCH cx_amqp_message_error.    ENDTRY.  ENDMETHOD.  METHOD if_amqp_sender_event_handler~on_send ##NEEDED.        g_delivery_state = i_amqp_message_envelope->get_delivery_state( ).  ENDMETHOD.ENDCLASS.START-OF-SELECTION.  TRY.      " Create instance of client event handler class      DATA(lo_event_handler) = NEW lcl_amqp_client_event_handler( ).      " -1-------------------      " Create and maintain the AMQP client instance by calling the factory method create_by_url      DATA(lo_client) = cl_amqp_client_manager=>create_by_url(                                       i_client_event_handler = lo_event_handler                                       i_url                  = 'tcp://<host>:<port>' )."uri of AMQP Broker      DATA(lo_amqp_connect_options) = cl_amqp_connect_options=>create_connect_options( ).      lo_amqp_connect_options->set_container_id( 'demo_container' ).      " Setup the AMQP client connection by invoke of open method      lo_client->open( "i_apc_options  = apc_options "ABAP Push Channels (APC) specific settings                       i_amqp_options = lo_amqp_connect_options ).      " -2-------------------      " Create AMQP session (session is a composite component of AMQP client)      DATA(lo_session) = lo_client->create_session( i_session_event_handler = lo_event_handler ).      " Begin AMQP session      lo_session->begin( ).      " -3-------------------      " Create receiver options instance      DATA(lo_receiver_options) = cl_amqp_receiver_options=>create_receiver_options( ).      lo_receiver_options->set_qos( i_qos = if_amqp_types=>amqp_link_qos-mixed ).      " Create AMQP receiver as listener to receive the sent AMQP messages      DATA(lo_receiver) = lo_session->create_receiver( i_receiver_event_handler = lo_event_handler ).      " Attach receiver      lo_receiver->attach( i_receiver_options = lo_receiver_options                           i_source           = 'demo' ). "Solace Brocker      " -4-------------------      " Create sender options instance      DATA(lo_sender_options) = cl_amqp_sender_options=>create_sender_options( ).      lo_sender_options->set_qos( i_qos = if_amqp_types=>amqp_link_qos-mixed ).      " Create AMQP sender      DATA(lo_sender) = lo_session->create_sender( i_sender_event_handler = lo_event_handler ).      " Note: empty string for target address is allowed. In this case you have to set message attribute like SET_TO for target address      " Attach sender      lo_sender->attach( i_sender_options = lo_sender_options                         i_target         = 'demo' ).      " -5-------------------      " Create message instance      DATA(lo_message) = cl_amqp_message=>create_message( ).      lo_message->set_text( i_message = '123' ).      lo_message->set_qos( i_qos = if_amqp_types=>amqp_message_qos-at_least_once ).      lo_message->set_content_type( i_content_type = 'content-type' ).      lo_message->set_application_property( is_application_property = VALUE #( name = 'name1' value = 'value1' ) ).      " -6-------------------      " send an AMQP message      lo_sender->send( i_message  = lo_message ).      " -7-------------------      " Synchronization point to receive already sent AMQP messages      " Note: AMQP protocol is based on ABAP Push Channels and using the following statement only the      " pending APC requests will be received      WAIT FOR PUSH CHANNELS UNTIL lo_event_handler->g_text_data EQ '123' UP TO 1 SECONDS.      WRITE |WAIT RC: { sy-subrc }|. SKIP.      WRITE |Message received: { lo_event_handler->g_text_data }| ##NO_TEXT.      " Wait for Acknowledgement of message, especially if the message was sent using "at_least_once"!      WAIT UP TO 1 SECONDS.      " -8-------------------      " Close AMQP Client.      " AMQP Close will trigger the session->end method and cleanup session artifacts      " Detach Method in sender/receiver object will be called when the AMQP session object is ended.      lo_client->close( ).      CATCH cx_static_check INTO DATA(lx_exception).      WRITE: 'exception', lx_exception->get_text( ).  ENDTRY.

アプリケーションにAMQPクライアントを実装すると、メッセージを送受信できるようになります。