net.openhft.chronicle.wire.channel

Class ChronicleChannelCfg<C extends ChronicleChannelCfg<C>>

java.lang.Object

net.openhft.chronicle.wire.AbstractCommonMarshallable

net.openhft.chronicle.wire.SelfDescribingMarshallable

net.openhft.chronicle.wire.channel.ChronicleChannelCfg<C>

Type Parameters:

C - the type of the implementing class that is derived from ChronicleChannelCfg

All Implemented Interfaces:

net.openhft.chronicle.bytes.BytesMarshallable, net.openhft.chronicle.bytes.CommonMarshallable, net.openhft.chronicle.bytes.ReadBytesMarshallable, net.openhft.chronicle.bytes.WriteBytesMarshallable, net.openhft.chronicle.core.io.Resettable, Marshallable, ReadMarshallable, WriteMarshallable, WriteValue

Direct Known Subclasses:

ChronicleChannelSupplier

public class ChronicleChannelCfg<C extends ChronicleChannelCfg<C>>
extends SelfDescribingMarshallable

The ChronicleChannelCfg class is a configuration object for creating and configuring ChronicleChannel instances. It offers a fluent API to customize parameters including the initiator flag, buffering mode, host parameters, pauser mode and connection timeout settings.

Field Summary

Fields inherited from interface net.openhft.chronicle.wire.WriteMarshallable

EMPTY

Fields inherited from interface net.openhft.chronicle.wire.ReadMarshallable

DISCARD

Constructor Summary

Constructors

Constructor and Description
ChronicleChannelCfg()

Method Summary

Modifier and Type	Method and Description
ChronicleChannelCfg<C>	addHostnamePort(String hostname, int port) Adds a hostname and port to the set of host ports.
boolean	buffered() Returns the buffered flag.
C	buffered(boolean buffered) Sets the buffering mode for the connection.
void	clearHostnamePort() Clears all the host ports you have set up.
double	connectionTimeoutSecs() Returns the connection timeout in seconds.
C	connectionTimeoutSecs(double connectionTimeoutSecs) Sets the connection timeout in seconds.
String	hostname() Deprecated. use hostPorts()
C	hostname(String hostname) Deprecated. use addHostnamePort(String, int)
Set<HostPortCfg>	hostPorts() Returns the set of host ports configured for the ChronicleChannel.
boolean	initiator() Returns the initiator flag.
ChronicleChannelCfg<C>	initiator(boolean initiator) Sets the initiator flag.
net.openhft.chronicle.threads.PauserMode	pauserMode() Returns the PauserMode.
C	pauserMode(net.openhft.chronicle.threads.PauserMode pauser) Sets the PauserMode to be used by the connection.
int	port() Deprecated. use hostPorts()
C	port(int port) Deprecated. use addHostnamePort(String, int)
void	removeHostnamePort(String hostname, int port) Removes a hostname and port from the set of host ports.

Methods inherited from class net.openhft.chronicle.wire.SelfDescribingMarshallable

usesSelfDescribingMessage

Methods inherited from class net.openhft.chronicle.wire.AbstractCommonMarshallable

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.wire.Marshallable

$equals, $fieldInfoMap, $fieldInfos, $hashCode, $toString, className, copyTo, deepCopy, fromFile, fromFile, fromString, fromString, fromString, getField, getLongField, mergeToMap, readMarshallable, reset, setField, setLongField, streamFromFile, streamFromFile, writeMarshallable

Methods inherited from interface net.openhft.chronicle.wire.WriteMarshallable

binaryLengthLength, writeValue

Methods inherited from interface net.openhft.chronicle.wire.ReadMarshallable

unexpectedField

Methods inherited from interface net.openhft.chronicle.bytes.BytesMarshallable

$toString, readMarshallable, writeMarshallable

Constructor Detail

ChronicleChannelCfg

public ChronicleChannelCfg()

Method Detail

hostPorts

public Set<HostPortCfg> hostPorts()

Returns the set of host ports configured for the ChronicleChannel. If hostname and port are set, they will be included in the set.

Returns:

the set of host ports

addHostnamePort

public ChronicleChannelCfg<C> addHostnamePort(String hostname,
                                              int port)

Adds a hostname and port to the set of host ports.

Parameters:

hostname - the hostname

port - the port number

Returns:

this configuration instance

removeHostnamePort

public void removeHostnamePort(String hostname,
                               int port)

Removes a hostname and port from the set of host ports.

Parameters:

hostname - the hostname

port - the port number

initiator

public ChronicleChannelCfg<C> initiator(boolean initiator)

Sets the initiator flag.

Parameters:

initiator - the initiator flag

Returns:

this configuration instance

initiator

public boolean initiator()

Returns the initiator flag.

Returns:

the initiator flag

hostname

@Deprecated
public String hostname()

Deprecated. use hostPorts()

Returns the hostname.

Returns:

the hostname

hostname

@Deprecated
public C hostname(String hostname)

Deprecated. use addHostnamePort(String, int)

Sets the hostname for the connection.

Parameters:

hostname - the hostname

Returns:

this configuration instance

port

@Deprecated
public int port()

Deprecated. use hostPorts()

Returns the port number.

Returns:

the port number

port

@Deprecated
public C port(int port)

Deprecated. use addHostnamePort(String, int)

Sets the port number.

Parameters:

port - the port number

Returns:

this configuration instance

buffered

public boolean buffered()

Returns the buffered flag.

Returns:

the buffered flag

buffered

public C buffered(boolean buffered)

Sets the buffering mode for the connection.

Parameters:

buffered - if true, enables buffering

Returns:

this configuration instance for chaining method calls

pauserMode

public net.openhft.chronicle.threads.PauserMode pauserMode()

Returns the PauserMode.

Returns:

the PauserMode

pauserMode

public C pauserMode(net.openhft.chronicle.threads.PauserMode pauser)

Sets the PauserMode to be used by the connection.

Parameters:

pauser - the PauserMode

Returns:

this configuration instance for chaining method calls

connectionTimeoutSecs

public double connectionTimeoutSecs()

Returns the connection timeout in seconds. If not set or is set to a non-positive value, it will return a default value based on the debug mode.

Returns:

the connection timeout in seconds

connectionTimeoutSecs

public C connectionTimeoutSecs(double connectionTimeoutSecs)

Sets the connection timeout in seconds.

Parameters:

connectionTimeoutSecs - the connection timeout in seconds

Returns:

this configuration instance for chaining method calls

clearHostnamePort

public void clearHostnamePort()

Clears all the host ports you have set up.