Skip to content

Commit a8bda7e

Browse files
committed
Added documentation for content file pool
1 parent 2339886 commit a8bda7e

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

src/main/xar-resources/data/configuration/configuration.xml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,9 @@
6565
<listitem>
6666
<para><tag>xupdate</tag>: Configuration options related to XUpdate processing.</para>
6767
</listitem>
68+
<listitem>
69+
<para><tag>rpc-server</tag>: Configuration options related to RPC result pooling.</para>
70+
</listitem>
6871
</orderedlist>
6972
<para>The following sections describe the most commonly modified of the above elements,
7073
including how to change the default behavior of eXist-db's handling of whitespace
@@ -994,6 +997,62 @@
994997
</sect3>
995998
</sect2>
996999

1000+
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
1001+
1002+
<sect2 xml:id="rpc-server">
1003+
<title> <tag>rpc-server</tag> element </title>
1004+
1005+
<para>Defines the RPC server backend specific options used to process the requests and caching
1006+
result values.</para>
1007+
1008+
<sect3 xml:id="content-file">
1009+
<title> <tag>rpc-server</tag>/<tag>content-file</tag> element</title>
1010+
1011+
<para>This element configures the maximum amount of data held in the HEAP space before
1012+
the data is moved to the temporary disk space. While using memory improves the performance
1013+
and not triggering eventually existing virus scanners it comes with the cost of HEAP size usage.
1014+
The location, size and other parameters for this file can be set using the
1015+
<tag>content-file</tag> element.</para>
1016+
<para> <tag>content-file</tag> Attributes:</para>
1017+
<variablelist>
1018+
<varlistentry>
1019+
<term> <code>max-in-memory-size</code> </term>
1020+
<listitem>
1021+
<para>Defines the maximum in memory hold data before storing on temporary disk space.</para>
1022+
</listitem>
1023+
</varlistentry>
1024+
</variablelist>
1025+
</sect3>
1026+
1027+
<sect3 xml:id="content-file-pool">
1028+
<title> <tag>rpc-server</tag>/<tag>content-file-pool</tag> element</title>
1029+
1030+
<para>This element configures the pool used to hold the content file entries in order to reuse the once
1031+
initialized instances to further improve the performance and to limit the amount of used HEAP size.
1032+
To calculate the maximum size of used memory the maximum in memory size of a single content file has
1033+
to be multiplied by the size of the pool.
1034+
The location, size and other parameters for this file can be set using the
1035+
<tag>content-file-pool</tag> element.</para>
1036+
<para> <tag>content-file</tag> Attributes:</para>
1037+
<variablelist>
1038+
<varlistentry>
1039+
<term> <code>size</code> </term>
1040+
<listitem>
1041+
<para>Specifies the maximum amount of content file objects that can be in use concurrently.</para>
1042+
</listitem>
1043+
</varlistentry>
1044+
<varlistentry>
1045+
<term> <code>max-idle</code> </term>
1046+
<listitem>
1047+
<para>Defines the maximum amount of idle pool entries that will not be removed for later reuse.</para>
1048+
</listitem>
1049+
</varlistentry>
1050+
</variablelist>
1051+
</sect3>
1052+
1053+
</sect2>
1054+
1055+
9971056
</sect1>
9981057

9991058
<!-- ================================================================== -->

0 commit comments

Comments
 (0)