FMIceLinkIWebSocket Protocol Reference

Declared in FMIceLinkIWebSocket.h

Overview

Contract for an implementation of the WebSocket protocol v8.

– bufferedAmount required method

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

FMIceLinkIWebSocket.h

– close required method

Closes the WebSocket connection.
- (void)close

Discussion

Closes the WebSocket connection.

Declared In

FMIceLinkIWebSocket.h

– closeWithCloseArgs: required method

Closes the WebSocket connection.
- (void)closeWithCloseArgs:(FMIceLinkWebSocketCloseArgs *)closeArgs

Parameters

closeArgs

The close arguments

Discussion

Closes the WebSocket connection.

Declared In

FMIceLinkIWebSocket.h

– isOpen required method

Gets a value indicating whether the WebSocket is connected.
- (bool)isOpen

Discussion

Gets a value indicating whether the WebSocket is connected.

Declared In

FMIceLinkIWebSocket.h

– openWithOpenArgs: required method

Opens the WebSocket connection.
- (void)openWithOpenArgs:(FMIceLinkWebSocketOpenArgs *)openArgs

Parameters

openArgs

The open arguments.

Discussion

Opens the WebSocket connection.

Declared In

FMIceLinkIWebSocket.h

– secure required method

Gets a value indicating whether the WebSocket is secure.
- (bool)secure

Discussion

Gets a value indicating whether the WebSocket is secure.

Declared In

FMIceLinkIWebSocket.h

– sendWithSendArgs: required method

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

FMIceLinkIWebSocket.h