Instance Method

cancelWithCloseCode:reason:

Sends a close frame with the given close code and optional close reason.

Declaration

- (void)cancelWithCloseCode:(NSURLSessionWebSocketCloseCode)closeCode reason:(NSData *)reason;

Parameters

closeCode

A NSURLSessionWebSocketCloseCode that indicates the reason for closing the connection.

reason

Optional further information to explain the closing. The value of this parameter is defined by the endpoints, not by the standard.

Discussion

If you call cancel on the task instead of this method, it sends a cancellation frame with no close code or reason.

See Also

Closing the Connection

closeCode

A code that indicates the reason a connection closed.

NSURLSessionWebSocketCloseCode

A code that indicates why a WebSocket connection closed.

closeReason

A block of data that provides further information about why a connection closed.