Files
flipper/iOS/FlipperKit/FlipperClient.h
Lorenzo Blasa 63f8c47cfa New 'isConnected' API
Summary: Expose the newly created `isConnected` API to iOS FlipperClient API.

Reviewed By: antonk52

Differential Revision: D46841190

fbshipit-source-id: c36eb08427d60c73fad8f92100df5d012149b4a8
2023-06-20 00:46:55 -07:00

93 lines
2.0 KiB
Objective-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.
*/
#ifdef FB_SONARKIT_ENABLED
#import <Foundation/Foundation.h>
#import "FlipperKitCertificateProvider.h"
#import "FlipperPlugin.h"
#import "FlipperStateUpdateListener.h"
/**
Represents a connection between the Flipper desktop client side. Manages the
lifecycle of attached plugin instances.
*/
@interface FlipperClient : NSObject
/**
The shared singleton FlipperClient instance. It is an error to call this on
non-debug builds to avoid leaking data.
*/
+ (instancetype)sharedClient;
/**
Register a plugin with the client.
*/
- (void)addPlugin:(NSObject<FlipperPlugin>*)plugin;
/**
Unregister a plugin with the client.
*/
- (void)removePlugin:(NSObject<FlipperPlugin>*)plugin;
/**
Retrieve the plugin with a given identifier which was previously registered with
this client.
*/
- (NSObject<FlipperPlugin>*)pluginWithIdentifier:(NSString*)identifier;
/**
Establish a connection to the Flipper desktop.
*/
- (void)start;
/**
Stop the connection to the Flipper desktop.
*/
- (void)stop;
/**
Get the log of state changes from the Flipper client.
*/
- (NSString*)getState;
/**
Get the current summarized state of the Flipper client.
*/
- (NSArray<NSDictionary*>*)getStateElements;
/**
Return true if the app is connected to Flipper desktop. Otherwise, returns
false.
*/
- (BOOL)isConnected;
/**
Subscribe a ViewController to state update change notifications.
*/
- (void)subscribeForUpdates:(id<FlipperStateUpdateListener>)controller;
/**
Sets the certificate provider responsible for obtaining certificates.
*/
- (void)setCertificateProvider:(id<FlipperKitCertificateProvider>)provider;
/**
Get the certificate provider of Flipper Client.
*/
- (id<FlipperKitCertificateProvider>)getCertificateProvider;
// Initializers are disabled. You must use `+[FlipperClient sharedClient]`
// instance.
- (instancetype)init NS_UNAVAILABLE;
+ (instancetype)new NS_UNAVAILABLE;
@end
#endif