net.openhft.chronicle.wire.channel

Class ChronicleContext

java.lang.Object

net.openhft.chronicle.core.io.SimpleCloseable

net.openhft.chronicle.wire.channel.ChronicleContext

All Implemented Interfaces:

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

Direct Known Subclasses:

ChronicleGatewayMain

public class ChronicleContext
extends net.openhft.chronicle.core.io.SimpleCloseable

This class encapsulates the context for a Chronicle channel, including parameters necessary for creating and managing a channel, such as the socket registry, gateway, and system context. The context can also manage the lifecycle of other closeable resources.

The ChronicleContext provides methods to set important parameters such as the context's URL, whether to use buffering and affinity, and the context's name (which can define the relative directory). It also manages the lifecycle of closeable resources and provides the URL, buffering state, and the socket registry.

Example usage:

 String url = "tcp://:0";
 try (ChronicleContext context = ChronicleContext.newContext(url)
     .name("target/server")
     .buffered(true)
     .useAffinity(true)) {
   ChronicleChannel channel = context.newChannelSupplier(new EchoHandler().buffered(false)).connectionTimeoutSecs(1).get();
   Says says = channel.methodWriter(Says.class);
   says.say("Hello World");
   StringBuilder eventType = new StringBuilder();
   String text = channel.readOne(eventType, String.class);
   assertEquals("say: Hello World", eventType + ": " + text);
 

Field Summary

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

INIT, TMP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChronicleContext(String url) Protected constructor for creating a Chronicle context with the specified URL.
protected	ChronicleContext(String url, SocketRegistry socketRegistry) Protected constructor for creating a Chronicle context with the specified URL and socket registry.

Method Summary

Modifier and Type	Method and Description
void	addCloseable(net.openhft.chronicle.core.io.Closeable closeable) Adds a Closeable resource to the context's internal set of resources.
net.openhft.affinity.AffinityLock	affinityLock()
boolean	buffered() Indicates whether buffering should be used in this context.
ChronicleContext	buffered(boolean buffered) Sets the buffering preference for this context.
protected void	init() Initializes the context, specifically it creates a new SocketRegistry instance if one is not already set.
String	name()
ChronicleContext	name(String name) Sets the names space for the service.
ChronicleChannelSupplier	newChannelSupplier(ChannelHandler handler) Constructs a new ChronicleChannelSupplier object using the provided ChannelHandler and the settings from this context.
static ChronicleContext	newContext(String url) Factory method for a new ChronicleContext
protected void	performClose() Closes all resources managed by this context in a quiet manner, i.e., without throwing any exceptions.
int	port()
SocketRegistry	socketRegistry() Retrieves the SocketRegistry associated with this context.
void	startNewGateway() Starts a new instance of ChronicleGatewayMain if one is not already instantiated for this context.
SystemContext	systemContext() Retrieves the current SystemContext for this process or remote host.
void	systemContext(SystemContext systemContext) Sets the system context for this context.
File	toFile(String name) Returns a new File instance for the given name space (sub-directory) within this context.
String	toString()
URL	url() Retrieves the URL of this context.
static URL	urlFor(String spec) Parses a URL from a string, initializing any custom handlers as necessary.
boolean	useAffinity() Retrieves the status of affinity usage in this context.
ChronicleContext	useAffinity(boolean useAffinity) Sets the status of affinity usage in this context.

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.ReferenceOwner

referenceId, referenceName, temporary

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

createdHere, throwExceptionIfClosed, warnAndCloseIfNotClosed

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

closeQuietly, closeQuietly

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

isClosing

Constructor Detail

ChronicleContext

protected ChronicleContext(String url)

Protected constructor for creating a Chronicle context with the specified URL.

Parameters:

url - the URL for this context

ChronicleContext

protected ChronicleContext(String url,
                           SocketRegistry socketRegistry)

Protected constructor for creating a Chronicle context with the specified URL and socket registry.

Parameters:

url - the URL for this context

socketRegistry - the socket registry for this context

Method Detail

newContext

public static ChronicleContext newContext(String url)

Factory method for a new ChronicleContext

Parameters:

url - to connect to

Returns:

the new ChronicleContext

urlFor

public static URL urlFor(String spec)
                  throws net.openhft.chronicle.core.io.IORuntimeException

Parses a URL from a string, initializing any custom handlers as necessary.

This method supports "internal:" and "tcp:" URL schemas in addition to the standard schemas. If a URL starts with "internal:", a new Handler object is used as the URLStreamHandler. If a URL starts with "tcp:", a new tcp.Handler object is used as the URLStreamHandler. For other URL schemas, no custom URLStreamHandler is used.

Parameters:

spec - the string to parse as a URL.

Returns:

the URL parsed from the string.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if the string cannot be parsed as a URL.

affinityLock

public net.openhft.affinity.AffinityLock affinityLock()

Returns:

an AffinityLock appropriate for this context Acquires an AffinityLock instance based on the affinity usage status of the context. If affinity usage is enabled, a lock is acquired without a specific tag. If affinity usage is disabled, a lock is acquired with a null tag.

useAffinity

public boolean useAffinity()

Retrieves the status of affinity usage in this context.

Returns:

true if affinity usage is enabled, false otherwise.

useAffinity

public ChronicleContext useAffinity(boolean useAffinity)

Sets the status of affinity usage in this context.

Parameters:

useAffinity - a boolean flag indicating whether to enable affinity usage.

Returns:

the current ChronicleContext instance, allowing for method chaining.

init

protected void init()

Initializes the context, specifically it creates a new SocketRegistry instance if one is not already set.

newChannelSupplier

public ChronicleChannelSupplier newChannelSupplier(ChannelHandler handler)
                                            throws net.openhft.chronicle.core.io.InvalidMarshallableException

Constructs a new ChronicleChannelSupplier object using the provided ChannelHandler and the settings from this context.

Parameters:

handler - the ChannelHandler to be used by the new ChronicleChannelSupplier.

Returns:

the newly created ChronicleChannelSupplier.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if there is an error during the validation of the header.

startNewGateway

public void startNewGateway()
                     throws net.openhft.chronicle.core.io.InvalidMarshallableException

Starts a new instance of ChronicleGatewayMain if one is not already instantiated for this context. Configures the new gateway with the context's current parameters and adds it to the list of closeable resources managed by the context.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an error during the creation or starting of the gateway.

addCloseable

public void addCloseable(net.openhft.chronicle.core.io.Closeable closeable)

Adds a Closeable resource to the context's internal set of resources. This resource will be closed when the context itself is closed.

Parameters:

closeable - the Closeable resource to add.

performClose

protected void performClose()

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 net.openhft.chronicle.core.io.SimpleCloseable

url

public URL url()

Retrieves the URL of this context. If the URL hasn't been initialized yet, this method initializes it.

Returns:

the URL for this context.

buffered

public boolean buffered()

Indicates whether buffering should be used in this context.

Returns:

true if buffering should be used, false otherwise.

buffered

public ChronicleContext buffered(boolean buffered)

Sets the buffering preference for this context. If true, buffering will be used.

Parameters:

buffered - a boolean representing the preference for buffering.

Returns:

this instance of ChronicleContext for method chaining.

socketRegistry

public SocketRegistry socketRegistry()

Retrieves the SocketRegistry associated with this context.

Returns:

the SocketRegistry for this context.

systemContext

public void systemContext(SystemContext systemContext)
                   throws net.openhft.chronicle.core.io.InvalidMarshallableException

Sets the system context for this context. The given system context will be deep copied to prevent modifications to the original SystemContext from affecting this context.

Parameters:

systemContext - the new system context to be set.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an error while performing a deep copy of the system context.

systemContext

public SystemContext systemContext()

Retrieves the current SystemContext for this process or remote host. If the system context is not set, a new SystemContext instance is created, deep copied, and returned.

Returns:

the current SystemContext for this process or remote host.

name

public ChronicleContext name(String name)

Sets the names space for the service. This can set the relative directory for example.

Parameters:

name - space of this context

Returns:

this

name

public String name()

Returns:

the name space of this context

toFile

public File toFile(String name)

Returns a new File instance for the given name space (sub-directory) within this context.

Parameters:

name - the name for the new File

Returns:

a new File instance

toString

public String toString()

Overrides:

toString in class Object

Returns:

the context in a YAML format

port

public int port()

Returns:

the port for the gateway, if it exists, otherwise the port from the URL