Package io.deephaven.client.impl

Class SessionImplConfig

java.lang.Object

io.deephaven.client.impl.SessionImplConfig

@Immutable
public abstract class SessionImplConfig
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SessionImplConfig.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEEPHAVEN_SESSION_BATCH
static final String	DEEPHAVEN_SESSION_BATCH_STACKTRACES
static final String	DEEPHAVEN_SESSION_CLOSE_TIMEOUT
static final String	DEEPHAVEN_SESSION_EXECUTE_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
SessionImplConfig()

Method Summary

Modifier and Type	Method	Description
String	authenticationTypeAndValue()
static SessionImplConfig.Builder	builder()
abstract DeephavenChannel	channel()
Duration	closeTimeout()	The Session and ConsoleSession close timeout.
final SessionImpl	createSession()	Equivalent to SessionImpl.create(this).
boolean	delegateToBatch()	Whether the Session implementation will implement a batch TableHandleManager.
Duration	executeTimeout()	The session execute timeout.
abstract ScheduledExecutorService	executor()
static SessionImplConfig	from(SessionConfig sessionConfig, io.grpc.ManagedChannel managedChannel, ScheduledExecutorService defaultScheduler)	A low level adapter from SessionConfig into SessionImplConfig.
boolean	mixinStacktrace()	Whether the default batch TableHandleManager will use mix-in more relevant stacktraces.
static SessionImplConfig	of(DeephavenChannel channel, ScheduledExecutorService scheduler, String authenticationTypeAndValue)

Methods inherited from class java.lang.Object

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

Field Details

DEEPHAVEN_SESSION_BATCH

public static final String DEEPHAVEN_SESSION_BATCH

See Also:

• Constant Field Values

DEEPHAVEN_SESSION_BATCH_STACKTRACES

public static final String DEEPHAVEN_SESSION_BATCH_STACKTRACES

See Also:

• Constant Field Values

DEEPHAVEN_SESSION_EXECUTE_TIMEOUT

public static final String DEEPHAVEN_SESSION_EXECUTE_TIMEOUT

See Also:

• Constant Field Values

DEEPHAVEN_SESSION_CLOSE_TIMEOUT

public static final String DEEPHAVEN_SESSION_CLOSE_TIMEOUT

See Also:

• Constant Field Values

Constructor Details

SessionImplConfig

public SessionImplConfig()

Method Details

builder

public static SessionImplConfig.Builder builder()

of

public static SessionImplConfig of(DeephavenChannel channel,
 ScheduledExecutorService scheduler,
 @Nullable @Named("authenticationTypeAndValue")
 String authenticationTypeAndValue)

from

public static SessionImplConfig from(SessionConfig sessionConfig,
 io.grpc.ManagedChannel managedChannel,
 ScheduledExecutorService defaultScheduler)

A low level adapter from SessionConfig into SessionImplConfig. Most callers should prefer to use the higher-level options encapsulated in SessionFactoryConfig.

Parameters:

sessionConfig - the session config

managedChannel - the managed channel

defaultScheduler - the scheduler to use when SessionConfig.scheduler() is empty

Returns:

the session impl config

executor

public abstract ScheduledExecutorService executor()

channel

public abstract DeephavenChannel channel()

authenticationTypeAndValue

@Default
@Redacted
public String authenticationTypeAndValue()

delegateToBatch

@Default
public boolean delegateToBatch()

Whether the Session implementation will implement a batch TableHandleManager. By default, is true. The default can be overridden via the system property "deephaven.session.batch".

Returns:

true if the session will implement a batch manager, false if the session will implement a serial manager

mixinStacktrace

@Default
public boolean mixinStacktrace()

Whether the default batch TableHandleManager will use mix-in more relevant stacktraces. By default, is false. The default can be overridden via the system property "deephaven.session.batch.stacktraces".

Returns:

true if the default batch manager will mix-in stacktraces, false otherwise

executeTimeout

@Default
public Duration executeTimeout()

The session execute timeout. By default, is PT1m. The default can be overridden via the system property "deephaven.session.executeTimeout".

Returns:

the session execute timeout

closeTimeout

@Default
public Duration closeTimeout()

The Session and ConsoleSession close timeout. By default, is PT5s. The default can be overridden via the system property "deephaven.session.closeTimeout".

Returns:

the close timeout

createSession

public final SessionImpl createSession()
                                throws InterruptedException

Equivalent to SessionImpl.create(this).

Returns:

the session

Throws:

InterruptedException - if the thread is interrupted

See Also:

• SessionImpl.create(SessionImplConfig)