ktor-client-darwin/io.ktor.client.engine.darwin/KtorNSURLSessionDelegate

KtorNSURLSessionDelegate

class KtorNSURLSessionDelegate(challengeHandler: ChallengeHandler?) : NSObject, NSURLSessionDataDelegateProtocol, NSURLSessionWebSocketDelegateProtocol

A delegate for NSURLSession that bridges it to Ktor. If users set custom session in DarwinClientEngineConfig.sessionAndDelegate, they need to register this delegate in their session. This can be done by registering it directly, extending their custom delegate from it or by calling required methods from their custom delegate.

For HTTP requests to work property, it's important that users call these functions:

URLSession:dataTask:didReceiveData:
URLSession:task:didCompleteWithError:
URLSession:task:willPerformHTTPRedirection:newRequest:completionHandler:

For WebSockets to work, it's important that users call these functions:

URLSession:webSocketTask:didOpenWithProtocol:
URLSession:webSocketTask:didCloseWithCode:reason:

Constructors

KtorNSURLSessionDelegate

constructor(challengeHandler: ChallengeHandler?)

Properties

debugDescription

expect val debugDescription: String?

description

expect val description: String?

hash

expect val hash: NSUInteger

superclass

expect val superclass: ObjCClass?

Functions

class

expect open override fun class(): ObjCClass?

conformsToProtocol

expect open override fun conformsToProtocol(aProtocol: Protocol?): Boolean

copy

expect open fun copy(): Any?

debugDescription

expect open fun debugDescription(): String?

description

expect open override fun description(): String?

doesNotRecognizeSelector

expect open fun doesNotRecognizeSelector(aSelector: COpaquePointer?)

finalize

expect open fun finalize()

forwardingTargetForSelector

expect open fun forwardingTargetForSelector(aSelector: COpaquePointer?): Any?

forwardInvocation

expect open fun forwardInvocation(anInvocation: NSInvocation?)

hash

expect open override fun hash(): NSUInteger

init

expect open fun ~~init~~(): NSObject?

isEqual

expect open override fun isEqual(object: Any?): Boolean

isKindOfClass

expect open override fun isKindOfClass(aClass: ObjCClass?): Boolean

isMemberOfClass

expect open override fun isMemberOfClass(aClass: ObjCClass?): Boolean

isProxy

expect open override fun isProxy(): Boolean

methodForSelector

expect open fun methodForSelector(aSelector: COpaquePointer?): IMP?

methodSignatureForSelector

expect open fun methodSignatureForSelector(aSelector: COpaquePointer?): NSMethodSignature?

mutableCopy

expect open fun mutableCopy(): Any?

performSelector

expect open override fun performSelector(aSelector: COpaquePointer?): Any?

expect open override fun performSelector(aSelector: COpaquePointer?, withObject: Any?): Any?

expect open override fun performSelector(aSelector: COpaquePointer?, withObject: Any?, _withObject: Any?): Any?

respondsToSelector

expect open override fun respondsToSelector(aSelector: COpaquePointer?): Boolean

superclass

expect open override fun superclass(): ObjCClass?

URLSession

open override fun URLSession(session: NSURLSession, taskIsWaitingForConnectivity: NSURLSessionTask)

open override fun URLSession(session: NSURLSession, dataTask: NSURLSessionDataTask, didReceiveData: NSData)

open override fun URLSession(session: NSURLSession, task: NSURLSessionTask, didCompleteWithError: NSError?)

open override fun URLSession(session: NSURLSession, webSocketTask: NSURLSessionWebSocketTask, didOpenWithProtocol: String?)

open override fun URLSession(session: NSURLSession, webSocketTask: NSURLSessionWebSocketTask, didCloseWithCode: NSURLSessionWebSocketCloseCode, reason: NSData?)

expect open fun URLSession(session: NSURLSession, dataTask: NSURLSessionDataTask, didBecomeDownloadTask: NSURLSessionDownloadTask)

expect open fun URLSession(session: NSURLSession, dataTask: NSURLSessionDataTask, didBecomeStreamTask: NSURLSessionStreamTask)

expect open fun URLSession(session: NSURLSession, dataTask: NSURLSessionDataTask, willCacheResponse: NSCachedURLResponse, completionHandler: (NSCachedURLResponse?) -> Unit)

expect open fun URLSession(session: NSURLSession, dataTask: NSURLSessionDataTask, didReceiveResponse: NSURLResponse, completionHandler: (NSURLSessionResponseDisposition) -> Unit)

expect open fun URLSession(session: NSURLSession, didBecomeInvalidWithError: NSError?)

expect open fun URLSession(session: NSURLSession, didReceiveChallenge: NSURLAuthenticationChallenge, completionHandler: (NSURLSessionAuthChallengeDisposition, NSURLCredential?) -> Unit)

expect open fun URLSession(session: NSURLSession, task: NSURLSessionTask, needNewBodyStream: (NSInputStream?) -> Unit)

expect open fun URLSession(session: NSURLSession, task: NSURLSessionTask, didReceiveInformationalResponse: NSHTTPURLResponse)

expect open fun URLSession(session: NSURLSession, task: NSURLSessionTask, didFinishCollectingMetrics: NSURLSessionTaskMetrics)

expect open fun URLSession(session: NSURLSession, task: NSURLSessionTask, needNewBodyStreamFromOffset: int64_t, completionHandler: (NSInputStream?) -> Unit)

expect open fun URLSession(session: NSURLSession, task: NSURLSessionTask, willBeginDelayedRequest: NSURLRequest, completionHandler: (NSURLSessionDelayedRequestDisposition, NSURLRequest?) -> Unit)

expect open fun URLSession(session: NSURLSession, task: NSURLSessionTask, didSendBodyData: int64_t, totalBytesSent: int64_t, totalBytesExpectedToSend: int64_t)

open override fun URLSession(session: NSURLSession, task: NSURLSessionTask, didReceiveChallenge: NSURLAuthenticationChallenge, completionHandler: (NSURLSessionAuthChallengeDisposition, NSURLCredential?) -> Unit)

Handle challenge.

open override fun URLSession(session: NSURLSession, task: NSURLSessionTask, willPerformHTTPRedirection: NSHTTPURLResponse, newRequest: NSURLRequest, completionHandler: (NSURLRequest?) -> Unit)

Disable embedded redirects.

URLSessionDidFinishEventsForBackgroundURLSession

expect open fun URLSessionDidFinishEventsForBackgroundURLSession(session: NSURLSession)