Files
flipper/iOS/SonarKit/SonarClient.h
John Knox d8e5e31c9a iOS: Update diagnostic screen on state update
Summary: Update the diagnostic screen whenever the sonar state changes.

Reviewed By: priteshrnandgaonkar

Differential Revision: D9218765

fbshipit-source-id: 654a35e309cb43df18bc8c8a645d469eddc1031d
2018-08-20 05:11:49 -07:00

64 lines
1.4 KiB
Objective-C

/*
* Copyright (c) 2018-present, Facebook, Inc.
*
* This source code is licensed under the MIT license found in the LICENSE
* file in the root directory of this source tree.
*
*/
#import <Foundation/Foundation.h>
#import "SonarPlugin.h"
#import "FlipperStateUpdateListener.h"
/**
Represents a connection between the Sonar desktop och client side. Manages the lifecycle of attached
plugin instances.
*/
@interface SonarClient : NSObject
/**
The shared singleton SonarClient 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<SonarPlugin> *)plugin;
/**
Unregister a plugin with the client.
*/
- (void)removePlugin:(NSObject<SonarPlugin> *)plugin;
/**
Retrieve the plugin with a given identifier which was previously registered with this client.
*/
- (NSObject<SonarPlugin> *)pluginWithIdentifier:(NSString *)identifier;
/**
Establish a connection to the Sonar desktop.
*/
- (void)start;
/**
Stop the connection to the Sonar desktop.
*/
- (void)stop;
/**
Get the current state of the sonar client
*/
- (NSString *)getState;
/**
Subscribe a ViewController to state update change notifications
*/
- (void)subscribeForUpdates:(id<FlipperStateUpdateListener>)controller;
// initializers are disabled. You must use `+[SonarClient sharedClient]` instance.
- (instancetype)init NS_UNAVAILABLE;
+ (instancetype)new NS_UNAVAILABLE;
@end