Module swim.io

Package swim.io

Class IpSettings

java.lang.Object

swim.io.IpSettings

All Implemented Interfaces:

swim.codec.Debug

public class IpSettings
extends Object
implements swim.codec.Debug

IP Socket configuration parameters.

Field Summary

Fields

Modifier and Type	Field	Description
protected TcpSettings	tcpSettings
protected TlsSettings	tlsSettings

Constructor Summary

Constructors

Constructor	Description
IpSettings(TcpSettings tcpSettings, TlsSettings tlsSettings)

Method Summary

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

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

IpSettings

public IpSettings(TcpSettings tcpSettings,
                  TlsSettings tlsSettings)

Method Detail

tcpSettings

public TcpSettings tcpSettings()

Returns the TCP socket configuration.

tcpSettings

public IpSettings tcpSettings(TcpSettings tcpSettings)

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

tlsSettings

public TlsSettings tlsSettings()

Returns the TLS socket configuration.

tlsSettings

public IpSettings tlsSettings(TlsSettings tlsSettings)

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

copy

protected IpSettings copy(TcpSettings tcpSettings,
                          TlsSettings tlsSettings)

Returns a new IpSettings 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 IpSettings.

Throws:

SocketException

toValue

public swim.structure.Value toValue()

Returns a structural Value representing these IpSettings.

canEqual

public boolean canEqual(Object other)

Returns true if these IpSettings 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 <T> swim.codec.Output<T> debug(swim.codec.Output<T> output)

Specified by:

debug in interface swim.codec.Debug

toString

public String toString()

Overrides:

toString in class Object

standard

public static IpSettings standard()

Returns the default IpSettings instance.

create

public static IpSettings create(TcpSettings tcpSettings)

create

public static IpSettings create(TlsSettings tlsSettings)

form

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

Returns the structural Form of IpSettings.