blob: 7c95cd357f8fb8787211f1488a5e4ac9107e0dec [file] [log] [blame]
// Copyright 2019 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.
#include <memory>
#include "base/callback_forward.h"
#include "base/callback_list.h"
#include "remoting/proto/ftl/v1/chromoting_message.pb.h"
#include "remoting/proto/ftl/v1/ftl_messages.pb.h"
namespace grpc {
class Status;
} // namespace grpc
namespace remoting {
// An interface to send messages and receive messages from FTL messaging
// service.
class MessagingClient {
using MessageCallback =
base::RepeatingCallback<void(const ftl::Id& sender_id,
const std::string& sender_registration_id,
const ftl::ChromotingMessage& message)>;
using MessageCallbackList = base::CallbackList<
void(const ftl::Id&, const std::string&, const ftl::ChromotingMessage&)>;
using MessageCallbackSubscription = MessageCallbackList::Subscription;
using DoneCallback = base::OnceCallback<void(const grpc::Status& status)>;
virtual ~MessagingClient() = default;
// Registers a callback which is run for each new message received.
// Simply delete the returned subscription object to unregister. The
// subscription object must be deleted before |this| is deleted.
virtual std::unique_ptr<MessageCallbackSubscription> RegisterMessageCallback(
const MessageCallback& callback) = 0;
// Retrieves messages from the user's inbox over slow path and calls the
// registered MessageCallback on every received message.
// |on_done| is called once the messages have been received and acked on the
// server's inbox.
virtual void PullMessages(DoneCallback on_done) = 0;
virtual void SendMessage(const std::string& destination,
const std::string& destination_registration_id,
const ftl::ChromotingMessage& message,
DoneCallback on_done) = 0;
// Opens a stream to continuously receive new messages from the server and
// calls the registered MessageCallback once a new message is received.
// |on_ready| is called once the stream is successfully started.
// |on_closed| is called if the stream fails to start, in which case
// |on_ready| will not be called, or when the stream is closed or dropped,
// in which case it is called after |on_ready| is called.
virtual void StartReceivingMessages(base::OnceClosure on_ready,
DoneCallback on_closed) = 0;
// Stops the stream for continuously receiving new messages.
virtual void StopReceivingMessages() = 0;
// Returns true if the streaming channel is open.
virtual bool IsReceivingMessages() const = 0;
MessagingClient() = default;
} // namespace remoting