Files
flipper/xplat/Flipper/FlipperConnection.h
Rain ⁣ aa649ff48f standardize C-like MIT copyright headers throughout fbsource
Summary:
`/*` is the standard throughout open source code. For example, Firefox uses single /*: https://hg.mozilla.org/mozilla-central/file/21d22b2f541258d3d1cf96c7ba5ad73e96e616b5/gfx/ipc/CompositorWidgetVsyncObserver.cpp#l3

In addition, Rust considers `/**` to be a doc comment (similar to Javadoc) and having such a comment at the beginning of the file causes `rustc` to barf.

Note that some JavaScript tooling requires `/**`. This is OK since JavaScript files were not covered by the linter in the first place, but it would be good to have that tooling fixed too.

Reviewed By: zertosh

Differential Revision: D15640366

fbshipit-source-id: b4ed4599071516364d6109720750d6a43304c089
2019-06-06 19:40:28 -07:00

53 lines
1.2 KiB
C++

/*
* Copyright (c) Facebook, Inc. and its 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 "FlipperResponder.h"
#include <folly/json.h>
#include <functional>
#include <string>
namespace facebook {
namespace flipper {
/**
Represents a connection between the Desktop and mobile plugins
with corresponding identifiers.
*/
class FlipperConnection {
public:
using FlipperReceiver = std::function<
void(const folly::dynamic&, std::shared_ptr<FlipperResponder>)>;
virtual ~FlipperConnection() {}
/**
Invoke a method on the Flipper desktop plugin with with a matching identifier.
*/
virtual void send(
const std::string& method,
const folly::dynamic& params) = 0;
/**
Report an error to the Flipper desktop app
*/
virtual void error(
const std::string& message,
const std::string& stacktrace) = 0;
/**
Register a receiver to be notified of incoming calls of the given
method from the Flipper desktop plugin with a matching identifier.
*/
virtual void receive(
const std::string& method,
const FlipperReceiver& receiver) = 0;
};
} // namespace flipper
} // namespace facebook