FMIceLinkWebSocket Class Reference

Inherits from	FMIceLinkWebSocketBase : NSObject
Conforms to	FMIceLinkIWebSocket
Declared in	FMIceLinkWebSocket.h FMIceLinkWebSocket.m

Overview

Implementation of the WebSocket [protocol](#//api/name/protocol) v8.

`– bufferedAmount`

Gets the number of bytes buffered in the send queue.

- (int)bufferedAmount

Discussion

Gets the number of bytes buffered in the send queue.

Declared In

FMIceLinkWebSocket.h

`– close`

Closes the WebSocket connection.

- (void)close

Discussion

Closes the WebSocket connection.

Declared In

FMIceLinkWebSocket.h

`– closeWithCloseArgs:`

Closes the WebSocket connection.

- (void)closeWithCloseArgs:(FMIceLinkWebSocketCloseArgs *)closeArgs

Parameters

`closeArgs`	The close arguments

Discussion

Closes the WebSocket connection.

Declared In

FMIceLinkWebSocket.h

`+ exists`

Gets a value indicating whether WebSocket support exists on this platform.

+ (bool)exists

Discussion

Gets a value indicating whether WebSocket support exists on this platform.

Declared In

FMIceLinkWebSocket.h

`– initWithRequestUrl:`

Creates a new FMIceLinkWebSocket.

- (instancetype)initWithRequestUrl:(NSString *)requestUrl

Parameters

`requestUrl`	The target URL for the WebSocket connection.

Discussion

Creates a new FMIceLinkWebSocket.

Declared In

FMIceLinkWebSocket.h

`– initWithRequestUrl:protocol:`

Creates a new FMIceLinkWebSocket.

- (instancetype)initWithRequestUrl:(NSString *)requestUrl protocol:(NSString *)protocol

Parameters

`requestUrl`	The target URL for the WebSocket connection.
`protocol`	The WebSocket protocol.

Discussion

Creates a new FMIceLinkWebSocket.

Declared In

FMIceLinkWebSocket.h

`– isOpen`

Gets a value indicating whether the WebSocket is connected.

- (bool)isOpen

Discussion

Gets a value indicating whether the WebSocket is connected.

Declared In

FMIceLinkWebSocket.h

`– openWithOpenArgs:`

Opens the WebSocket connection.

- (void)openWithOpenArgs:(FMIceLinkWebSocketOpenArgs *)openArgs

Parameters

`openArgs`	The open arguments.

Discussion

Opens the WebSocket connection.

Declared In

FMIceLinkWebSocket.h

`– protocol`

Gets the WebSocket protocol.

- (NSString *)protocol

Discussion

Gets the WebSocket protocol.

Declared In

FMIceLinkWebSocket.h

`– secure`

Gets a value indicating whether the WebSocket is secure.

- (bool)secure

Discussion

Gets a value indicating whether the WebSocket is secure.

Declared In

FMIceLinkWebSocket.h

`– sendWithSendArgs:`

Sends a message to the WebSocket server.

- (void)sendWithSendArgs:(FMIceLinkWebSocketSendArgs *)sendArgs

Parameters

`sendArgs`	The send arguments.

Discussion

Sends a message to the WebSocket server.

Declared In

FMIceLinkWebSocket.h

`+ webSocketWithRequestUrl:`

Creates a new FMIceLinkWebSocket.

+ (FMIceLinkWebSocket *)webSocketWithRequestUrl:(NSString *)requestUrl

Parameters

`requestUrl`	The target URL for the WebSocket connection.

Discussion

Creates a new FMIceLinkWebSocket.

Declared In

FMIceLinkWebSocket.h

`+ webSocketWithRequestUrl:protocol:`

Creates a new FMIceLinkWebSocket.

+ (FMIceLinkWebSocket *)webSocketWithRequestUrl:(NSString *)requestUrl protocol:(NSString *)protocol

Parameters

`requestUrl`	The target URL for the WebSocket connection.
`protocol`	The WebSocket protocol.

Discussion

Creates a new FMIceLinkWebSocket.

Declared In

FMIceLinkWebSocket.h