mirror of
https://github.com/mollyim/webrtc.git
synced 2025-05-13 05:40:42 +01:00
e8d5724cc5
A new version of RTC_EXPORT will be introduced by [1] and it will be used by WebRTC native code. This CL renames the current RTC_EXPORT to RTC_OBJC_EXPORT in order to avoid to mix them. It has been decided to avoid to unify them because RTC_OBJC_EXPORT always marks symbols with default visibility, while RTC_EXPORT will do it only when COMPONENT_BUILD is defined. [1] - https://webrtc-review.googlesource.com/c/src/+/97960 is Bug: webrtc:9419 Change-Id: I56a3fc6601c72d3ad6a58f9961a00e3761dfb5da Reviewed-on: https://webrtc-review.googlesource.com/100521 Reviewed-by: Karl Wiberg <kwiberg@webrtc.org> Reviewed-by: Anders Carlsson <andersc@webrtc.org> Commit-Queue: Mirko Bonadei <mbonadei@webrtc.org> Cr-Commit-Position: refs/heads/master@{#24754}
130 lines
3.8 KiB
Objective-C
130 lines
3.8 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 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 RTCDataChannel;
|
|
RTC_OBJC_EXPORT
|
|
@protocol RTCDataChannelDelegate <NSObject>
|
|
|
|
/** The data channel state changed. */
|
|
- (void)dataChannelDidChangeState:(RTCDataChannel *)dataChannel;
|
|
|
|
/** The data channel successfully received a data buffer. */
|
|
- (void)dataChannel:(RTCDataChannel *)dataChannel
|
|
didReceiveMessageWithBuffer:(RTCDataBuffer *)buffer;
|
|
|
|
@optional
|
|
/** The data channel's |bufferedAmount| changed. */
|
|
- (void)dataChannel:(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 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<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:(RTCDataBuffer *)data;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|