KGWebSocketDelegate Protocol Reference
| Conforms to | NSObject |
| Declared in | KGWebSocketDelegate.h |
Overview
The KGWebSocketDelegate protocol defines methods implemented by delegates of KGWebSocket objects.
Tasks
-
– webSocket:didReceiveMessage:Sent to the delegate when message is received from the server.
required method -
– webSocketDidOpen:Sent to the delegate when WebSocket connection’s readyState changes to OPEN. This indicates that the connection is ready to send and receive data.
required method -
– webSocket:didCloseWithCode:reason:wasClean:Sent to the delegate when WebSocket connection’s readyState changes to CLOSED.
required method -
– webSocket:didReceiveError:Sent to the delegate when error occurs.
required method
Instance Methods
webSocket:didCloseWithCode:reason:wasClean:
Sent to the delegate when WebSocket connection’s readyState changes to CLOSED.
- (void)webSocket:(KGWebSocket *)webSocket didCloseWithCode:(NSInteger)code reason:(NSString *)reason wasClean:(BOOL)wasCleanParameters
- webSocket
The KGWebSocket instance sending the message.
- code
The WebSocket connection close code provided by the server.
- reason
A string indicating the reason the server closed the connection.
- wasClean
Indicates whether or not the connection was cleanly closed.
Declared In
KGWebSocketDelegate.hwebSocket:didReceiveError:
Sent to the delegate when error occurs.
- (void)webSocket:(KGWebSocket *)webSocket didReceiveError:(NSError *)errorDeclared In
KGWebSocketDelegate.hwebSocket:didReceiveMessage:
Sent to the delegate when message is received from the server.
- (void)webSocket:(KGWebSocket *)webSocket didReceiveMessage:(id)dataParameters
- webSocket
The KGWebSocket instance sending the message.
- data
The data from the server. It can be either NSString or NSData.
Declared In
KGWebSocketDelegate.hwebSocketDidOpen:
Sent to the delegate when WebSocket connection’s readyState changes to OPEN. This indicates that the connection is ready to send and receive data.
- (void)webSocketDidOpen:(KGWebSocket *)webSocketParameters
- webSocket
The KGWebSocket instance sending the message.
Declared In
KGWebSocketDelegate.h