com.rabbitmq.client.amqp.RpcServer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of amqp-client Show documentation

The RabbitMQ AMQP 1.0 Java client library defines an API to access RabbitMQ with the AMQP 1.0 protocol.

There is a newer version: 0.1.0

// Copyright (c) 2024 Broadcom. All Rights Reserved.
// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// If you have any questions regarding licensing, please contact us at
// [email protected].
package com.rabbitmq.client.amqp;

/**
 * Client server class for RPC.
 *
 * @see RpcServerBuilder
 */
public interface RpcServer extends AutoCloseable {

  /** Contract to process a request message and return a reply message. */
  @FunctionalInterface
  interface Handler {

    /**
     * Process request message.
     *
     * @param ctx context
     * @param request request message
     * @return the reply message
     */
    Message handle(Context ctx, Message request);
  }

  /** Request processing context. */
  interface Context {

    /**
     * Create a message meant to be published by the underlying publisher instance.
     *
     * Once returned in the {@link Handler#handle(Context, Message)} the message instance should
     * be not be modified or even reused.
     *
     * @return a message
     */
    Message message();

    /**
     * Create a message meant to be published by the underlying publisher instance.
     *
     * Once returned in the {@link Handler#handle(Context, Message)} the message instance should
     * be not be modified or even reused.
     *
     * @param body message body
     * @return a message with the provided body
     */
    Message message(byte[] body);
  }

  /** Close the RPC server and its resources. */
  @Override
  void close();
}