[jboss-cvs] JBossRemoting/docs/guide/en ...
Ron Sigal
ron_sigal at yahoo.com
Wed Mar 7 01:35:02 EST 2007
User: rsigal
Date: 07/03/07 01:35:02
Modified: docs/guide/en Tag: remoting_2_x chap5.xml
Log:
JBREM-634: Added new CallbackPoller parameters to "Configuration by properties" section.
Revision Changes Path
No revision
No revision
1.12.2.4 +19 -11 JBossRemoting/docs/guide/en/chap5.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: chap5.xml
===================================================================
RCS file: /cvsroot/jboss/JBossRemoting/docs/guide/en/chap5.xml,v
retrieving revision 1.12.2.3
retrieving revision 1.12.2.4
diff -u -b -r1.12.2.3 -r1.12.2.4
--- chap5.xml 7 Mar 2007 06:05:02 -0000 1.12.2.3
+++ chap5.xml 7 Mar 2007 06:35:02 -0000 1.12.2.4
@@ -1585,7 +1585,7 @@
responds with an error, can add config to the configuration map passed
to the <code>Client.invoke()</code> method where they key is
<code>HTTPMetadataConstants.NO_THROW_ON_ERROR</code> (actual text value
- 'NoThrowOnError') and a value of type java.lang.String set to 'true'.
+ 'NoThrowOnError') and a value of of type java.lang.String set to 'true'.
This will cause the http client invoker to not throw an exception, but
instead return the data from the web server error stream. In the case
that the data returned from this error stream is of type
@@ -2969,9 +2969,7 @@
</para>
<para>
- The persistence policy indicates at what point the server has too little free
- memory available and therefore the callback message should be put into a
- persistent store. This policy can be configured via the
+ The persistence policy indicates at what point the server has too little free memory available and therefore the callback message should be put into a persistent store. This policy can be configured via the
<code>memPercentCeiling</code> attribute (see more on configuring this
below).</para>
@@ -3103,7 +3101,7 @@
<attribute name="Configuration">
<config>
<invoker transport="socket">
- <attribute name="callbackStore">org.jboss.remoting.callback.CallbackStore</attribute>
+ <attribute name="callbackStore">org.jboss.remoting.CallbackStore</attribute>
<attribute name="callbackMemCeiling">30</attribute>
</invoker>
<handlers>
@@ -3120,7 +3118,7 @@
and declaration of CallbackStore as service:</para>
<programlisting>
- <mbean code="org.jboss.remoting.callback.CallbackStore"
+ <mbean code="org.jboss.remoting.CallbackStore"
name="jboss.remoting:service=CallbackStore,type=Serializable"
display-name="Persisted Callback Store">
@@ -3162,7 +3160,7 @@
<attribute name="Configuration">
<config>
<invoker transport="socket">
- <attribute name="callbackStore">org.jboss.remoting.callback.CallbackStore</attribute>
+ <attribute name="callbackStore">org.jboss.remoting.CallbackStore</attribute>
<attribute name="StoreFilePath">callback</attribute>
<attribute name="StoreFileSuffix">cst</attribute>
</invoker>
@@ -4982,17 +4980,27 @@
<para><emphasis role="bold">CALLBACK_POLL_PERIOD</emphasis> (actual value
is 'callbackPollPeriod') - key for setting the frequency (in milliseconds)
in which Client's internal callback poller should poll server for waiting
- callbacks. This configuration is only necessary when using one of the
+ callbacks. The default value is five seconds.</para>
+
+ <para>
+ <emphasis role="bold">CALLBACK_SCHEDULE_MODE</emphasis> (actual value is "scheduleMode"): may be set to either <code>CallbackPoller.SCHEDULE_FIXED_RATE</code> (actual value "scheduleFixedRate") or <code>CallbackPoller.SCHEDULE_FIXED_DELAY</code> (actual value "scheduleFixedDelay"). In either case, polling will take place at approximately regular intervals, but in the former case the scheduler will attempt to perform each poll CALLBACK_POLL_PERIOD milliseconds after the previous attempt, and in the latter case the scheduler will attempt to schedule polling so that the <emphasis>average</emphasis> interval will be approximately CALLBACK_POLL_PERIOD milliseconds. <code>CallbackPoller.SCHEDULE_FIXED_RATE</code> is the default.
+ </para>
+
+ <para>
+ <emphasis role="bold">REPORT_STATISTICS</emphasis> (actual value is "reportStatistics"): The presence of this key in <code>metadata</code>, regardless of its value, will cause the <classname>CallbackPoller</classname> to print statistics that might be useful for configuring the other parameters..
+ </para>
+
+ <para><classname>CallbackPoller</classname>
+ configuration is only necessary when using one of the
following Client methods:</para>
<programlisting>public void addListener(InvokerCallbackHandler callbackhandler, Map metadata, Object callbackHandlerObject) throws Throwable
public void addListener(InvokerCallbackHandler callbackhandler, Map metadata, Object callbackHandlerObject, boolean serverToClient) throws Throwable</programlisting>
- <para>and should be one of the entries in the metadata Map passed. This
+ <para>The keys should be among the entries in the metadata Map passed. This
will also only apply when the underlying transport is uni-directional
(e.g. socket, http, rmi). Bi-directional transports will not need to poll.
- If this property is not set, the default (see
- CallbackPoller.DEFAULT_POLL_PERIOD) value is five seconds.</para>
+ </para>
<para></para>
More information about the jboss-cvs-commits
mailing list