mirror of
https://github.com/mollyim/webrtc.git
synced 2025-05-13 22:00:47 +01:00
a81e9c82fc
This CL introduced 2 new macros that affect the WebRTC OBJC API symbols: - RTC_OBJC_TYPE_PREFIX: Macro used to prepend a prefix to the API types that are exported with RTC_OBJC_EXPORT. Clients can patch the definition of this macro locally and build WebRTC.framework with their own prefix in case symbol clashing is a problem. This macro must only be defined by changing the value in sdk/objc/base/RTCMacros.h and not on via compiler flag to ensure it has a unique value. - RCT_OBJC_TYPE: Macro used internally to reference API types. Declaring an API type without using this macro will not include the declared type in the set of types that will be affected by the configurable RTC_OBJC_TYPE_PREFIX. Manual changes: https://webrtc-review.googlesource.com/c/src/+/173781/5..10 The auto-generated changes in PS#5 have been done with: https://webrtc-review.googlesource.com/c/src/+/174061. Bug: None Change-Id: I0d54ca94db764fb3b6cb4365873f79e14cd879b8 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/173781 Commit-Queue: Mirko Bonadei <mbonadei@webrtc.org> Reviewed-by: Karl Wiberg <kwiberg@webrtc.org> Reviewed-by: Kári Helgason <kthelgason@webrtc.org> Cr-Commit-Position: refs/heads/master@{#31153}
132 lines
3.9 KiB
Objective-C
132 lines
3.9 KiB
Objective-C
/*
|
|
* Copyright 2015 The WebRTC project authors. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by a BSD-style license
|
|
* that can be found in the LICENSE file in the root of the source
|
|
* tree. An additional intellectual property rights grant can be found
|
|
* in the file PATENTS. All contributing project authors may
|
|
* be found in the AUTHORS file in the root of the source tree.
|
|
*/
|
|
|
|
#import <AvailabilityMacros.h>
|
|
#import <Foundation/Foundation.h>
|
|
|
|
#import "RTCMacros.h"
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
RTC_OBJC_EXPORT
|
|
@interface RTC_OBJC_TYPE (RTCDataBuffer) : NSObject
|
|
|
|
/** NSData representation of the underlying buffer. */
|
|
@property(nonatomic, readonly) NSData *data;
|
|
|
|
/** Indicates whether |data| contains UTF-8 or binary data. */
|
|
@property(nonatomic, readonly) BOOL isBinary;
|
|
|
|
- (instancetype)init NS_UNAVAILABLE;
|
|
|
|
/**
|
|
* Initialize an RTCDataBuffer from NSData. |isBinary| indicates whether |data|
|
|
* contains UTF-8 or binary data.
|
|
*/
|
|
- (instancetype)initWithData:(NSData *)data isBinary:(BOOL)isBinary;
|
|
|
|
@end
|
|
|
|
@class RTC_OBJC_TYPE(RTCDataChannel);
|
|
RTC_OBJC_EXPORT
|
|
@protocol RTC_OBJC_TYPE
|
|
(RTCDataChannelDelegate)<NSObject>
|
|
|
|
/** The data channel state changed. */
|
|
- (void)dataChannelDidChangeState : (RTC_OBJC_TYPE(RTCDataChannel) *)dataChannel;
|
|
|
|
/** The data channel successfully received a data buffer. */
|
|
- (void)dataChannel:(RTC_OBJC_TYPE(RTCDataChannel) *)dataChannel
|
|
didReceiveMessageWithBuffer:(RTC_OBJC_TYPE(RTCDataBuffer) *)buffer;
|
|
|
|
@optional
|
|
/** The data channel's |bufferedAmount| changed. */
|
|
- (void)dataChannel:(RTC_OBJC_TYPE(RTCDataChannel) *)dataChannel
|
|
didChangeBufferedAmount:(uint64_t)amount;
|
|
|
|
@end
|
|
|
|
/** Represents the state of the data channel. */
|
|
typedef NS_ENUM(NSInteger, RTCDataChannelState) {
|
|
RTCDataChannelStateConnecting,
|
|
RTCDataChannelStateOpen,
|
|
RTCDataChannelStateClosing,
|
|
RTCDataChannelStateClosed,
|
|
};
|
|
|
|
RTC_OBJC_EXPORT
|
|
@interface RTC_OBJC_TYPE (RTCDataChannel) : NSObject
|
|
|
|
/**
|
|
* A label that can be used to distinguish this data channel from other data
|
|
* channel objects.
|
|
*/
|
|
@property(nonatomic, readonly) NSString *label;
|
|
|
|
/** Whether the data channel can send messages in unreliable mode. */
|
|
@property(nonatomic, readonly) BOOL isReliable DEPRECATED_ATTRIBUTE;
|
|
|
|
/** Returns whether this data channel is ordered or not. */
|
|
@property(nonatomic, readonly) BOOL isOrdered;
|
|
|
|
/** Deprecated. Use maxPacketLifeTime. */
|
|
@property(nonatomic, readonly) NSUInteger maxRetransmitTime DEPRECATED_ATTRIBUTE;
|
|
|
|
/**
|
|
* The length of the time window (in milliseconds) during which transmissions
|
|
* and retransmissions may occur in unreliable mode.
|
|
*/
|
|
@property(nonatomic, readonly) uint16_t maxPacketLifeTime;
|
|
|
|
/**
|
|
* The maximum number of retransmissions that are attempted in unreliable mode.
|
|
*/
|
|
@property(nonatomic, readonly) uint16_t maxRetransmits;
|
|
|
|
/**
|
|
* The name of the sub-protocol used with this data channel, if any. Otherwise
|
|
* this returns an empty string.
|
|
*/
|
|
@property(nonatomic, readonly) NSString *protocol;
|
|
|
|
/**
|
|
* Returns whether this data channel was negotiated by the application or not.
|
|
*/
|
|
@property(nonatomic, readonly) BOOL isNegotiated;
|
|
|
|
/** Deprecated. Use channelId. */
|
|
@property(nonatomic, readonly) NSInteger streamId DEPRECATED_ATTRIBUTE;
|
|
|
|
/** The identifier for this data channel. */
|
|
@property(nonatomic, readonly) int channelId;
|
|
|
|
/** The state of the data channel. */
|
|
@property(nonatomic, readonly) RTCDataChannelState readyState;
|
|
|
|
/**
|
|
* The number of bytes of application data that have been queued using
|
|
* |sendData:| but that have not yet been transmitted to the network.
|
|
*/
|
|
@property(nonatomic, readonly) uint64_t bufferedAmount;
|
|
|
|
/** The delegate for this data channel. */
|
|
@property(nonatomic, weak) id<RTC_OBJC_TYPE(RTCDataChannelDelegate)> delegate;
|
|
|
|
- (instancetype)init NS_UNAVAILABLE;
|
|
|
|
/** Closes the data channel. */
|
|
- (void)close;
|
|
|
|
/** Attempt to send |data| on this data channel's underlying data transport. */
|
|
- (BOOL)sendData:(RTC_OBJC_TYPE(RTCDataBuffer) *)data;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|