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
Function: A WebSocket task can be created with a ws or wss url.
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.

Feedback, Comments & Corrections

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


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.
If the task completed successfully, the task’s error property is nil. Otherwise, it provides an error object that tells what went wrong. A task in this state is not subject to timeouts.
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:

Some events using this class:

Blog Entries

The items on this page are in the following plugins: MBS MacFrameworks Plugin.

NSURLSessionWebSocketMessageMBS   -   NSUserAppleScriptTaskMBS

The biggest plugin in space...

MBS Xojo Plugins

Start Chat