FMWebSocket Class Reference

Inherits from FMBaseWebSocket : FMDynamic : FMSerializable : NSObject
Declared in FM.h

Overview

Implementation of the WebSocket 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

FM.h

– close

Closes the WebSocket connection.

- (void)close

Discussion

Closes the WebSocket connection.

Declared In

FM.h

– closeWithCloseArgs:

Closes the WebSocket connection.

- (void)closeWithCloseArgs:(FMWebSocketCloseArgs *)closeArgs

Parameters

name="closeArgs">The

close arguments

Discussion

Closes the WebSocket connection.

Declared In

FM.h

– closeWithArgs:

Closes the WebSocket connection.

- (void)closeWithArgs:(FMWebSocketCloseArgs *)closeArgs

Parameters

name="closeArgs">The

close arguments

Discussion

Closes the WebSocket connection.

Declared In

FM.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

FM.h

– initWithRequestUrl:

Creates a new .

- (id)initWithRequestUrl:(NSString *)requestUrl

Parameters

name="requestUrl">The

target URL for the WebSocket connection.

Discussion

Creates a new .

Declared In

FM.h

– initWithRequestUrl:protocol:

Creates a new .

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

Parameters

name="requestUrl">The

target URL for the WebSocket connection.
name="protocol">The

WebSocket protocol.

Discussion

Creates a new .

Declared In

FM.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

FM.h

– openWithOpenArgs:

Opens the WebSocket connection.

- (void)openWithOpenArgs:(FMWebSocketOpenArgs *)openArgs

Parameters

name="openArgs">The

open arguments.

Discussion

Opens the WebSocket connection.

Declared In

FM.h

– openWithArgs:

Opens the WebSocket connection.

- (void)openWithArgs:(FMWebSocketOpenArgs *)openArgs

Parameters

name="openArgs">The

open arguments.

Discussion

Opens the WebSocket connection.

Declared In

FM.h

– protocol

Gets the WebSocket protocol.

- (NSString *)protocol

Discussion

Gets the WebSocket protocol.

Declared In

FM.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

FM.h

– sendWithSendArgs:

Sends a message to the WebSocket server.

- (void)sendWithSendArgs:(FMWebSocketSendArgs *)sendArgs

Parameters

name="sendArgs">The

send arguments.

Discussion

Sends a message to the WebSocket server.

Declared In

FM.h

– sendWithArgs:

Sends a message to the WebSocket server.

- (void)sendWithArgs:(FMWebSocketSendArgs *)sendArgs

Parameters

name="sendArgs">The

send arguments.

Discussion

Sends a message to the WebSocket server.

Declared In

FM.h

+ webSocketWithRequestUrl:

Creates a new .

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

Parameters

name="requestUrl">The

target URL for the WebSocket connection.

Discussion

Creates a new .

Declared In

FM.h

+ webSocketWithRequestUrl:protocol:

Creates a new .

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

Parameters

name="requestUrl">The

target URL for the WebSocket connection.
name="protocol">The

WebSocket protocol.

Discussion

Creates a new .

Declared In

FM.h