SqlServer publishes a SqlLocalConnection instance for remote SQL clients. It is typically used together with SqlRemoteConnection when an application needs network access to an eXtremeDB database.
// ENUM
public enum SessionState { Wait, Active, Done, Canceled }
// Nested class OpenParameters
public class OpenParameters {
// Configuration Fields
public SqlLocalConnection conn;
public int port;
public int bufsize;
public int nThreads;
public int listenQueueSize;
public bool localDomain;
public Database.SSLParameters sslParameters;
public bool authenticationRequired;
public bool authorizationRequired;
public int interruptTimeout;
public String netInterface;
public int compressionLevel;
public bool protocolCompatibility;
public int maxWaitListLength;
// Constructor
public OpenParameters(SqlLocalConnection conn, int port);
}
// Nested class SessionInfo
public class SessionInfo {
public SessionState state;
public String peerAddr;
public int peerPort;
public SessionInfo(SessionState state, String peerAddr, int peerPort);
}
// Class SqlServer
public class SqlServer {
// Constructors
public SqlServer(SqlLocalConnection conn, int port, int bufsize);
public SqlServer(SqlLocalConnection conn, int port);
public SqlServer(OpenParameters op);
// Lifecycle Methods
public void start();
public void stop();
// Monitoring Methods
public SessionInfo[] getSessionsInfo();
}
Wait (idle), Active (processing query), Done (completed), or Canceled (terminated by client).true, the server uses local-domain transport instead of TCP when this transport is supported by the underlying platform. This is useful for local-only deployments.null for unencrypted connections.true, clients must provide valid credentials before executing queries. Requires user management setup.true, enables authorization checks for authenticated SQL sessions. This setting is typically used together with authenticationRequired.null, binds to all available interfaces.true, enables protocol compatibility mode for older remote SQL clients.0 keeps the default behavior without an explicit limit.bufsize=65536, nThreads=4, listenQueueSize=5, localDomain=false, authenticationRequired=false, authorizationRequired=false, interruptTimeout=100, compressionLevel=0, protocolCompatibility=false, and maxWaitListLength=0.SessionState enum).SqlLocalConnection, listening on the specified port and using the specified buffer size. The supplied local connection should stay connected until the server is stopped.OpenParameters. Use this constructor when SSL, authentication, protocol compatibility, binding options, or other server settings need to be customized.SqlLocalConnection.SessionInfo objects describing the client sessions currently known to the server. This method can be used for runtime monitoring and diagnostics.SqlServer instance is thread-safe for concurrent client access. However, the underlying SqlLocalConnection must remain dedicated to the server and not be used directly by application threads.stop() before disposing the associated database connection to ensure clean shutdown and prevent resource leaks.