Tasks

• – url

  The NSURL that refers to the server location.

• – readyState

  The current state of the connection. The value can be one of 0(CONNECTING), 1(OPEN), 2(CLOSING), 3(CLOSED).

• – negotiatedProtocol

  A string indicating the name of the sub-protocol the server selected. this will be one of the strings specified in the protocols parameter when creating the WebSocket object.

• – enabledProtocols

  Gets the names of all the protocols that are enabled for this connection. Returns an empty array if protocols are not enabled.

• – setEnabledProtocols:

  Registers the protocols to be negotiated with the server during the handshake. This method must be invoked before method connect is called. If this method is invoked after a connection has been successfully established, an exception is thrown.

• – negotiatedExtensions

  Gets names of all the enabled extensions that have been successfully negotiated between the client and the server during the initial handshake.

• – enabledExtensions

  Gets the names of all the extensions that have been enabled for this connection. The enabled extensions are negotiated between the client and the server during the handshake. The names of the negotiated extensions can be obtained using method negotiatedExtensions. An empty array is returned if no extensions have been enabled for this connection.

• – setEnabledExtensions:

  Registers the names of all the extensions that must be negotiated between the client and the server during the handshake. This method must be invoked before invoking the method connect.

• – enabledParameter:

  Gets the value of the specified KGWebSocketExtensionParameter defined in an enabled extension. If the parameter is not defined for this connection but a default value for the parameter is set using the method [KGWebSocketFactory setDefaultParameter:value:], then the default value is returned.

• – negotiatedParameter:

  Returns the value of the specified KGWebSocketExtensionParameter of a negotiated extension.

• – setEnabledParameter:value:

  Sets the value of the specified KGWebSocketExtensionParameter defined in an enabled extension. The application developer should set the extension parameters of the enabled extensions before invoking the connect method.

• – connect

  Establishes the websocket connection to the server. It uses server url specified when creating this instance using KGWebSocketFactory.

• – close

  Closes the WebSocket connection or connection attempt, if any. If the connection is already closed, this method does nothing.

• – close:

  Closes the WebSocket connection or connection attempt, if any with the code specified. If the connection is already closed, this method does nothing.

• – close:reason:

  Closes the WebSocket connection or connection attempt, if any with the code and reason specified. If the connection is already closed, this method does nothing.

• – send:

  Transmits data to the server over the WebSocket connection.

• – delegate

  Returns the delegate set for the receiver.

• – setDelegate:

  Sets the delegate for the receiver.

• – challengeHandler

  Gets the KGChallengeHandler that is used during authentication both at the connect-time as well as at subsequent revalidation-time that occurs at regular intervals.

• – setChallengeHandler:

  Sets the KGChallengeHandler that is used during authentication both at the connect-time as well as at subsequent revalidation-time that occurs at regular intervals.

• – clientIdentity

  Returns the SecIdentityRef object used for client certificate authentication

• – setClientIdentity:

  Sets Client Identity for SSL client certificate authentication.

• – connectTimeout

  Gets the connect timeout in milliseconds. The timeout will expire if there is no exchange of packets(for example, 100% packet loss) while establishing the connection. A timeout value of zero indicates no timeout. Default connect timeout is zero.

• – setConnectTimeout:

  Sets the connect timeout in milliseconds. The timeout will expire if there is no exchange of packets(for example, 100% packet loss) while establishing the connection. A timeout value of zero indicates no timeout.

•   didOpen

  The block to execute when WebSocket connection’s readyState changes to OPEN. This indicates that the connection is ready to send and receive data.

  property
•   didClose

  The block to execute when the connection is closed. The block takes the following arguments:
  websocket – The KGWebSocket instance that is closed
  code – The WebSocket connection close code provided by the server
  reason – A string indicating the reason the connection is closed
  wasClean – Indicates whether or not the connection was cleanly closed.

  property
•   didReceiveError

  The block to execute when an error occurs.

  property
•   didReceiveMessage

  The block to execute when a message is received from the server. The data ‘is’ either UTF8-String (type: NSString) or binary (type: NSData)

  property