Package apple.foundation.protocol

Interface NSURLSessionWebSocketDelegate

All Superinterfaces:

NSURLSessionDelegate, NSURLSessionTaskDelegate

public interface NSURLSessionWebSocketDelegate
extends NSURLSessionTaskDelegate

API-Since: 13.0

Nested Class Summary

Nested classes/interfaces inherited from interface apple.foundation.protocol.NSURLSessionDelegate

NSURLSessionDelegate.Block_URLSessionDidReceiveChallengeCompletionHandler

Nested classes/interfaces inherited from interface apple.foundation.protocol.NSURLSessionTaskDelegate

NSURLSessionTaskDelegate.Block_URLSessionTaskDidReceiveChallengeCompletionHandler, NSURLSessionTaskDelegate.Block_URLSessionTaskNeedNewBodyStream, NSURLSessionTaskDelegate.Block_URLSessionTaskNeedNewBodyStreamFromOffsetCompletionHandler, NSURLSessionTaskDelegate.Block_URLSessionTaskWillBeginDelayedRequestCompletionHandler, NSURLSessionTaskDelegate.Block_URLSessionTaskWillPerformHTTPRedirectionNewRequestCompletionHandler

Method Summary

Modifier and Type	Method	Description
default void	URLSessionWebSocketTaskDidCloseWithCodeReason(@NotNull NSURLSession session, @NotNull NSURLSessionWebSocketTask webSocketTask, long closeCode, @Nullable NSData reason)	Indicates that the WebSocket has received a close frame from the server endpoint.
default void	URLSessionWebSocketTaskDidOpenWithProtocol(@NotNull NSURLSession session, @NotNull NSURLSessionWebSocketTask webSocketTask, @Nullable java.lang.String protocol)	Indicates that the WebSocket handshake was successful and the connection has been upgraded to webSockets.

Methods inherited from interface apple.foundation.protocol.NSURLSessionDelegate

URLSessionDidBecomeInvalidWithError, URLSessionDidFinishEventsForBackgroundURLSession, URLSessionDidReceiveChallengeCompletionHandler

Methods inherited from interface apple.foundation.protocol.NSURLSessionTaskDelegate

URLSessionDidCreateTask, URLSessionTaskDidCompleteWithError, URLSessionTaskDidFinishCollectingMetrics, URLSessionTaskDidReceiveChallengeCompletionHandler, URLSessionTaskDidReceiveInformationalResponse, URLSessionTaskDidSendBodyDataTotalBytesSentTotalBytesExpectedToSend, URLSessionTaskIsWaitingForConnectivity, URLSessionTaskNeedNewBodyStream, URLSessionTaskNeedNewBodyStreamFromOffsetCompletionHandler, URLSessionTaskWillBeginDelayedRequestCompletionHandler, URLSessionTaskWillPerformHTTPRedirectionNewRequestCompletionHandler

Method Detail

URLSessionWebSocketTaskDidCloseWithCodeReason

default void URLSessionWebSocketTaskDidCloseWithCodeReason(@NotNull
                                                           @NotNull NSURLSession session,
                                                           @NotNull
                                                           @NotNull NSURLSessionWebSocketTask webSocketTask,
                                                           long closeCode,
                                                           @Nullable
                                                           @Nullable NSData reason)

Indicates that the WebSocket has received a close frame from the server endpoint. The close code and the close reason may be provided by the delegate if the server elects to send this information in the close frame

URLSessionWebSocketTaskDidOpenWithProtocol

default void URLSessionWebSocketTaskDidOpenWithProtocol(@NotNull
                                                        @NotNull NSURLSession session,
                                                        @NotNull
                                                        @NotNull NSURLSessionWebSocketTask webSocketTask,
                                                        @Nullable
                                                        @Nullable java.lang.String protocol)

Indicates that the WebSocket handshake was successful and the connection has been upgraded to webSockets. It will also provide the protocol that is picked in the handshake. If the handshake fails, this delegate will not be invoked.