Files
flipper/xplat/Flipper/FlipperConnectionManager.h
Lorenzo Blasa d1c06c9c46 Do not overload send as this causes issues with folly::dynamic
Summary:
folly::dynamic, std::string, implicit constructors and method overloading is not a good combination.

This renames the send method to sendRaw as to avoid issues with existing plugins currently sending string params.

Reviewed By: mweststrate

Differential Revision: D38827539

fbshipit-source-id: 653f62e41ebfbe93d1af25f39c81f6b05bf84cb4
2022-08-18 09:39:42 -07:00

92 lines
2.0 KiB
C++

/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
#pragma once
#include <folly/json.h>
#include "FlipperCertificateProvider.h"
#include "FlipperResponder.h"
namespace facebook {
namespace flipper {
class FlipperConnectionManager {
public:
class Callbacks;
public:
virtual ~FlipperConnectionManager(){};
/**
Establishes a connection to the ws server.
*/
virtual void start() = 0;
/**
Closes an open connection to the ws server.
*/
virtual void stop() = 0;
/**
Sets the Auth token to be used for hitting an Intern end point
*/
virtual void setCertificateProvider(
const std::shared_ptr<FlipperCertificateProvider> provider) = 0;
/**
Gets the certificate provider
*/
virtual std::shared_ptr<FlipperCertificateProvider>
getCertificateProvider() = 0;
/**
True if there's an open connection.
This method may block if the connection is busy.
*/
virtual bool isOpen() const = 0;
/**
Send message to the ws server.
*/
virtual void sendMessage(const folly::dynamic& message) = 0;
/**
Send message to the ws server.
Note: The `message` argument is expected to contain a valid JSON.
*/
virtual void sendMessageRaw(const std::string& message) = 0;
/**
Handler for connection and message receipt from the ws server.
The callbacks should be set before a connection is established.
*/
virtual void setCallbacks(Callbacks* callbacks) = 0;
/**
Called by ws server when a message has been received.
*/
virtual void onMessageReceived(
const folly::dynamic& message,
std::unique_ptr<FlipperResponder> responder) = 0;
};
class FlipperConnectionManager::Callbacks {
public:
virtual ~Callbacks(){};
virtual void onConnected() = 0;
virtual void onDisconnected() = 0;
virtual void onMessageReceived(
const folly::dynamic& message,
std::unique_ptr<FlipperResponder>) = 0;
};
} // namespace flipper
} // namespace facebook