SKWPeer.h

Go to the documentation of this file.

// SKWPeer.h
// SkyWay SDK
#import "SKWHeaders.h"
 
#ifndef DOXYGEN_SKIP_THIS
extern NSString* __nonnull const kSKWTrue;
extern NSString* __nonnull const kSKWFalse;
 
extern NSString* __nonnull const kSKWConnectionTypeData;
extern NSString* __nonnull const kSKWConnectionTypeMedia;
 
extern NSString* __nonnull const kSKWPeerSerializationBinary;
extern NSString* __nonnull const kSKWPeerSerializationBinaryUtf8;
extern NSString* __nonnull const kSKWPeerSerializationJson;
extern NSString* __nonnull const kSKWPeerSerializationNone;
#endif // !DOXYGEN_SKIP_THIS
 
typedef NS_ENUM(NSUInteger, SKWPeerEventEnum)
{
    SKW_PEER_EVENT_OPEN,
    SKW_PEER_EVENT_CONNECTION,
    SKW_PEER_EVENT_CALL,
    SKW_PEER_EVENT_CLOSE,
    
    SKW_PEER_EVENT_DISCONNECTED __attribute__((deprecated("this event is not fired"))),
    SKW_PEER_EVENT_ERROR,
#ifndef DOXYGEN_SKIP_THIS
    SKW_PEER_EVENT_REACHABILITY,
#endif // !DOXYGEN_SKIP_THIS
    SKW_PEER_EVENT_AUTH_EXPIRES_IN,
};
 
typedef void (^SKWPeerEventCallback)(NSObject* __nullable arg);
 
@class SKWPeerOption;
@class SKWConnection;
@class SKWPeerCredential;
@class SKWDataConnection;
@class SKWMediaConnection;
@class SKWMediaStream;
@class SKWConnectOption;
@class SKWCallOption;
@class SKWRoom;
@class SKWRoomOption;
 
@interface SKWPeer : NSObject
 
@property (nonatomic, readonly) NSString* __nullable identity;
 
@property (nonatomic, readonly) NSDictionary* __nullable connections;
 
@property (nonatomic, readonly) BOOL isDisconnected;
 
@property (nonatomic, readonly) BOOL isDestroyed;
 
+ (nonnull NSString*)sdkVersion;
 
#ifndef DOXYGEN_SKIP_THIS
- (nonnull instancetype)init NS_UNAVAILABLE;
#endif // !DOXYGEN_SKIP_THIS
 
- (instancetype __nullable)initWithOptions:(SKWPeerOption* __nullable)options;
 
- (instancetype __nullable)initWithId:(NSString* __nullable)peerId options:(SKWPeerOption* __nullable)options NS_DESIGNATED_INITIALIZER;
 
- (SKWDataConnection* __nullable)connectWithId:(NSString* __nonnull)peerId;
 
- (SKWDataConnection* __nullable)connectWithId:(NSString* __nonnull)peerId options:(SKWConnectOption* __nullable)options;
 
- (SKWMediaConnection* __nullable)callWithId:(NSString* __nonnull)peerId stream:(SKWMediaStream* __nullable)stream;
 
- (SKWMediaConnection* __nullable)callWithId:(NSString* __nonnull)peerId stream:(SKWMediaStream* __nullable)stream options:(SKWCallOption* __nullable)options;
 
- (void)on:(SKWPeerEventEnum)event callback:(SKWPeerEventCallback __nullable)callback;
 
- (BOOL)disconnect __attribute__((deprecated("use destroy method instead")));
 
- (void)reconnect __attribute__((deprecated("recreate a Peer instance instead")));
 
- (BOOL)destroy;
 
- (void)listAllPeers:(void (^ __nullable)(NSArray * __nullable))callback;
 
- (void)fetchPeerExistsWithPeerId:(NSString* __nonnull)peerId success:(void (^ __nonnull)(BOOL))successCallback error:(void (^ __nullable)(NSString* __nonnull))errorCallback;
 
#ifndef DOXYGEN_SKIP_THIS
- (SKWConnection* __nullable)getConnectionWithId:(NSString* __nonnull)peerId connectionId:(NSString* __nonnull)connectionId;
#endif // !DOXYGEN_SKIP_THIS
 
- (SKWRoom* __nullable)joinRoomWithName:(NSString* __nonnull)roomName options:(SKWRoomOption* __nonnull)option;
 
- (void)updateCredential:(SKWPeerCredential* __nonnull)newCredential;
 
@end