diff --git a/docs/source/api/ApolloWebSocket/README.md b/docs/source/api/ApolloWebSocket/README.md index d023035d47..8a5de082de 100644 --- a/docs/source/api/ApolloWebSocket/README.md +++ b/docs/source/api/ApolloWebSocket/README.md @@ -1,6 +1,7 @@ ## Protocols - [ApolloWebSocketClient](protocols/ApolloWebSocketClient/) +- [SOCKSProxyable](protocols/SOCKSProxyable/) - [WebSocketTransportDelegate](protocols/WebSocketTransportDelegate/) ## Structs diff --git a/docs/source/api/ApolloWebSocket/classes/ApolloWebSocket.md b/docs/source/api/ApolloWebSocket/classes/ApolloWebSocket.md index b79b2c63cb..82e8a0d98b 100644 --- a/docs/source/api/ApolloWebSocket/classes/ApolloWebSocket.md +++ b/docs/source/api/ApolloWebSocket/classes/ApolloWebSocket.md @@ -3,11 +3,18 @@ # `ApolloWebSocket` ```swift -public class ApolloWebSocket: WebSocket, ApolloWebSocketClient +public class ApolloWebSocket: WebSocket, ApolloWebSocketClient, SOCKSProxyable ``` > Included implementation of an `ApolloWebSocketClient`, based on `Starscream`'s `WebSocket`. +## Properties +### `enableSOCKSProxy` + +```swift +public var enableSOCKSProxy: Bool +``` + ## Methods ### `init(request:protocols:)` diff --git a/docs/source/api/ApolloWebSocket/classes/WebSocketTransport.md b/docs/source/api/ApolloWebSocket/classes/WebSocketTransport.md index 95f42e0b35..4098d2073f 100644 --- a/docs/source/api/ApolloWebSocket/classes/WebSocketTransport.md +++ b/docs/source/api/ApolloWebSocket/classes/WebSocketTransport.md @@ -31,6 +31,16 @@ public var clientVersion: String > NOTE: Setting this won't override immediately if the socket is still connected, only on reconnection. +### `enableSOCKSProxy` + +```swift +public var enableSOCKSProxy: Bool +``` + +> Determines whether a SOCKS proxy is enabled on the underlying request. +> Mostly useful for debugging with tools like Charles Proxy. +> Note: Will return `false` from the getter and no-op the setter for implementations that do not conform to `SOCKSProxyable`. + ## Methods ### `init(request:clientName:clientVersion:sendOperationIdentifiers:reconnect:reconnectionInterval:allowSendingDuplicates:connectingPayload:requestCreator:)` diff --git a/docs/source/api/ApolloWebSocket/protocols/SOCKSProxyable.md b/docs/source/api/ApolloWebSocket/protocols/SOCKSProxyable.md new file mode 100644 index 0000000000..9bc32c79b9 --- /dev/null +++ b/docs/source/api/ApolloWebSocket/protocols/SOCKSProxyable.md @@ -0,0 +1,17 @@ +**PROTOCOL** + +# `SOCKSProxyable` + +```swift +public protocol SOCKSProxyable +``` + +## Properties +### `enableSOCKSProxy` + +```swift +var enableSOCKSProxy: Bool +``` + +> Determines whether a SOCKS proxy is enabled on the underlying request. +> Mostly useful for debugging with tools like Charles Proxy.