Summary: Never really liked this code. Before this change, calls to connect were blocking. Because of this, we had to make use of promises and a bit of really not that good-looking code. So, this change makes connect non-blocking meaning that we make full use of our event handler. These changes contain: - CSR is not getting generated after each failed attempt. - Connect is no longer blocking. - Do not report events via the handler when explicitly disconnecting. Reviewed By: jknoxville Differential Revision: D46853228 fbshipit-source-id: 00e6a9c7c039a756175fe14982959e078d92bacb
76 lines
2.2 KiB
C++
76 lines
2.2 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/dynamic.h>
|
|
#include <future>
|
|
#include <memory>
|
|
#include "FlipperTransportTypes.h"
|
|
|
|
namespace facebook {
|
|
namespace flipper {
|
|
|
|
class FlipperConnectionManager;
|
|
class ConnectionContextStore;
|
|
class FlipperSocket {
|
|
public:
|
|
virtual ~FlipperSocket() {}
|
|
/**
|
|
Sets the socket event handler. Used to observe underlying socket state
|
|
changes.
|
|
@param eventHandler Observer to be notified of state changes.
|
|
*/
|
|
virtual void setEventHandler(SocketEventHandler eventHandler) {}
|
|
/**
|
|
Sets the socket message handler. Used to handle received messages.
|
|
@param messageHandler Received messages handler.
|
|
*/
|
|
virtual void setMessageHandler(SocketMessageHandler messageHandler) {}
|
|
/**
|
|
Connect the socket to the specified endpoint. This is a blocking call
|
|
meaning that it will return once the socket is connected and ready to be
|
|
used or error.
|
|
@param manager An instance of FlipperConnectionManager.
|
|
*/
|
|
virtual void connect(FlipperConnectionManager* manager) = 0;
|
|
/**
|
|
Disconnect from the endpoint.
|
|
*/
|
|
virtual void disconnect() = 0;
|
|
/**
|
|
Send a message to the receiving end.
|
|
@param message A message to be sent.
|
|
@param completion A completion handler to be invoked when the message has
|
|
been sent.
|
|
*/
|
|
virtual void send(
|
|
const folly::dynamic& message,
|
|
SocketSendHandler completion) = 0;
|
|
/**
|
|
Send a message to the receiving end.
|
|
@param message A message to be sent.
|
|
@param completion A completion handler to be invoked when the message has
|
|
been sent.
|
|
*/
|
|
virtual void send(
|
|
const std::string& message,
|
|
SocketSendHandler completion) = 0;
|
|
/**
|
|
Send a message and expect a response.
|
|
@param message A message to be sent.
|
|
@param completion A completion handler to be invoked when a response is
|
|
received.
|
|
*/
|
|
virtual void sendExpectResponse(
|
|
const std::string& message,
|
|
SocketSendExpectResponseHandler completion) = 0;
|
|
};
|
|
|
|
} // namespace flipper
|
|
} // namespace facebook
|