Module swim.io

Package swim.io

Class SocketSettings

java.lang.Object

swim.io.SocketSettings

All Implemented Interfaces:

swim.codec.Debug

public class SocketSettings
extends Object
implements swim.codec.Debug

Socket configuration parameters.

Field Summary

Fields

Modifier and Type	Field	Description
protected TcpSettings	tcpSettings
protected TlsSettings	tlsSettings

Constructor Summary

Constructors

Constructor	Description
SocketSettings(TcpSettings tcpSettings, TlsSettings tlsSettings)

Method Summary

Modifier and Type	Method	Description
boolean	canEqual(Object other)	Returns true if these SocketSettings can possibly equal some other object.
void	configure(Socket socket)	Configures the socket with these SocketSettings.
protected SocketSettings	copy(TcpSettings tcpSettings, TlsSettings tlsSettings)	Returns a new SocketSettings instance with the given options.
void	debug(swim.codec.Output<?> output)
boolean	equals(Object other)
static swim.structure.Form<SocketSettings>	form()	Returns the structural Form of SocketSettings.
static SocketSettings	from(TcpSettings tcpSettings)
static SocketSettings	from(TlsSettings tlsSettings)
int	hashCode()
static SocketSettings	standard()	Returns the default SocketSettings instance.
TcpSettings	tcpSettings()	Returns the TCP socket configuration.
SocketSettings	tcpSettings(TcpSettings tcpSettings)	Returns a copy of these SocketSettings configured with the given tcpSettings.
TlsSettings	tlsSettings()	Returns the TLS socket configuration.
SocketSettings	tlsSettings(TlsSettings tlsSettings)	Returns a copy of these SocketSettings configured with the given tlsSettings.
String	toString()
swim.structure.Value	toValue()	Returns a structural Value representing these SocketSettings.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

tcpSettings

protected final TcpSettings tcpSettings

tlsSettings

protected final TlsSettings tlsSettings

Constructor Detail

SocketSettings

public SocketSettings(TcpSettings tcpSettings,
                      TlsSettings tlsSettings)

Method Detail

tcpSettings

public TcpSettings tcpSettings()

Returns the TCP socket configuration.

tcpSettings

public SocketSettings tcpSettings(TcpSettings tcpSettings)

Returns a copy of these SocketSettings configured with the given tcpSettings.

tlsSettings

public TlsSettings tlsSettings()

Returns the TLS socket configuration.

tlsSettings

public SocketSettings tlsSettings(TlsSettings tlsSettings)

Returns a copy of these SocketSettings configured with the given tlsSettings.

copy

protected SocketSettings copy(TcpSettings tcpSettings,
                              TlsSettings tlsSettings)

Returns a new SocketSettings instance with the given options. Subclasses may override this method to ensure the proper class is instantiated when updating settings.

configure

public void configure(Socket socket)
               throws SocketException

Configures the socket with these SocketSettings.

Throws:

SocketException

toValue

public swim.structure.Value toValue()

Returns a structural Value representing these SocketSettings.

canEqual

public boolean canEqual(Object other)

Returns true if these SocketSettings can possibly equal some other object.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

debug

public void debug(swim.codec.Output<?> output)

Specified by:

debug in interface swim.codec.Debug

toString

public String toString()

Overrides:

toString in class Object

standard

public static SocketSettings standard()

Returns the default SocketSettings instance.

from

public static SocketSettings from(TcpSettings tcpSettings)

from

public static SocketSettings from(TlsSettings tlsSettings)

form

@Kind
public static swim.structure.Form<SocketSettings> form()

Returns the structural Form of SocketSettings.