xref: /aosp_15_r20/external/webrtc/sdk/objc/api/peerconnection/RTCIceCandidateErrorEvent.h (revision d9f758449e529ab9291ac668be2861e7a55c2422)
1 /*
2  *  Copyright (c) 2021 The WebRTC project authors. All Rights Reserved.
3  *
4  *  Use of this source code is governed by a BSD-style license
5  *  that can be found in the LICENSE file in the root of the source
6  *  tree. An additional intellectual property rights grant can be found
7  *  in the file PATENTS.  All contributing project authors may
8  *  be found in the AUTHORS file in the root of the source tree.
9  */
10 
11 #import <Foundation/Foundation.h>
12 
13 #import "RTCMacros.h"
14 
15 NS_ASSUME_NONNULL_BEGIN
16 
17 RTC_OBJC_EXPORT
18 @interface RTC_OBJC_TYPE (RTCIceCandidateErrorEvent) : NSObject
19 
20 /** The local IP address used to communicate with the STUN or TURN server. */
21 @property(nonatomic, readonly) NSString *address;
22 
23 /** The port used to communicate with the STUN or TURN server. */
24 @property(nonatomic, readonly) int port;
25 
26 /** The STUN or TURN URL that identifies the STUN or TURN server for which the failure occurred. */
27 @property(nonatomic, readonly) NSString *url;
28 
29 /** The numeric STUN error code returned by the STUN or TURN server. If no host candidate can reach
30  * the server, errorCode will be set to the value 701 which is outside the STUN error code range.
31  * This error is only fired once per server URL while in the RTCIceGatheringState of "gathering". */
32 @property(nonatomic, readonly) int errorCode;
33 
34 /** The STUN reason text returned by the STUN or TURN server. If the server could not be reached,
35  * errorText will be set to an implementation-specific value providing details about the error. */
36 @property(nonatomic, readonly) NSString *errorText;
37 
38 - (instancetype)init NS_DESIGNATED_INITIALIZER;
39 
40 @end
41 
42 NS_ASSUME_NONNULL_END
43