Initial commit 🎉
fbshipit-source-id: b6fc29740c6875d2e78953b8a7123890a67930f2 Co-authored-by: Sebastian McKenzie <sebmck@fb.com> Co-authored-by: John Knox <jknox@fb.com> Co-authored-by: Emil Sjölander <emilsj@fb.com> Co-authored-by: Pritesh Nandgaonkar <prit91@fb.com>
This commit is contained in:
52
iOS/SonarKit/SonarClient.h
Normal file
52
iOS/SonarKit/SonarClient.h
Normal file
@@ -0,0 +1,52 @@
|
||||
/*
|
||||
* 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"
|
||||
|
||||
/**
|
||||
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;
|
||||
|
||||
// initializers are disabled. You must use `+[SonarClient sharedClient]` instance.
|
||||
- (instancetype)init NS_UNAVAILABLE;
|
||||
+ (instancetype)new NS_UNAVAILABLE;
|
||||
|
||||
@end
|
||||
Reference in New Issue
Block a user