public final class

WebSocket

extends Object
java.lang.Object
   ↳ chan.http.WebSocket

Class Overview

Web socket request builder and executor.

Summary

Nested Classes
class WebSocket.Connection

WebSocker connection instance. 
class WebSocket.Event

Read data holder. 
interface WebSocket.EventHandler

Callback for read socket data. 
class WebSocket.Result

Connection result holder. 
Public Constructors
WebSocket(Uri uri, HttpHolder holder, HttpRequest.Preset preset)

Constructor for WebSocket.

WebSocket(Uri uri, HttpHolder holder)

Constructor for WebSocket without preset.

WebSocket(Uri uri, HttpRequest.Preset preset)

Constructor for WebSocket.

Public Methods
WebSocket addCookie(CookieBuilder builder)

Add a CookieBuilder and concatenate it with existing one.

WebSocket addCookie(String name, String value)

Add a cookie with given name and value.

WebSocket addCookie(String cookie)

Add a cookie string.

WebSocket addHeader(String name, String value)

Add a header with given name and value.

WebSocket.Connection open(WebSocket.EventHandler handler)

Opens a WebSocket connection.

WebSocket setTimeouts(int connectTimeout, int readTimeout)

Sets the timeouts of connection.

[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public WebSocket (Uri uri, HttpHolder holder, HttpRequest.Preset preset)

Constructor for WebSocket.

Parameters
uri Uri: URI for request.
holder HttpHolder: HttpHolder instance. May be null.
preset HttpRequest.Preset: Preset with configuration.

public WebSocket (Uri uri, HttpHolder holder)

Constructor for WebSocket without preset.

Parameters
uri Uri: URI for request.
holder HttpHolder: HttpHolder instance. May be null.

public WebSocket (Uri uri, HttpRequest.Preset preset)

Constructor for WebSocket. In most cases HttpRequest.Preset can provide it's own HttpHolder, so you can use this constructor.

Parameters
uri Uri: URI for request.
preset HttpRequest.Preset: Preset with configuration.

Public Methods

public WebSocket addCookie (CookieBuilder builder)

Add a CookieBuilder and concatenate it with existing one.

Parameters
builder CookieBuilder: CookieBuilder instance.
Returns
WebSocket This builder.

See also:

public WebSocket addCookie (String name, String value)

Add a cookie with given name and value.

Parameters
name String: Cookie name.
value String: Cookie value.
Returns
WebSocket This builder.

See also:

public WebSocket addCookie (String cookie)

Add a cookie string.

Parameters
cookie String: Cookie string.
Returns
WebSocket This builder.

See also:

public WebSocket addHeader (String name, String value)

Add a header with given name and value.

Parameters
name String: Header name.
value String: Header value.
Returns
WebSocket This builder.

public WebSocket.Connection open (WebSocket.EventHandler handler)

Opens a WebSocket connection.

Parameters
handler WebSocket.EventHandler: Event handler for incoming data.
Returns
WebSocket.Connection Connection instance.
Throws
HttpException if HTTP exception occurred.

public WebSocket setTimeouts (int connectTimeout, int readTimeout)

Sets the timeouts of connection.

Parameters
connectTimeout int: TCP handshake timeout in milliseconds.
readTimeout int: Max delay in milliseconds between reading data.
Returns
WebSocket This builder.