Clients - http : WebSocketClient

Represents a WebSocket client endpoint.

pushText

(string | json | xml | boolean | int | float | byte | byte data, boolean finalFrame)

returns WebSocketError?

Push text to the connection.

Parameters

  • data string | json | xml | boolean | int | float | byte | byte
  • Data to be sent, if byte[] it is converted to a UTF-8 string for sending

  • finalFrame boolean (default true)
  • Set to true if this is a final frame of a (long) message

pushBinary

(byte data, boolean finalFrame)

returns error

Push binary data to the connection.

Parameters

  • data byte
  • Binary data to be sent

  • finalFrame boolean (default true)
  • Set to true if this is a final frame of a (long) message

  • Return Type

    (error)
  • error if an error occurs when sending

ping

(byte data)

returns WebSocketError?

Ping the connection.

Parameters

  • data byte
  • Binary data to be sent.

pong

(byte data)

returns WebSocketError?

Send pong message to the connection.

Parameters

  • data byte
  • Binary data to be sent

close

(int statusCode, string reason, int timeoutInSeconds)

returns WebSocketError?

Close the connection.

Parameters

  • statusCode int (default 1000)
  • Status code for closing the connection

  • reason string (default ())
  • Reason for closing the connection

  • timeoutInSeconds int (default 60)
  • Time to wait for the close frame to be received from the remote endpoint before closing the connection. If the timeout exceeds, then the connection is terminated even though a close frame is not received from the remote endpoint. If the value < 0 (e.g., -1), then the connection waits until a close frame is received. If WebSocket frame is received from the remote endpoint, within waiting period the connection is terminated immediately.

ready

()

returns WebSocketError?

Called when the endpoint is ready to receive messages. Can be called only once per endpoint. For the WebSocketListener can be called only in upgrade or onOpen resources.

initEndpoint

Initializes the endpoint.

setAttribute

Sets a connection related attribute.

Parameters

  • key string
  • key that identifies the attribute

  • value any
  • value of the attribute

getAttribute

(string key)

returns any

Gets connection related attribute if any.

Parameters

  • key string
  • the key to identify the attribute.

  • Return Type

    (any)
  • the attribute related to the given key or nil

removeAttribute

(string key)

returns any

Removes connection related attribute if any.

Parameters

  • key string
  • the key to identify the attribute.

  • Return Type

    (any)
  • the attribute related to the given key or nil

getConnectionId

()

returns string

Gives the connection id associated with this connection.

  • Return Type

    (string)
  • the unique id associated with the connection

getNegotiatedSubProtocol

()

returns string

Gives the subprotocol if any that is negotiated with the client.

  • Return Type

    (string)
  • The subprotocol if any negotiated with the client or nil

isSecure

()

returns boolean

Gives the secured status of the connection.

  • Return Type

    (boolean)
  • true if the connection is secure.

isOpen

()

returns boolean

Gives the open or closed status of the connection.

  • Return Type

    (boolean)
  • true if the connection is open

getHttpResponse

()

returns Response?

Gives the HTTP response if any received for the client handshake request.

  • Return Type

    (Response?)
  • the HTTP response received for the client handshake request