Platforms to show: All Mac Windows Linux Cross-Platform
NSURLSessionWebSocketTaskMBS class
Super class: NSURLSessionTaskMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| class | Cocoa Networking | MBS MacFrameworks Plugin | 20.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
A client can also provide a list of protocols it wishes to advertise during the WebSocket handshake phase.
Once the handshake is successfully completed the client will be notified through an optional delegate.
All reads and writes enqueued before the completion of the handshake will be queued up and executed once the hanshake succeeds. Before the handshake completes, the client can be called to handle redirection or authentication using the same delegates as NSURLSessionTask. WebSocket task will also provide support for cookies and will store cookies to the cookie storage on the session and will attach cookies to outgoing HTTP handshake requests.
Available on MacOS 10.15 or newer.
Subclass of the NSURLSessionTaskMBS class.
This is an abstract class. You can't create an instance, but you can get one from various plugin functions.
- 3 properties
- property closeCode as Integer
- property closeReason as MemoryBlock
- property maximumMessageSize as Integer
- 5 methods
- method cancel(closeCode as Integer, reason as MemoryBlock)
- method Constructor Private
- method receiveMessage(Handler as NSURLSessionWebSocketTaskReceiveMessageCompletedMBS, tag as variant = nil)
- method sendMessage(message as NSURLSessionWebSocketMessageMBS, Handler as NSURLSessionWebSocketTaskSendMessageCompletedMBS, tag as variant = nil)
- method sendPing(Handler as NSURLSessionWebSocketTaskSendPingWithPongReceivedMBS, tag as variant = nil)
- 3 delegates
- delegate NSURLSessionWebSocketTaskReceiveMessageCompletedMBS(webSocketTask as NSURLSessionWebSocketTaskMBS, message as NSURLSessionWebSocketMessageMBS, error as NSErrorMBS, tag as variant)
- delegate NSURLSessionWebSocketTaskSendMessageCompletedMBS(webSocketTask as NSURLSessionWebSocketTaskMBS, error as NSErrorMBS, tag as variant)
- delegate NSURLSessionWebSocketTaskSendPingWithPongReceivedMBS(webSocketTask as NSURLSessionWebSocketTaskMBS, error as NSErrorMBS, tag as variant)
- 13 constants
Close Codes
| Constant | Value | Description |
|---|---|---|
| CloseCodeAbnormalClosure | 1006 |
Abnormal Closure |
| CloseCodeGoingAway | 1001 |
Going Away |
| CloseCodeInternalServerError | 1011 |
Internal Server Error |
| CloseCodeInvalid | 0 |
Invalid |
| CloseCodeInvalidFramePayloadData | 1007 |
Invalid Frame Payload Data |
| CloseCodeMandatoryExtensionMissing | 1010 |
Mandatory Extension Missing |
| CloseCodeMessageTooBig | 1009 |
Message Too Big |
| CloseCodeNormalClosure | 1000 |
Normal Closure |
| CloseCodeNoStatusReceived | 1005 |
No Status Received |
| CloseCodePolicyViolation | 1008 |
Policy Violation |
| CloseCodeProtocolError | 1002 |
Protocol Error |
| CloseCodeTLSHandshakeFailure | 1015 |
TLS Handshake Failure |
| CloseCodeUnsupportedData | 1003 |
Unsupported Data |
Super class NSURLSessionTaskMBS
- 17 properties
- property countOfBytesClientExpectsToReceive as Int64
- property countOfBytesClientExpectsToSend as Int64
- property countOfBytesExpectedToReceive as Int64
- property countOfBytesExpectedToSend as Int64
- property countOfBytesReceived as Int64
- property countOfBytesSent as Int64
- property currentRequest as NSURLRequestMBS
- property earliestBeginDate as Date
- property earliestBeginDateTime as DateTime
- property error as NSErrorMBS
- property Handle as Integer
- property originalRequest as NSURLRequestMBS
- property Priority as Single
- property response as NSURLResponseMBS
- property state as Integer
- property taskDescription as String
- property taskIdentifier as UInt64
- 5 methods
- method Cancel
- method Constructor Private
- method copy as NSURLSessionTaskMBS
- method resume
- method suspend
- 4 shared methods
- shared method available as Boolean
- shared method PriorityDefault as Single
- shared method PriorityHigh as Single
- shared method PriorityLow as Single
- 4 constants
States
| Constant | Value | Description |
|---|---|---|
| StateCanceling | 2 |
The task has received a cancel message. The delegate may or may not have received a taskDidCompleteWithError message yet. A task in this state is not subject to timeouts. |
| StateCompleted | 3 | The task has completed (without being canceled), and the task's delegate receives no further callbacks. more |
| StateRunning | 0 |
The task is currently being serviced by the session. A task in this state is subject to the request and resource timeouts specified in the session configuration object. |
| StateSuspended | 1 |
The task was suspended by the app. No further processing takes place until the task is resumed. A task in this state is not subject to timeouts. |
This class has no sub classes.
Some methods using this class:
- NSURLSessionMBS.webSocketTaskWithRequest(request as NSURLRequestMBS) as NSURLSessionWebSocketTaskMBS
- NSURLSessionMBS.webSocketTaskWithURL(URL as String) as NSURLSessionWebSocketTaskMBS
- NSURLSessionMBS.webSocketTaskWithURL(URL as String, Protocols() as String) as NSURLSessionWebSocketTaskMBS
Some events using this class:
- NSURLSessionMBS.webSocketTaskDidCloseWithCode(webSocketTask as NSURLSessionWebSocketTaskMBS, closeCode as Integer, reason as MemoryBlock)
- NSURLSessionMBS.webSocketTaskDidOpenWithProtocol(webSocketTask as NSURLSessionWebSocketTaskMBS, protocol as String)
Blog Entries
The items on this page are in the following plugins: MBS MacFrameworks Plugin.
NSURLSessionWebSocketMessageMBS - NSUserAppleScriptTaskMBS
