TcpServer (H2 Database Engine 2.0.0 API)

java.lang.Object
- org.h2.server.TcpServer

所有已实现的接口:

Service
```
public class TcpServer
extends Object
implements Service
```
The TCP server implements the native H2 database server protocol. It supports multiple client connections to multiple databases (many to many). The same database may be opened by multiple clients. Also supported is the mixed mode: opening databases in embedded mode, and at the same time start a TCP server to allow clients to connect to the same database over the network.

构造器概要

构造器
构造器和说明

TcpServer()

构造器
构造器和说明
`TcpServer()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`String`	`checkKeyAndGetDatabaseName(String db)` If no key is set, return the original database name.
`boolean`	`getAllowOthers()` Check if remote connections are allowed.
`static String`	`getManagementDbName(int port)` Get the database name of the management database.
`String`	`getName()` Get the human readable name of the service.
`int`	`getPort()` Gets the port this service is listening on.
`boolean`	`getSSL()` Returns whether a secure protocol is used.
`String`	`getType()` Get the human readable short name of the service.
`String`	`getURL()` Get the URL of this service in a human readable form
`void`	`init(String... args)` Initialize the service from command line options.
`boolean`	`isDaemon()` Check if a daemon thread should be used.
`boolean`	`isRunning(boolean traceError)` Check if the service is running.
`void`	`listen()` Listen for incoming connections.
`void`	`setShutdownHandler(ShutdownHandler shutdownHandler)`
`static void`	`shutdown(String url, String password, boolean force, boolean all)` Stop the TCP server with the given URL.
`void`	`start()` Start the service.
`void`	`stop()` Stop the service.
`static void`	`stopServer(int port, String password, int shutdownMode)` Stop a running server.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - TcpServer
```
public TcpServer()
```
- 方法详细资料
  - getManagementDbName
```
public static String getManagementDbName(int port)
```
    Get the database name of the management database. The management database contains a table with active sessions (SESSIONS).
    
    参数:
    
    port - the TCP server port
    
    返回:
    
    the database name (usually starting with mem:)
  - setShutdownHandler
```
public void setShutdownHandler(ShutdownHandler shutdownHandler)
```
  - init
```
public void init(String... args)
```
    从接口复制的说明: Service
    
    Initialize the service from command line options.
    
    指定者:
    
    init 在接口中 Service
    
    参数:
    
    args - the command line options
  - getURL
```
public String getURL()
```
    从接口复制的说明: Service
    
    Get the URL of this service in a human readable form
    
    指定者:
    
    getURL 在接口中 Service
    
    返回:
    
    the url
  - getPort
```
public int getPort()
```
    从接口复制的说明: Service
    
    Gets the port this service is listening on.
    
    指定者:
    
    getPort 在接口中 Service
    
    返回:
    
    the port
  - getSSL
```
public boolean getSSL()
```
    Returns whether a secure protocol is used.
    
    返回:
    
    true if SSL socket is used, false if plain socket is used
  - start
```
public void start()
           throws SQLException
```
    从接口复制的说明: Service
    
    Start the service. This usually means create the server socket. This method must not block.
    
    指定者:
    
    start 在接口中 Service
    
    抛出:
    
    SQLException - on failure
  - listen
```
public void listen()
```
    从接口复制的说明: Service
    
    Listen for incoming connections. This method blocks.
    
    指定者:
    
    listen 在接口中 Service
  - isRunning
```
public boolean isRunning(boolean traceError)
```
    从接口复制的说明: Service
    
    Check if the service is running.
    
    指定者:
    
    isRunning 在接口中 Service
    
    参数:
    
    traceError - if errors should be written
    
    返回:
    
    if the server is running
  - stop
```
public void stop()
```
    从接口复制的说明: Service
    
    Stop the service.
    
    指定者:
    
    stop 在接口中 Service
  - stopServer
```
public static void stopServer(int port,
                              String password,
                              int shutdownMode)
```
    Stop a running server. This method is called via reflection from the STOP_SERVER function.
    
    参数:
    
    port - the port where the server runs, or 0 for all running servers
    
    password - the password (or null)
    
    shutdownMode - the shutdown mode, SHUTDOWN_NORMAL or SHUTDOWN_FORCE.
  - getAllowOthers
```
public boolean getAllowOthers()
```
    从接口复制的说明: Service
    
    Check if remote connections are allowed.
    
    指定者:
    
    getAllowOthers 在接口中 Service
    
    返回:
    
    true if remote connections are allowed
  - getType
```
public String getType()
```
    从接口复制的说明: Service
    
    Get the human readable short name of the service.
    
    指定者:
    
    getType 在接口中 Service
    
    返回:
    
    the type
  - getName
```
public String getName()
```
    从接口复制的说明: Service
    
    Get the human readable name of the service.
    
    指定者:
    
    getName 在接口中 Service
    
    返回:
    
    the name
  - shutdown
```
public static void shutdown(String url,
                            String password,
                            boolean force,
                            boolean all)
                     throws SQLException
```
    Stop the TCP server with the given URL.
    
    参数:
    
    url - the database URL
    
    password - the password
    
    force - if the server should be stopped immediately
    
    all - whether all TCP servers that are running in the JVM should be stopped
    
    抛出:
    
    SQLException - on failure
  - checkKeyAndGetDatabaseName
```
public String checkKeyAndGetDatabaseName(String db)
```
    If no key is set, return the original database name. If a key is set, check if the key matches. If yes, return the correct database name. If not, throw an exception.
    
    参数:
    
    db - the key to test (or database name if no key is used)
    
    返回:
    
    the database name
    
    抛出:
    
    DbException - if a key is set but doesn't match
  - isDaemon
```
public boolean isDaemon()
```
    从接口复制的说明: Service
    
    Check if a daemon thread should be used.
    
    指定者:
    
    isDaemon 在接口中 Service
    
    返回:
    
    true if a daemon thread should be used

类 TcpServer

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

TcpServer

方法详细资料

getManagementDbName

setShutdownHandler

init

getURL

getPort

getSSL

start

listen

isRunning

stop

stopServer

getAllowOthers

getType

getName

shutdown

checkKeyAndGetDatabaseName

isDaemon