new

Constructor. Parameters to configure the server:

• TYPE - (Str) "Fork" or "PreFork", default: "Fork"
• SILENT - (Bool) silent startup with start-stop-daemons during System V init
• NODETACH - (Bool) run the parent process in foreground (i.e. no daemon)

start

Start the server process. This method never returns.

process_request

is the function which is called by Net::Server to make the work. The only parameter is the class instance. The communication is handled via STDIN and STDOUT.

The class selects the user interfaces and checks the pre-initialized variables. If all of this is fine then the user interface will be initialized and started.

do_process_request

does the actual work of process_request: determines transport, serialization and service from the user input and calls the init() and run() methods on the corresponding service. It also does some housekeeping such as setting permissions, setting the process name, etc.

post_bind_hook

Is executed (by Net::Server) just after the bind process and just before any chrooting, change of user, or change of group occurs. Changes the socket ownership based on the configuration.

pre_loop_hook

Drops privileges to the user configured in the configuration file just before starting the main server loop. Also starts the Watchdog process.

command

is normal layer stack where the user interfaces can execute commands.

Server Configuration

__redirect_stderr

Send all messages to STDERR directly to a file. The file is specified in the XML configuration.

__init_user_interfaces

Initialize the supported user interfaces (i.e. load classes).

__get_server_config

Prepares the complete server configuration to startup a socket based server with Net::Server::Fork. It returns a hashref.

__set_process_name

Set the process name that is visible via e.g. ps.

Values used inside OpenXPKI (for easy reference):

server

Initial value of all childs, remains for the main server process

watchdog

The watchdog process

worker: init

PreForked child before its first usage

worker: connecting

Worker handling a connection (if the worker stays in this state its likely that the connection attempt failed and the worker is send back to the pool)

worker: connected

Connected to a client, waiting for a session to be started

worker: <User> (<Role>)

Connected to a client with active session as User/Role

workflow: id <id> (<state>)

Worker currently handling a workflow.

worker: wfc

Worker after finishing a request, back in the pool