net.openhft.chronicle.wire.channel

Class ChronicleGatewayMain

java.lang.Object

net.openhft.chronicle.core.io.SimpleCloseable

net.openhft.chronicle.wire.channel.ChronicleContext

net.openhft.chronicle.wire.channel.ChronicleGatewayMain

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner

public class ChronicleGatewayMain
extends ChronicleContext
implements net.openhft.chronicle.core.io.Closeable, Runnable

The ChronicleGatewayMain class represents the primary access point for the Chronicle Gateway. This gateway is pivotal in processing incoming connections and effectively handling requests based on a predetermined protocol.

By extending ChronicleContext and implementing Closeable and Runnable, instances of this class have the ability to manage their lifecycle autonomously and can operate in individual threads. Configuration of the Gateway can be done utilizing system properties.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PORT

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT, TMP

Constructor Summary

Constructors

Constructor and Description
ChronicleGatewayMain(String url) Constructs a new ChronicleGatewayMain instance with a specific URL.
ChronicleGatewayMain(String url, net.openhft.chronicle.wire.channel.impl.SocketRegistry socketRegistry, SystemContext systemContext) Constructs a new ChronicleGatewayMain instance with a specific URL, socket registry, and system context.

Method Summary

Modifier and Type	Method and Description
boolean	buffered() Checks if the gateway is operating in buffered mode.
ChronicleGatewayMain	buffered(boolean buffered) Sets whether new connections will be buffered if the client doesn't specify whether buffering should be used.
protected static <T extends ChronicleGatewayMain> ChronicleGatewayMain	main(Class<T> mainClass, Function<String,T> supplier, String config) Generates an instance of the ChronicleGatewayMain class based on the supplied configuration.
static void	main(String... args) The main method acts as the entry point to start the ChronicleGatewayMain.
ChronicleGatewayMain	pauserMode(net.openhft.chronicle.threads.PauserMode pauserMode) Sets the PauserMode to control the balance between CPU usage and minimising latency
protected void	performClose() Closes all resources managed by this context in a quiet manner, i.e., without throwing any exceptions.
int	port() Returns the port number on which the gateway is listening.
protected ChannelHeader	replaceInHeader(ChannelHeader channelHeader) Allows replacing of the inbound channel header.
protected ChannelHeader	replaceOutHeader(ChannelHeader channelHeader) Allows replacing of the outbound channel header.
void	run() Main execution loop for the gateway.
ChronicleGatewayMain	start() Starts the gateway, binding the server socket channel and starting the acceptor thread if not already running.
protected @Nullable ChannelHandler	validateHandler(Marshallable marshallable) Validates that the incoming request contains a valid handler.

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

addCloseable, affinityLock, closeCallback, closeCallback, init, name, name, newChannelSupplier, newContext, socketRegistry, startNewGateway, systemContext, systemContext, toFile, toString, url, urlFor, useAffinity, useAffinity

Methods inherited from class net.openhft.chronicle.core.io.SimpleCloseable

close, isClosed

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

close, closeQuietly, closeQuietly

Methods inherited from interface net.openhft.chronicle.core.io.QueryCloseable

isClosed, isClosing

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

referenceId, referenceName, temporary

Methods inherited from interface net.openhft.chronicle.core.io.ManagedCloseable

createdHere, throwExceptionIfClosed, warnAndCloseIfNotClosed

Field Detail

PORT

public static final int PORT

Constructor Detail

ChronicleGatewayMain

public ChronicleGatewayMain(String url)
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException

Constructs a new ChronicleGatewayMain instance with a specific URL. The gateway will use the default system context and a new socket registry.

Parameters:

url - the URL for the Gateway

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an issue while creating the gateway

ChronicleGatewayMain

public ChronicleGatewayMain(String url,
                            net.openhft.chronicle.wire.channel.impl.SocketRegistry socketRegistry,
                            SystemContext systemContext)
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException

Constructs a new ChronicleGatewayMain instance with a specific URL, socket registry, and system context.

Parameters:

url - the URL for the Gateway

socketRegistry - the SocketRegistry used by the gateway for managing socket connections

systemContext - the SystemContext that defines system-level configuration for the gateway

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an issue while creating the gateway

Method Detail

main

public static void main(String... args)
                 throws IOException,
                        net.openhft.chronicle.core.io.InvalidMarshallableException

The main method acts as the entry point to start the ChronicleGatewayMain. It creates a new instance of the class and runs it. The URL for the gateway can be optionally specified as a command-line argument.

Parameters:

args - Command line arguments. If the first argument is provided, it will be used as the URL for the gateway.

Throws:

IOException - if there is an I/O issue while starting the gateway

net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an issue while creating the gateway

main

protected static <T extends ChronicleGatewayMain> ChronicleGatewayMain main(Class<T> mainClass,
                                                                            Function<String,T> supplier,
                                                                            String config)
                                                                     throws IOException

Generates an instance of the ChronicleGatewayMain class based on the supplied configuration.

Type Parameters:

T - Represents the subclass type of ChronicleGatewayMain.

Parameters:

mainClass - The main class type for creating an instance.

supplier - Provides an instance of the main class based on the configuration string.

config - The configuration string used for creating the main instance.

Returns:

An instance of the ChronicleGatewayMain class, created and configured based on the provided arguments.

Throws:

IOException - If there's a problem reading the configuration.

pauserMode

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

Sets the PauserMode to control the balance between CPU usage and minimising latency

Parameters:

pauserMode - The pauser mode to be set.

Returns:

The current instance of ChronicleGatewayMain for chained calls.

buffered

public boolean buffered()

Checks if the gateway is operating in buffered mode.

Overrides:

buffered in class ChronicleContext

Returns:

true if in buffered mode, otherwise false.

buffered

public ChronicleGatewayMain buffered(boolean buffered)

Sets whether new connections will be buffered if the client doesn't specify whether buffering should be used.

Overrides:

buffered in class ChronicleContext

Parameters:

buffered - Set to true if buffering should be enabled.

Returns:

The current instance of ChronicleGatewayMain for chained calls.

start

public ChronicleGatewayMain start()
                           throws IOException

Starts the gateway, binding the server socket channel and starting the acceptor thread if not already running.

Throws:

IOException - If there's a hiccup during the gateway's startup.

run

public void run()

Main execution loop for the gateway. Accepts incoming connections and handles requests.

Specified by:

run in interface Runnable

replaceInHeader

protected ChannelHeader replaceInHeader(ChannelHeader channelHeader)

Allows replacing of the inbound channel header. By default, it retains the given header without making any changes.

Parameters:

channelHeader - the inbound channel header

Returns:

the possibly replaced channel header

replaceOutHeader

protected ChannelHeader replaceOutHeader(ChannelHeader channelHeader)

Allows replacing of the outbound channel header. If the outbound channel header is an instance of a ChannelHandler, it replaces it with the response header from the handler.

Parameters:

channelHeader - the outbound channel header

Returns:

the possibly replaced channel header

performClose

protected void performClose()

Description copied from class: ChronicleContext

Closes all resources managed by this context in a quiet manner, i.e., without throwing any exceptions. After closing, the set of Closeable resources is cleared. If the SocketRegistry was privately created by this context, it is also closed.

Overrides:

performClose in class ChronicleContext

validateHandler

@Nullable
protected @Nullable ChannelHandler validateHandler(Marshallable marshallable)

Validates that the incoming request contains a valid handler.

Parameters:

marshallable - the incoming request

Returns:

a ChannelHandler instance if the request is valid; otherwise null

port

public int port()

Returns the port number on which the gateway is listening.

Overrides:

port in class ChronicleContext

Returns:

the port number