ftl_messaging_client.h

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

#ifndef REMOTING_SIGNALING_FTL_MESSAGING_CLIENT_H_
#define REMOTING_SIGNALING_FTL_MESSAGING_CLIENT_H_

#include <memory>
#include <string>

#include "base/memory/raw_ptr.h"
#include "base/memory/scoped_refptr.h"
#include "remoting/signaling/message_tracker.h"
#include "remoting/signaling/messaging_client.h"

namespace google {
namespace protobuf {
class MessageLite;
}  // namespace protobuf
}  // namespace google

namespace net {
struct NetworkTrafficAnnotationTag;
}  // namespace net

namespace network {
class SharedURLLoaderFactory;
}  // namespace network

namespace remoting {

class ProtobufHttpClient;
class MessageReceptionChannel;
class OAuthTokenGetter;
class RegistrationManager;
class ScopedProtobufHttpRequest;
class SignalingTracker;

// A class for sending and receiving messages via the FTL API.
class FtlMessagingClient final : public MessagingClient {
 public:
  // |signaling_tracker| is nullable.
  // Raw pointers must outlive |this|.
  FtlMessagingClient(
      OAuthTokenGetter* token_getter,
      scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
      RegistrationManager* registration_manager,
      SignalingTracker* signaling_tracker = nullptr);

  FtlMessagingClient(const FtlMessagingClient&) = delete;
  FtlMessagingClient& operator=(const FtlMessagingClient&) = delete;

  ~FtlMessagingClient() override;

  // MessagingClient implementations.
  base::CallbackListSubscription RegisterMessageCallback(
      const MessageCallback& callback) override;
  void SendMessage(const std::string& destination,
                   const std::string& destination_registration_id,
                   const ftl::ChromotingMessage& message,
                   DoneCallback on_done) override;
  void StartReceivingMessages(base::OnceClosure on_ready,
                              DoneCallback on_closed) override;
  void StopReceivingMessages() override;
  bool IsReceivingMessages() const override;

 private:
  friend class FtlMessagingClientTest;

  FtlMessagingClient(std::unique_ptr<ProtobufHttpClient> client,
                     RegistrationManager* registration_manager,
                     std::unique_ptr<MessageReceptionChannel> channel);

  template <typename CallbackFunctor>
  void ExecuteRequest(const net::NetworkTrafficAnnotationTag& tag,
                      const std::string& path,
                      std::unique_ptr<google::protobuf::MessageLite> request,
                      CallbackFunctor callback_functor,
                      DoneCallback on_done);

  void OnSendMessageResponse(DoneCallback on_done,
                             const ProtobufHttpStatus& status,
                             std::unique_ptr<ftl::InboxSendResponse> response);

  void BatchAckMessages(const ftl::BatchAckMessagesRequest& request,
                        DoneCallback on_done);

  void OnBatchAckMessagesResponse(
      DoneCallback on_done,
      const ProtobufHttpStatus& status,
      std::unique_ptr<ftl::BatchAckMessagesResponse> response);

  std::unique_ptr<ScopedProtobufHttpRequest> OpenReceiveMessagesStream(
      base::OnceClosure on_channel_ready,
      const base::RepeatingCallback<
          void(std::unique_ptr<ftl::ReceiveMessagesResponse>)>& on_incoming_msg,
      base::OnceCallback<void(const ProtobufHttpStatus&)> on_channel_closed);

  void RunMessageCallbacks(const ftl::InboxMessage& message);

  void OnMessageReceived(const ftl::InboxMessage& message);

  std::unique_ptr<ProtobufHttpClient> client_;
  raw_ptr<RegistrationManager> registration_manager_;
  std::unique_ptr<MessageReceptionChannel> reception_channel_;
  MessageCallbackList callback_list_;
  MessageTracker message_tracker_;
};

}  // namespace remoting

#endif  // REMOTING_SIGNALING_FTL_MESSAGING_CLIENT_H_