Package io.socket.client

Class SocketOptionBuilder

java.lang.Object

io.socket.client.SocketOptionBuilder

public class SocketOptionBuilder
extends Object

Convenient builder class that helps creating Client Option object as builder pattern. Finally, you can get option object with call build() method.

Author:

junbong

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SocketOptionBuilder()	Construct new builder with default preferences.
protected	SocketOptionBuilder(IO.Options options)	Construct this builder from specified option object.

Method Summary

Modifier and Type	Method	Description
IO.Options	build()	Finally retrieve IO.Options object from this builder.
static SocketOptionBuilder	builder()	Construct new builder with default preferences.
static SocketOptionBuilder	builder(IO.Options options)	Construct this builder from specified option object.
SocketOptionBuilder	setAuth(Map<String,String> auth)
SocketOptionBuilder	setExtraHeaders(Map<String,List<String>> extraHeaders)
SocketOptionBuilder	setForceNew(boolean forceNew)
SocketOptionBuilder	setHost(String host)
SocketOptionBuilder	setHostname(String hostname)
SocketOptionBuilder	setMultiplex(boolean multiplex)
SocketOptionBuilder	setPath(String path)
SocketOptionBuilder	setPolicyPort(int policyPort)
SocketOptionBuilder	setPort(int port)
SocketOptionBuilder	setQuery(String query)
SocketOptionBuilder	setRandomizationFactor(double randomizationFactor)
SocketOptionBuilder	setReconnection(boolean reconnection)
SocketOptionBuilder	setReconnectionAttempts(int reconnectionAttempts)
SocketOptionBuilder	setReconnectionDelay(long reconnectionDelay)
SocketOptionBuilder	setReconnectionDelayMax(long reconnectionDelayMax)
SocketOptionBuilder	setRememberUpgrade(boolean rememberUpgrade)
SocketOptionBuilder	setSecure(boolean secure)
SocketOptionBuilder	setTimeout(long timeout)
SocketOptionBuilder	setTransports(String[] transports)
SocketOptionBuilder	setUpgrade(boolean upgrade)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SocketOptionBuilder

protected SocketOptionBuilder()

Construct new builder with default preferences.

SocketOptionBuilder

protected SocketOptionBuilder(IO.Options options)

Construct this builder from specified option object. The option that returned from build() method is not equals with given option. In other words, builder creates new option object and copy all preferences from given option.

Parameters:

options - option object which to copy preferences. Null-ok.

Method Details

builder

public static SocketOptionBuilder builder()

Construct new builder with default preferences.

Returns:

new builder object

See Also:

• builder(IO.Options)

builder

public static SocketOptionBuilder builder(IO.Options options)

Construct this builder from specified option object. The option that returned from build() method is not equals with given option. In other words, builder creates new option object and copy all preferences from given option.

Parameters:

options - option object which to copy preferences

Returns:

new builder object

setForceNew

public SocketOptionBuilder setForceNew(boolean forceNew)

setMultiplex

public SocketOptionBuilder setMultiplex(boolean multiplex)

setReconnection

public SocketOptionBuilder setReconnection(boolean reconnection)

setReconnectionAttempts

public SocketOptionBuilder setReconnectionAttempts(int reconnectionAttempts)

setReconnectionDelay

public SocketOptionBuilder setReconnectionDelay(long reconnectionDelay)

setReconnectionDelayMax

public SocketOptionBuilder setReconnectionDelayMax(long reconnectionDelayMax)

setRandomizationFactor

public SocketOptionBuilder setRandomizationFactor(double randomizationFactor)

setTimeout

public SocketOptionBuilder setTimeout(long timeout)

setTransports

public SocketOptionBuilder setTransports(String[] transports)

setUpgrade

public SocketOptionBuilder setUpgrade(boolean upgrade)

setRememberUpgrade

public SocketOptionBuilder setRememberUpgrade(boolean rememberUpgrade)

setHost

public SocketOptionBuilder setHost(String host)

setHostname

public SocketOptionBuilder setHostname(String hostname)

setPort

public SocketOptionBuilder setPort(int port)

setPolicyPort

public SocketOptionBuilder setPolicyPort(int policyPort)

setQuery

public SocketOptionBuilder setQuery(String query)

setSecure

public SocketOptionBuilder setSecure(boolean secure)

setPath

public SocketOptionBuilder setPath(String path)

setAuth

public SocketOptionBuilder setAuth(Map<String,String> auth)

setExtraHeaders

public SocketOptionBuilder setExtraHeaders(Map<String,List<String>> extraHeaders)

build

public IO.Options build()

Finally retrieve IO.Options object from this builder.

Returns:

option that built from this builder