Implementing a WebSocket Detached Client

WebSocketデタッチクライアント（サブプロトコルなし）の簡単な例として、WebSocketサーバーアプリケーションを使用できますPING_STATELESS。デタッチされたクライアントアプリケーションとして、同じアプリケーションを使用しますPING_STATELESS。

このテストでは、トランザクションSMICMのHTTPポートと、トランザクションSICFのアプリケーションパス/ sap / bc / apc / sap/ping_statelessがアクティブである必要があります。宛先として、内部宛先NONE（宛先タイプを参照）を選択します。これは、クライアントも実行される同じサーバーへの接続（この場合はHTTP / WebSocket接続）を作成するために使用されます。

ノート

デタッチされたクライアントのユースケースの一般的な問題は、APCアプリケーションの場合のように、APCまたはAMCを介して受信したメッセージをピアに送り返すAPCアプリケーションを使用することですPING。このアプリケーションがAPCサーバーとデタッチクライアントアプリケーションとして同時に使用されている場合、つまり接続の両方のエンドポイントで使用されている場合、サーバーに送信されたメッセージはサーバーとデタッチクライアントの間でエコーされます。この「ピンポン」効果は、接続が閉じられるまで、たとえば接続接続ハンドルを使用した外部セッションから、際限なく発生します。

このテストでは、サーバーおよびデタッチされたクライアントアプリケーションと同じアプリケーションも使用します。ただし、フォームパラメータno_operation = trueを使用することにより、ピア間のメッセージの「ピンポン」を回避します。このパラメータを使用すると、アプリケーションは受信したメッセージをピアに返送しないように命令されます。

レポートYRS_APC_WSP_DETACH_CLIENTは、WebSocketデタッチクライアントの簡単な実装を提供します。

サンプルコード

REPORT YRS_APC_WSP_DETACH_CLIENT.PARAMETERS: rel_url TYPE string LOWER CASE DEFAULT '/sap/bc/apc/sap/ping_stateless?no_operation=true',            "path & query for APC WebSocket server application PING_STATELESS            appl_id TYPE apc_application_id  DEFAULT 'PING_STATELESS', "client detach application id            message TYPE string LOWER CASE DEFAULT 'Say hello !',            send_no TYPE i DEFAULT 2. " number of messages being sent" implementing class for the event handler interface IF_APC_WSP_EVENT_HANDLERCLASS lcl_apc_handler DEFINITION  FINAL  CREATE PUBLIC .  PUBLIC SECTION.    INTERFACES: if_apc_wsp_event_handler.    DATA      : m_connection_attach_handle TYPE string.    DATA      : m_message TYPE string.ENDCLASS.CLASS lcl_apc_handler IMPLEMENTATION.  METHOD if_apc_wsp_event_handler~on_open.    " determine the connection attach handle    TRY.        m_connection_attach_handle = i_context->get_connection_attach_handle( EXPORTING i_connection_security = i_context->co_con_security_by_user_id ).      CATCH cx_apc_error INTO DATA(lx_apc_error).        m_message = lx_apc_error->get_text( ).    ENDTRY.  ENDMETHOD.  METHOD if_apc_wsp_event_handler~on_message.    " no message handling section for detach client !  ENDMETHOD.  METHOD if_apc_wsp_event_handler~on_close.    "close handling    m_message = 'Connection closed !'.  ENDMETHOD.  METHOD if_apc_wsp_event_handler~on_error.    "error/close handling  ENDMETHOD.ENDCLASS.START-OF-SELECTION.  DATA: lo_client_detach   TYPE REF TO if_apc_wsp_client_conn_detach.  DATA: lo_client_attach   TYPE REF TO if_apc_wsp_client_conn_attach.  DATA: lo_event_handler   TYPE REF TO lcl_apc_handler.  DATA: lo_message_manager TYPE REF TO if_apc_wsp_message_manager.  DATA: lo_message         TYPE REF TO if_apc_wsp_message.  TRY.      " create the event handler object,  the interface IF_APC_WSP_EVENT_HANDLER is implemented in local class lcl_apc_handler      CREATE OBJECT lo_event_handler.      " create the WebSocket client object      lo_client_detach = cl_apc_wsp_client_conn_manager=>create_by_destination(                           i_destination      = 'NONE'  "NONE refers to the HTTP host & port of present server                           i_application_id   = appl_id                           i_event_handler    = lo_event_handler ).      " set the application path and query      DATA(lo_request) = lo_client_detach->get_context( )->get_initial_request( ).      lo_request->set_path_and_query( i_relative_uri = rel_url ).      " create the WebSocket client object      lo_client_detach->connect_and_detach( ).      "create client attach object using connection attach handle for sending the message      lo_client_attach = cl_apc_wsp_client_conn_manager=>attach( lo_event_handler->m_connection_attach_handle ).      lo_message_manager ?= lo_client_attach->get_message_manager( ).      lo_message         ?= lo_message_manager->create_message( ).      lo_message->set_text( message ).      " number of messages being sent      DO send_no TIMES.        lo_message_manager->send( lo_message ).      ENDDO.      " close WebSocket connection      lo_client_attach->close( i_reason = 'application closed connection !' ).    CATCH cx_apc_error INTO DATA(lx_apc_error).      MESSAGE lx_apc_error->get_text( ) TYPE 'E'.  ENDTRY.

モニタリング

トランザクションSMWSを使用して、APCサーバーおよびデタッチされたクライアントの実行中のAPCアプリケーションがステートレスであるかステートフルであるかを確認します。また、交換されたメッセージの数も表示されます。

図1は、この例のトランザクションSMWSのモニター項目を示しています。レポートYRS_APC_WSP_DETACH_CLIENTによると、サーバーアプリケーションPING_STATELESSはデタッチクライアントアプリケーションとしても機能します（これらのエントリを監視するために、メソッドCONNECT_AND_DETACHの後にレポートYRS_APC_WSP_DETACH_CLIENTにブレークポイントを設定しました）。

ステートレスデタッチクライアントとステートレスサーバーを示すトランザクションSMWSのエントリの監視

ステートフルデタッチクライアントの例を取得するには、レポートを変更します

YRS_APC_WSP_DETACH_CLIENTは次のとおりです。URL/sap/ bc / apc / sap / ping_stateless？no_operation = true（つまりAPCアプリケーションPING_STATELESS）をURL / sap / bc / apc / sap / ping_stateful？no_operation = true （つまりAPCアプリケーションPING_STATEFUL）に置き換えます。

図2は、サーバーアプリケーションがPING_STATELESSであり、デタッチされたクライアントアプリケーションがである場合のトランザクションSMWSのモニターエントリを示していますPING_STATEFUL。