INT-2932 TCP Connection Events - Doc and Polishing
INT-2932 - Reference Documentation INT-2941 - Add getter for Throwable - Add auto-startup to Parser, Endpoint (already in schema) - Add phase to schema, Parser (Schema changes are mostly indentation because the element now extends SmartLifecycleType).
This commit is contained in:
committed by
Gunnar Hillert
parent
8b476b2d76
commit
d059abf4d1
@@ -454,6 +454,34 @@
|
||||
Configuring a connection interceptor factory chain.
|
||||
</para>
|
||||
</section>
|
||||
<section id="tcp-events">
|
||||
<title>TCP Connection Events</title>
|
||||
<para>
|
||||
Beginning with version 3.0, changes to <interfacename>TcpConnection</interfacename>s
|
||||
are reported by <classname>TcpConnectionEvent</classname>s. <classname>TcpConnectionEvent</classname>
|
||||
is a subclass of <classname>ApplicationEvent</classname> and thus can
|
||||
be received by any <interfacename>ApplicationListener</interfacename> defined in
|
||||
the <interfacename>ApplicationContext</interfacename>.
|
||||
</para>
|
||||
<para>
|
||||
For convenience, a <code><int-ip:tcp-connection-event-inbound-channel-adapter/></code>
|
||||
is provided. This adapter will receive all <classname>TcpConnectionEvent</classname>s (by
|
||||
default), and send them to its <code>channel</code>. The adapter accepts an <code>event-type</code>
|
||||
attribute, which is a list of class names for events that should be sent. This can be used
|
||||
if an application subclasses <classname>TcpConnectionEvent</classname> for some reason, and wishes
|
||||
to only receive those events. Omitting this attribute will mean that all
|
||||
<classname>TcpConnectionEvent</classname>s will be sent.
|
||||
</para>
|
||||
<para>
|
||||
<classname>TcpConnectionEvents</classname> contain:
|
||||
<itemizedlist>
|
||||
<listitem>Event type (OPEN, CLOSE, EXCEPTION)</listitem>.
|
||||
<listitem>Connection Id (which can be used in a message header to send data to the connection)</listitem>
|
||||
<listitem>Connection Factory Name (the bean name of the connection factory the connection belongs to)</listitem>
|
||||
<listitem>The <classname>Throwable</classname> (for EXCEPTION event types only)</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
</section>
|
||||
<section id="tcp-adapters">
|
||||
<title>TCP Adapters</title>
|
||||
<para>
|
||||
|
||||
@@ -31,8 +31,8 @@
|
||||
been renamed to <classname>TcpConnectionInterceptorSupport</classname>.
|
||||
</para>
|
||||
<para>
|
||||
In addition, a new <code><int-ip:tcp-connection-event-channel-adapter/></code>
|
||||
is provided; by default, this adapter sends all <classname>TcpConnectionEvents</classname>
|
||||
In addition, a new <code><int-ip:tcp-connection-event-inbound-channel-adapter/></code>
|
||||
is provided; by default, this adapter sends all <classname>TcpConnectionEvent</classname>s
|
||||
to a <interfacename>Channel</interfacename>.
|
||||
</para>
|
||||
<para>
|
||||
@@ -47,9 +47,7 @@
|
||||
to explicitly close a connection using its ID.
|
||||
</para>
|
||||
<para>
|
||||
Further documentation for these features will follow; for now, refer to the
|
||||
schema documentation for information about the new adapter, and JavaDocs for
|
||||
it as well as the other features.
|
||||
For more information see <xref linkend="tcp-events"/>.
|
||||
</para>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
Reference in New Issue
Block a user