net.openhft.chronicle.wire.channel

Class ChronicleChannelSupplier

java.lang.Object

net.openhft.chronicle.wire.AbstractCommonMarshallable

net.openhft.chronicle.wire.SelfDescribingMarshallable

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

net.openhft.chronicle.wire.channel.ChronicleChannelSupplier

All Implemented Interfaces:

Supplier<ChronicleChannel>, 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

public class ChronicleChannelSupplier
extends ChronicleChannelCfg<ChronicleChannelSupplier>
implements Supplier<ChronicleChannel>

The ChronicleChannelSupplier class is a specialized version of ChronicleChannelCfg, also implementing the Supplier interface to provide ChronicleChannel instances based on a specified protocol. The protocols currently supported are 'tcp' and 'internal'.

See Also:

Supplier

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
ChronicleChannelSupplier(ChronicleContext context, ChannelHandler handler) Constructs a new ChronicleChannelSupplier with the provided context and handler.

Method Summary

Modifier and Type	Method and Description
String	connectionId() Retrieves the connection ID associated with this supplier.
ChronicleChannelSupplier	connectionId(String connectionId) Sets the connection ID associated with this supplier.
ChronicleChannel	get() Depending on the specified protocol, it instantiates a new ChronicleChannel, registers it with the context, and returns the newly created ChronicleChannel instance.
String	protocol() Retrieves the protocol used by this supplier for creating ChronicleChannel instances.
ChronicleChannelSupplier	protocol(String protocol) Sets the protocol used by this supplier for creating ChronicleChannel instances.

Methods inherited from class net.openhft.chronicle.wire.channel.ChronicleChannelCfg

addHostnamePort, buffered, buffered, clearHostnamePort, connectionTimeoutSecs, connectionTimeoutSecs, hostname, hostname, hostPorts, initiator, initiator, pauserMode, pauserMode, port, port, removeHostnamePort

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

ChronicleChannelSupplier

public ChronicleChannelSupplier(ChronicleContext context,
                                ChannelHandler handler)

Constructs a new ChronicleChannelSupplier with the provided context and handler.

Parameters:

context - the ChronicleContext that serves as the system context for this supplier

handler - the ChannelHandler responsible for handling events on the channel

Method Detail

get

public ChronicleChannel get()

Depending on the specified protocol, it instantiates a new ChronicleChannel, registers it with the context, and returns the newly created ChronicleChannel instance.

Specified by:

get in interface Supplier<ChronicleChannel>

Returns:

a new instance of ChronicleChannel. The type of ChronicleChannel (TCP or internal) depends on the protocol set on this supplier.

Throws:

IllegalArgumentException - if the protocol is unsupported

protocol

public String protocol()

Retrieves the protocol used by this supplier for creating ChronicleChannel instances.

Returns:

the protocol as a string

protocol

public ChronicleChannelSupplier protocol(String protocol)

Sets the protocol used by this supplier for creating ChronicleChannel instances.

Parameters:

protocol - the protocol as a string

Returns:

this ChronicleChannelSupplier instance, to allow method chaining

connectionId

public String connectionId()

Retrieves the connection ID associated with this supplier.

Returns:

the connection ID as a string

connectionId

public ChronicleChannelSupplier connectionId(String connectionId)

Sets the connection ID associated with this supplier.

Parameters:

connectionId - the connection ID as a string

Returns:

this ChronicleChannelSupplier instance, to allow method chaining