diff --git a/modules/proto_hep/doc/proto_hep_admin.xml b/modules/proto_hep/doc/proto_hep_admin.xml index c67b0312d1f..afb9f760ae3 100644 --- a/modules/proto_hep/doc/proto_hep_admin.xml +++ b/modules/proto_hep/doc/proto_hep_admin.xml @@ -330,6 +330,75 @@ modparam("proto_hep", "hep_async_local_write_timeout", 100) + +
+ <varname>use_single_process</varname> (integer) + + The use_single_process parameter controls whether the HEP message processing is + handled by the SIP worker that is processing the message or by a dedicated HEP worker process. + When this parameter is set to 1, the HEP worker process is created to handle all HEP message + transmissions. This allows OpenSIPS to offload HEP transmissions to a separate process, freeing up the SIP workers. + + + In this case, the HEP worker process will queue the unsent HEP messages and attempt to send them periodically. + If the messages cannot be sent, they are retained in a job list that can be configured through the + max_number_of_jobs and max_keep_time_job parameters. + + + Set <varname>use_single_process</varname> parameter + +... +modparam("proto_hep", "use_single_process", 1) +... + + +
+ + +
+ <varname>max_number_of_jobs</varname> (integer) + + The max_number_of_jobs parameter defines the maximum number of HEP message jobs that can be stored in + the job list. When the number of jobs in the list exceeds this value, the oldest job is removed to make space for the + new incoming job. + + + The default value for this parameter is 1000000, but it can be adjusted based on system resources + and user preferences. + + + Set <varname>max_number_of_jobs</varname> parameter + +... +modparam("proto_hep", "max_number_of_jobs", 2000000) +... + + +
+ + + +
+ <varname>max_keep_job_time</varname> (integer) + + The max_keep_job_time parameter defines the maximum time (in seconds) that a job can remain in the + job list before it is automatically removed. + + + The default value for this parameter is 1800 seconds. + + + Set <varname>max_keep_job_time</varname> parameter + +... +modparam("proto_hep", "max_keep_job_time", 100) +... + + +
+ + +