Overview of glsnr
glsnr is a listener which GOLDILOCKS enables remote access through the network in the client/ server environment. glsnr should be run on the server for the network access to GOLDILOCKS.
glsnr is used as follows.
$ glsnr [options]
Command Options
The followings are cell prompt options for using glsnr.
--silent
Description
It does not display the message for execution.
Example
$ glsnr --start --silent
--start
Description
It starts running glsnr. If glsnr is already running, an error occurs.
Example
$ glsnr --start Listener is started successfully.
--stop
Description
It stops the currently running glsnr.
Example
$ glsnr --stop Listener is stopped.
--status
Description
It displays the message about glsnr status.
Example
$ glsnr --status Listener is not running. $ glsnr --start Listener is started successfully. $ glsnr --status Listener process ID : 27880 Listener configuration file : /home/goldilocks/goldilocks_home/conf/goldilocks.listener.conf Unix Domain Path : /tmp/unix-glsnr.22581 TCP Listen Host : 0.0.0.0, Port : 22581 default C/S mode : Dedicated Connection Timeout(second) : 100 Listener is running.
--home
Description
It sets db home.
Example
$ glsnr --start --home Gliese/home/g1n1_home Listener is started successfully. $ glsnr --status Listener process ID : 20777 Listener configuration file : /home/goldilocks/Gliese/home/g1n1_home/conf/goldilocks.listener.conf Unix Domain Path : /tmp/unix-glsnr.22581 TCP Listen Host : 0.0.0.0, Port : 22581 default C/S mode : Dedicated Connection Timeout(second) : 100 Listener is running.
--help
Description
It displays the help message.
Example
$ glsnr --help Usage: glsnr [options] Options: --silent don't print message --start start listener --stop stop listener --status show listener status --help show listner help messages
Listener Configuration
Configuration File and Environment Variables
glsnr uses the configuration file or environment variables for setting the configuration.
The environment variable is specified by using the name which 'GOLDILOCKS_' is added to the property name of the configuration as a prefix. For example, setting the LISTEN_PORT in configuration file is as same as specifying $GOLDILOCKS_LISTEN_PORT.
The contents of configuration file precedes the environment variable settings. (In other words, environment variables are applied only if the configuration file is not set.)
The environment file of glsnr is $GOLDILOCKS_DATA/conf/goldilocks.listener.conf. If the corresponding file is changed or the environment variables are set and glsnr is started to run, then the glsnr driving environment is modified.
If a user want to modify and apply the glsnr environment during running glsnr, a user should stop glsnr and change the content of configuration file or set the environment variable and then restart glsnr.
If a user stops the glsnr, a problem does not occur for the client which is already connected, but the problem occurs when being connected from a new client.
LISTEN_PORT
It is the port on which the glsnr waits for the connection.
Item | Description |
|---|---|
Name | LISTEN_PORT |
Description | It is the port on which the glsnr waits for a connection. |
Data type | INT |
Default value/ range | 22581 / 1024 ~ 49151 |
Description
The client who wants a TCP connection should try to connect to the specified port. The port is available from 1024 to 49151.
TCP_HOST
It is an IP address of NIC of which glsnr waits for the connection.
Item | Description |
|---|---|
Name | TCP_HOST |
Description | It is the IP address which the glsnr binds. |
Data type | ip address |
Default value | 0.0.0.0 |
Description
The client who wants a TCP connection should access the IP address specified above. The IP address is used in IPv4 or IPv6 format.
BACKLOG
It is the number of clients which the glsnr can handle when multiple clients simultaneously access.
Item | Description |
|---|---|
Name | BACKLOG |
Description | It is the number of client of which glsnr waits for the connection. |
Data type | INT |
Default value/ range | 1024 / 1 ~ 32768 |
Description
This setting value does not guarantee the number of concurrent connector of the client.
DEFAULT_CS_MODE
It sets the access mode when the access mode is not designated as dedicated or shared on the client.
Item | Description |
|---|---|
Name | DEFAULT_CS_MODE |
Description | It sets the default access mode. |
Data type | String ( dedicated | shared ) |
Default value | dedicated |
Description
The client/ server mode connected via glsnr supports two modes, which are dedicated and shared.
Generally, the access mode is set as dedicated or shared on the client (It is .odbcini for ODBC), then it accesses. However, if it is not set on the client, the access mode is determined by setting DEFAULT_CS_MODE.
TCP_VALIDNODE_CHECKING
It sets whether to check the validity of the client attempting to access.
Item | Description |
|---|---|
Name | TCP_VALIDNODE_CHECKING |
Description | It sets whether to check the client validity. |
Data type | String ( NO | INVITED | EXCLUDED ) |
Default value | NO |
Description
If the value is set to NO, the client validity is not checked.
If the value is set to INVITED and the file set in TCP_INVITED_FILE exists, then only the client having the IP address of the file set in TCP_INVITED_FILE is set to be valid.
If the value is set to EXCLUDED and the file set in TCP_EXCLUDED_FILE exists, then only the client excluding the client who has IP address of the file set in TCP_EXCLUDED_FILE is set to be valid.
TCP_INVITED_FILE
It is used only when the value of TCP VALIDNODE_CHECKING is INVITED.
Item | Description |
|---|---|
Name | TCP_INVITED_FILE |
Description | It is the file with the valid user (IP address) list. |
Data type | String |
Default value | 'goldilocks.invited.conf' |
Description
If the set file exists, only the user (IP address) within the file is allowed to access.
TCP_EXCLUDED_FILE
It is used only when the value of TCP VALIDNODE_CHECKING is EXCLUDED.
Item | Description |
|---|---|
Name | TCP_EXCLUDED_FILE |
Description | It is the file with the invalid user (IP address) list. |
Data type | String |
Default value | 'goldilocks.excluded.conf' |
Description
If the set file exists, anyone except for the user (IP address) within the file is allowed to access.
TIMEOUT
It is the glsnr timeout value and its unit is second.
Item | Description |
|---|---|
Name | TIMEOUT |
Description | glsnr timeout |
Data type | INT |
Default value/ range | 100 / ( 0 ~ 2147483647 ) |
Description
If the response is too slow or there is not a response from the client when glsnr communicates with the client, the connection is released by the specified timeout.
LISTENER_LOG_DIR
It sets the directory which stores the log to be display from the glsnr.
Item | Description |
|---|---|
Name | LISTENER_LOG_DIR |
Description | It sets the directory which stores the log of the glsnr. |
Data type | String |
Default value | '<GOLDILOCKS_DATA>/trc' |
Description
<GOLDILOCKS_DATA> of the setting value is replaced with the value of the environment variable $GOLDILOCKS_DATA.
UDS_DIR
It sets the directory in which the Unix Domain Socket file used in glsnr is stored.
Item | Description |
|---|---|
Name | UDS_DIR |
Description | It sets the directory in which the Unix Domain Socket file used in glsnr is stored. |
Data type | String |
Default value/ range | '/tmp' / Maximum 60 byte |
Description
The maximum length of the directory should be set within 60 bytes. The absolute path of the Unix Domain Socket file (directory name + file name) depends on OS, but usually it is around 100 bytes.