Skip to content

Commit 484e9d7

Browse files
authored
Merge pull request #2 from Local-Connectivity-Lab/zhennan_fix_doc
fix configuration access level
2 parents 981c915 + d12fa43 commit 484e9d7

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

Sources/LCLWebSocket/WebSocketConfiguration.swift

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32,29 +32,29 @@ extension LCLWebSocket {
3232
///
3333
/// Set this to enable WSS (WebSocket Secure) connections.
3434
/// - Note: Required for `wss://` URLs. By default, this is `nil`.
35-
let tlsConfiguration: TLSConfiguration?
35+
public var tlsConfiguration: TLSConfiguration?
3636

3737
/// Maximum size of a single WebSocket frame in bytes. Default is 1 << 14 (16KB).
3838
///
3939
/// - Important: Frames larger than this will be rejected
40-
var maxFrameSize: Int
40+
public var maxFrameSize: Int
4141

4242
/// Minimum size required for non-final fragments. Default is 0 (no minimum).
43-
var minNonFinalFragmentSize: Int
43+
public var minNonFinalFragmentSize: Int
4444

4545
/// Maximum number of frames that can be accumulated. Default is Int.max.
4646
///
4747
/// Limits memory usage when receiving fragmented messages.
48-
var maxAccumulatedFrameCount: Int
48+
public var maxAccumulatedFrameCount: Int
4949

5050
/// Maximum total size of accumulated frames in bytes. Default is Int.max.
51-
var maxAccumulatedFrameSize: Int
51+
public var maxAccumulatedFrameSize: Int
5252

5353
/// Low water mark for write buffer in bytes.
5454
///
5555
/// When buffer size drops below this, writes resume.
5656
/// - Note: Must be >= 1 and <= writeBufferWaterMarkHigh
57-
var writeBufferWaterMarkLow: Int {
57+
public var writeBufferWaterMarkLow: Int {
5858
willSet {
5959
precondition(
6060
newValue >= 1 && newValue <= writeBufferWaterMarkHigh,
@@ -67,7 +67,7 @@ extension LCLWebSocket {
6767
///
6868
/// When buffer exceeds this, writes pause.
6969
/// - Note: Must be >= writeBufferWaterMarkLow
70-
var writeBufferWaterMarkHigh: Int {
70+
public var writeBufferWaterMarkHigh: Int {
7171
willSet {
7272
precondition(
7373
newValue >= writeBufferWaterMarkLow,
@@ -77,39 +77,39 @@ extension LCLWebSocket {
7777
}
7878

7979
/// Maximum time to wait for connection establishment.
80-
var connectionTimeout: TimeAmount
80+
public var connectionTimeout: TimeAmount
8181

8282
/// The network device name on the system to route the traffic to.
8383
///
8484
/// If the device associated with the given `deviceName` is not found, then the WebSocket will
8585
/// be bound to the default interface according to the operating system's choice.
8686
///
8787
/// - Note: You might need root privileges to use this feature.
88-
var deviceName: String?
88+
public var deviceName: String?
8989

9090
/// Auto-ping configuration to keep the WebSocket connection alive. Default is enabled.
9191
/// - seealso: `AutoPingConfiguration`
92-
var autoPingConfiguration: AutoPingConfiguration
92+
public var autoPingConfiguration: AutoPingConfiguration
9393

9494
/// Socket send buffer size in bytes.
9595
///
9696
/// This option will not be applied if `NIOTSEventLoopGroup` is used.
97-
var socketSendBufferSize: SocketOptionValue
97+
public var socketSendBufferSize: SocketOptionValue
9898

9999
/// Socket receive buffer size in bytes.
100100
///
101101
/// This option will not be applied if `NIOTSEventLoopGroup` is used.
102-
var socketReceiveBufferSize: SocketOptionValue
102+
public var socketReceiveBufferSize: SocketOptionValue
103103

104104
/// Indicate that the underlying socket should reuse address or not.
105105
///
106106
/// - Note: see more in `man socket(7)`.
107-
var socketReuseAddress: Bool
107+
public var socketReuseAddress: Bool
108108

109109
/// Indicate that the socket should send the segments as soon as possible. If set, the Nagle algorithm is disabled.
110110
///
111111
/// - Note: see more in `man socket(7)`
112-
var socketTcpNoDelay: Bool
112+
public var socketTcpNoDelay: Bool
113113

114114
/// Strategy for handling leftover bytes after upgrade.
115115
///

0 commit comments

Comments
 (0)