Configuring, Starting, and Stopping the Server Executable

There are two ways to start an ObjectStore Component Server:

From the command line, with the executable ostccompsrvr. The Server runs until the process is killed.
From a program, with the function ostc_ApplicationServer::start(). The Server runs until stopped with ostc_ApplicationServer::~ostc_ApplicationServer().

Using ostccompsrvr

The Component Server is ostccompsrvr.exe on Windows NT and ostccompsrvr on UNIX platforms. The Server executable takes the following command-line switches:

-plugin library_name Plug-in library name. This parameter is required and must be the full library name. For Servers that support multiple plug-ins, specify this switch multiple times. ostc_MissingLib is thrown if the library could not be loaded. ostc_RequiredParmMissing is thrown if this switch is not supplied.
-service component_name Logical component name used to match clients to Servers. This parameter is required. ostc_RequiredParmMissing is thrown if this switch is not supplied.
-port port_number Port number of the Server. This parameter is required. ostc_RequiredParmMissing is thrown if this switch is not supplied.
-threads number_of_threads Maximum number of threads that can concurrently handle requests in the Server. This parameter defaults to 1 for isolated_update Servers and 10 for all other Servers.
-txntype txn_type Transaction type of operations supported by this Server. This parameter is required, and must be one of the following: read, mvccRead, shared_update, isolated_update, or none. Note that you must start at least one Server for each transaction type of operations supported by the specified components. ostc_RequiredParmMissing is thrown if this switch is not supplied.
-routedata routing_string Routing string. If a client specifies a routing string when issuing a request, the request is routed to a Server with a matching string. The comparison is made with memcmp().
-routerhost host:port_number Network address for a system router. If this parameter is not specified, the Server being started acts as a router. Routers distribute requests among those Servers that have the appropriate service, transaction type, and routing data. You can supply this switch multiple times.
-routerfile file_name File used by router to maintain routes persistently, in case of failures or restarts.
-inctimeout timeout_in_seconds Timeout for access to incremental object sets on the Server. If the set is not accessed in the amount of time specified, the Server discards it. This parameter defaults to 1800 seconds.
-boundtimeout timeout_in_seconds Timeout for access to a running bound transaction. If a bound transaction is started but is not being used, it will abort when this timeout is exceeded. This is used to keep the server from hanging if the client fails in the middle of a bound transaction. This parameter defaults to 10 seconds.
-sharedtimeout timeout_in_seconds Timeout for access to a shared transaction. Shared transactions commit after a certain number of requests complete or this timeout is exceeded, whichever comes first. This parameter defaults to five seconds.
-sharedmaxops number_of_ops Maximum shared operations. This sets the number of requests that can use a shared transaction before a commit occurs. This parameter is ignored for isolated_update Servers. This parameter defaults to 10.
-logging Turns on Server logging. With logging on, the server writes information to the file ostcserver.log in the directory from which the Server was executed. Logging is off by default.

-plugin library_name	Plug-in library name. This parameter is required and must be the full library name. For Servers that support multiple plug-ins, specify this switch multiple times. ostc_MissingLib is thrown if the library could not be loaded. ostc_RequiredParmMissing is thrown if this switch is not supplied.
-service component_name	Logical component name used to match clients to Servers. This parameter is required. ostc_RequiredParmMissing is thrown if this switch is not supplied.
-port port_number	Port number of the Server. This parameter is required. ostc_RequiredParmMissing is thrown if this switch is not supplied.
-threads number_of_threads	Maximum number of threads that can concurrently handle requests in the Server. This parameter defaults to 1 for isolated_update Servers and 10 for all other Servers.
-txntype txn_type	Transaction type of operations supported by this Server. This parameter is required, and must be one of the following: read, mvccRead, shared_update, isolated_update, or none. Note that you must start at least one Server for each transaction type of operations supported by the specified components. ostc_RequiredParmMissing is thrown if this switch is not supplied.
-routedata routing_string	Routing string. If a client specifies a routing string when issuing a request, the request is routed to a Server with a matching string. The comparison is made with memcmp().
-routerhost host:port_number	Network address for a system router. If this parameter is not specified, the Server being started acts as a router. Routers distribute requests among those Servers that have the appropriate service, transaction type, and routing data. You can supply this switch multiple times.
-routerfile file_name	File used by router to maintain routes persistently, in case of failures or restarts.
-inctimeout timeout_in_seconds	Timeout for access to incremental object sets on the Server. If the set is not accessed in the amount of time specified, the Server discards it. This parameter defaults to 1800 seconds.
-boundtimeout timeout_in_seconds	Timeout for access to a running bound transaction. If a bound transaction is started but is not being used, it will abort when this timeout is exceeded. This is used to keep the server from hanging if the client fails in the middle of a bound transaction. This parameter defaults to 10 seconds.
-sharedtimeout timeout_in_seconds	Timeout for access to a shared transaction. Shared transactions commit after a certain number of requests complete or this timeout is exceeded, whichever comes first. This parameter defaults to five seconds.
-sharedmaxops number_of_ops	Maximum shared operations. This sets the number of requests that can use a shared transaction before a commit occurs. This parameter is ignored for isolated_update Servers. This parameter defaults to 10.
-logging	Turns on Server logging. With logging on, the server writes information to the file ostcserver.log in the directory from which the Server was executed. Logging is off by default.

ostc_InvalidParm is thrown if a parameter name appears without an associated parameter value.

Example

ostccompsrvr.exe \
      -plugin my_plugin.dll \
      -port 2090 \
      -txntype read \
      -service test \
      -inctimeout 60

Server processes started from the command line run until you kill them with an operating system command.

Creating a Custom Component Server

You can create a custom component server that manages configuration, start-up, and shutdown of ObjectStore Component Servers with members of the class ostc_ApplicationServer.

Debug Version

ostccmpsrvrd is the debug version of ostccompsrvr. Use this when debugging components.

[previous] [next]