xref: /aosp_15_r20/external/openscreen/cast/streaming/rpc_messenger.h (revision 3f982cf4871df8771c9d4abe6e9a6f8d829b2736)

// Copyright 2020 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CAST_STREAMING_RPC_MESSENGER_H_
#define CAST_STREAMING_RPC_MESSENGER_H_

#include <memory>
#include <string>
#include <utility>
#include <vector>

#include "cast/streaming/remoting.pb.h"
#include "util/flat_map.h"
#include "util/weak_ptr.h"

namespace openscreen {
namespace cast {

// Processes incoming and outgoing RPC messages and links them to desired
// components on both end points. For outgoing messages, the messenger
// must send an RPC message with associated handle value. On the messagee side,
// the message is sent to a pre-registered component using that handle.
// Before RPC communication starts, both sides need to negotiate the handle
// value in the existing RPC communication channel using the special handles
// |kAcquire*Handle|.
//
// NOTE: RpcMessenger doesn't actually send RPC messages to the remote. The session
// messenger needs to set SendMessageCallback, and call ProcessMessageFromRemote
// as appropriate. The RpcMessenger then distributes each RPC message to the
// subscribed component.
class RpcMessenger {
 public:
  using Handle = int;
  using ReceiveMessageCallback =
      std::function<void(std::unique_ptr<RpcMessage>)>;
  using SendMessageCallback = std::function<void(std::vector<uint8_t>)>;

  explicit RpcMessenger(SendMessageCallback send_message_cb);
  RpcMessenger(const RpcMessenger&) = delete;
  RpcMessenger(RpcMessenger&&) noexcept;
  RpcMessenger& operator=(const RpcMessenger&) = delete;
  RpcMessenger& operator=(RpcMessenger&&);
  ~RpcMessenger();

  // Get unique handle value for RPC message handles.
  Handle GetUniqueHandle();

  // Register a component to receive messages via the given
  // ReceiveMessageCallback. |handle| is a unique handle value provided by a
  // prior call to GetUniqueHandle() and is used to reference the component in
  // the RPC messages. The receiver can then use it to direct an RPC message
  // back to a specific component.
  void RegisterMessageReceiverCallback(Handle handle,
                                       ReceiveMessageCallback callback);

  // Allows components to unregister in order to stop receiving message.
  void UnregisterMessageReceiverCallback(Handle handle);

  // Distributes an incoming RPC message to the registered (if any) component.
  // The |serialized_message| should be already base64-decoded and ready for
  // deserialization by protobuf.
  void ProcessMessageFromRemote(const uint8_t* message,
                                std::size_t message_len);
  // This overload distributes an already-deserialized message to the
  // registered component.
  void ProcessMessageFromRemote(std::unique_ptr<RpcMessage> message);

  // Executes the |send_message_cb_| using |rpc|.
  void SendMessageToRemote(const RpcMessage& rpc);

  // Checks if the handle is registered for receiving messages. Test-only.
  bool IsRegisteredForTesting(Handle handle);

  // Weak pointer creator.
  WeakPtr<RpcMessenger> GetWeakPtr();

  // Consumers of RPCMessenger may set the send message callback post-hoc
  // in order to simulate different scenarios.
  void set_send_message_cb_for_testing(SendMessageCallback cb) {
    send_message_cb_ = std::move(cb);
  }

  // Predefined invalid handle value for RPC message.
  static constexpr Handle kInvalidHandle = -1;

  // Predefined handle values for RPC messages related to initialization (before
  // the receiver handle(s) are known).
  static constexpr Handle kAcquireRendererHandle = 0;
  static constexpr Handle kAcquireDemuxerHandle = 1;

  // The first handle to return from GetUniqueHandle().
  static constexpr Handle kFirstHandle = 100;

 private:
  // Next unique handle to return from GetUniqueHandle().
  Handle next_handle_;

  // Maps of handle values to associated MessageReceivers.
  FlatMap<Handle, ReceiveMessageCallback> receive_callbacks_;

  // Callback that is ran to send a serialized message.
  SendMessageCallback send_message_cb_;

  WeakPtrFactory<RpcMessenger> weak_factory_{this};
};

}  // namespace cast
}  // namespace openscreen

#endif  // CAST_STREAMING_RPC_MESSENGER_H_