FMIceLinkWebSocketCloseArgs Class Reference

Inherits from	FMIceLinkDynamic : FMIceLinkSerializable : NSObject
Declared in	FMIceLinkWebSocketCloseArgs.h FMIceLinkWebSocketCloseArgs.m

Overview

Close arguments for the [FMIceLinkWebSocket](../Classes/FMIceLinkWebSocket.html) class.

`– init`

Creates a new instance of FMIceLinkWebSocketCloseArgs with default values.

- (instancetype)init

Discussion

Creates a new instance of FMIceLinkWebSocketCloseArgs with default values.

Declared In

FMIceLinkWebSocketCloseArgs.h

`– onComplete`

Gets the callback to execute when the connection is closed.

- (FMIceLinkAction1<FMIceLinkWebSocketCloseCompleteArgs*> *)onComplete

Discussion

Gets the callback to execute when the connection is closed.

Declared In

FMIceLinkWebSocketCloseArgs.h

`– reason`

Gets the reason to send with the close frame.

- (NSString *)reason

Discussion

Gets the reason to send with the close frame.

Declared In

FMIceLinkWebSocketCloseArgs.h

`– setOnComplete:`

Sets the callback to execute when the connection is closed.

- (void)setOnComplete:(FMIceLinkAction1<FMIceLinkWebSocketCloseCompleteArgs*> *)value

Discussion

Sets the callback to execute when the connection is closed.

Declared In

FMIceLinkWebSocketCloseArgs.h

`– setOnCompleteBlock`

Sets the callback to execute when the connection is closed.

- (void ( ^ ) ( void ( ^ ) ( FMIceLinkWebSocketCloseCompleteArgs *) ))setOnCompleteBlock

Discussion

Sets the callback to execute when the connection is closed.

Declared In

FMIceLinkWebSocketCloseArgs.h

`– setOnCompleteBlock:`

Sets the callback to execute when the connection is closed.

- (void)setOnCompleteBlock:(void ( ^ ) ( FMIceLinkWebSocketCloseCompleteArgs *))valueBlock

Discussion

Sets the callback to execute when the connection is closed.

Declared In

FMIceLinkWebSocketCloseArgs.h

`– setReason:`

Sets the [reason](#//api/name/reason) to send with the close frame.

- (void)setReason:(NSString *)value

Discussion

Sets the [reason](#//api/name/reason) to send with the close frame.

Declared In

FMIceLinkWebSocketCloseArgs.h

`– setStatusCode:`

Sets the status code to send with the close frame.

- (void)setStatusCode:(FMIceLinkWebSocketStatusCode)value

Discussion

Sets the status code to send with the close frame.

Declared In

FMIceLinkWebSocketCloseArgs.h

`– statusCode`

Gets the status code to send with the close frame.

- (FMIceLinkWebSocketStatusCode)statusCode

Discussion

Gets the status code to send with the close frame.

Declared In

FMIceLinkWebSocketCloseArgs.h

`+ webSocketCloseArgs`

Creates a new instance of FMIceLinkWebSocketCloseArgs with default values.

+ (FMIceLinkWebSocketCloseArgs *)webSocketCloseArgs

Discussion

Creates a new instance of FMIceLinkWebSocketCloseArgs with default values.

Declared In

FMIceLinkWebSocketCloseArgs.h