Skip to main content
aboutsummaryrefslogblamecommitdiffstats
blob: 3bf6dee7a566242b2227fa371f7e0b307f61c708 (plain) (tree)










































                                                                                                                                                         














































                                                                                                                                                          























                                                                                                                                                                                                      



















































































                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           
                                                      






                                                                                                                                                                      












                                                                                             




















                                                                                                                                                         







































                                                                                                                                                          
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>

<TITLE>
org.eclipse.net4j (Net4j Signalling Platform Documentation)
</TITLE>

<META NAME="date" CONTENT="">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="org.eclipse.net4j (Net4j Signalling Platform Documentation)";
    }
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();">
<HR>


<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV PACKAGE&nbsp;
&nbsp;<A HREF="../../../org/eclipse/net4j/acceptor/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?org/eclipse/net4j/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->

<HR>
<H2>
Package org.eclipse.net4j
</H2>
The Net4j transport layer.
<P>
<B>See:</B>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
<P>

<map id="APIVIZ" name="APIVIZ">
<area shape="rect" id="node1" href="ContainerProtocolProvider.Client.html" title="ContainerProtocolProvider.Client" alt="" coords="444,671,652,697"/>
<area shape="rect" id="node2" href="ContainerProtocolProvider.Server.html" title="ContainerProtocolProvider.Server" alt="" coords="443,721,653,746"/>
<area shape="rect" id="node3" href="FactoriesProtocolProvider.html" title="FactoriesProtocolProvider" alt="" coords="240,647,411,673"/>
<area shape="rect" id="node4" href="TransportConfigurator.html" title="TransportConfigurator" alt="" coords="34,609,179,634"/>
<area shape="rect" id="node5" href="TransportInjector.html" title="TransportInjector" alt="" coords="266,545,385,570"/>
<area shape="rect" id="node6" href="ContainerProtocolProvider.html" title="ContainerProtocolProvider" alt="" coords="239,697,411,722"/>
<area shape="rect" id="node7" href="channel/IChannel.html" title="&#171;interface&#187; IChannel (org.eclipse.net4j.channel)" alt="" coords="238,309,413,363"/>
<area shape="rect" id="node8" href="channel/IChannelMultiplexer.html" title="&#171;interface&#187; IChannelMultiplexer (org.eclipse.net4j.channel)" alt="" coords="238,387,413,442"/>
<area shape="rect" id="node9" title="&#171;interface&#187; IElementProcessor (org.eclipse.net4j.util.container)" alt="" coords="5,530,208,585"/>
<area shape="rect" id="node10" href="ILocationAware.html" title="&#171;interface&#187; ILocationAware" alt="" coords="51,395,162,435"/>
<area shape="rect" id="node11" title="&#171;interface&#187; INegotiatorAware (org.eclipse.net4j.util.security)" alt="" coords="9,237,205,291"/>
<area shape="rect" id="node12" href="protocol/IProtocol.html" title="&#171;interface&#187; IProtocol (org.eclipse.net4j.protocol)" alt="" coords="238,466,413,521"/>
<area shape="rect" id="node13" href="protocol/IProtocolProvider.html" title="&#171;interface&#187; IProtocolProvider (org.eclipse.net4j.protocol)" alt="" coords="19,658,194,713"/>
<area shape="rect" id="node14" href="ITransportConfig.html" title="&#171;interface&#187; ITransportConfig" alt="" coords="268,244,383,284"/>
<area shape="rect" id="node15" href="ITransportConfigAware.html" title="&#171;interface&#187; ITransportConfigAware" alt="" coords="31,133,182,173"/>
<area shape="rect" id="node16" href="../spi/net4j/InternalAcceptor.html" title="&#171;interface&#187; InternalAcceptor (org.eclipse.spi.net4j)" alt="" coords="252,86,399,141"/>
<area shape="rect" id="node17" href="../spi/net4j/InternalChannelMultiplexer.html" title="&#171;interface&#187; InternalChannelMultiplexer (org.eclipse.spi.net4j)" alt="" coords="238,165,413,219"/>
<area shape="rect" id="node18" href="Net4jUtil.html" title="&#171;static&#187; Net4jUtil" alt="" coords="71,69,142,109"/>
<area shape="rect" id="node19" href="ILocationAware.Location.html" title="&#171;enum&#187; ILocationAware.Location" alt="" coords="25,5,188,45"/>
</map>

<CENTER><IMG SRC="package-summary.png" USEMAP="#APIVIZ" BORDER="0"></CENTER>
<BR>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../org/eclipse/net4j/ILocationAware.html" title="interface in org.eclipse.net4j">ILocationAware</A></B></TD>
<TD>A concept that has a <A HREF="../../../org/eclipse/net4j/ILocationAware.Location.html" title="enum in org.eclipse.net4j"><CODE>location</CODE></A> in a <A HREF="../../../org/eclipse/net4j/ILocationAware.Location.html#CLIENT"><CODE>client</CODE></A>/<A HREF="../../../org/eclipse/net4j/ILocationAware.Location.html#SERVER"><CODE>server</CODE></A>
 scenario.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../org/eclipse/net4j/ITransportConfig.html" title="interface in org.eclipse.net4j">ITransportConfig</A></B></TD>
<TD>A common transport configuration that specifies basic dependencies for <A HREF="../../../org/eclipse/net4j/channel/IChannelMultiplexer.html" title="interface in org.eclipse.net4j.channel"><CODE>channel
 multiplexers</CODE></A>, <A HREF="../../../org/eclipse/net4j/connector/IConnector.html" title="interface in org.eclipse.net4j.connector"><CODE>connectors</CODE></A> and <A HREF="../../../org/eclipse/net4j/acceptor/IAcceptor.html" title="interface in org.eclipse.net4j.acceptor"><CODE>acceptors</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../org/eclipse/net4j/ITransportConfigAware.html" title="interface in org.eclipse.net4j">ITransportConfigAware</A></B></TD>
<TD>A concept that has a <A HREF="../../../org/eclipse/net4j/ITransportConfig.html" title="interface in org.eclipse.net4j"><CODE>transport configuration</CODE></A>, typically a <A HREF="../../../org/eclipse/net4j/channel/IChannelMultiplexer.html" title="interface in org.eclipse.net4j.channel"><CODE>channel
 multiplexer</CODE></A>, <A HREF="../../../org/eclipse/net4j/connector/IConnector.html" title="interface in org.eclipse.net4j.connector"><CODE>connector</CODE></A> or <A HREF="../../../org/eclipse/net4j/acceptor/IAcceptor.html" title="interface in org.eclipse.net4j.acceptor"><CODE>acceptor</CODE></A>.</TD>
</TR>
</TABLE>
&nbsp;

<P>

<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../org/eclipse/net4j/ContainerProtocolProvider.html" title="class in org.eclipse.net4j">ContainerProtocolProvider</A></B></TD>
<TD>Base class for container-based <A HREF="../../../org/eclipse/net4j/protocol/IProtocolProvider.html" title="interface in org.eclipse.net4j.protocol"><CODE>protocol providers</CODE></A> like <A HREF="../../../org/eclipse/net4j/ContainerProtocolProvider.Client.html" title="class in org.eclipse.net4j"><CODE>ContainerProtocolProvider.Client</CODE></A> or <A HREF="../../../org/eclipse/net4j/ContainerProtocolProvider.Server.html" title="class in org.eclipse.net4j"><CODE>ContainerProtocolProvider.Server</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../org/eclipse/net4j/ContainerProtocolProvider.Client.html" title="class in org.eclipse.net4j">ContainerProtocolProvider.Client</A></B></TD>
<TD>Container-based <A HREF="../../../org/eclipse/net4j/protocol/IProtocolProvider.html" title="interface in org.eclipse.net4j.protocol"><CODE>protocol provider</CODE></A> for <A HREF="../../../org/eclipse/net4j/ILocationAware.Location.html#CLIENT"><CODE>client</CODE></A>
 protocols.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../org/eclipse/net4j/ContainerProtocolProvider.Server.html" title="class in org.eclipse.net4j">ContainerProtocolProvider.Server</A></B></TD>
<TD>Container-based <A HREF="../../../org/eclipse/net4j/protocol/IProtocolProvider.html" title="interface in org.eclipse.net4j.protocol"><CODE>protocol provider</CODE></A> for <A HREF="../../../org/eclipse/net4j/ILocationAware.Location.html#SERVER"><CODE>server</CODE></A>
 protocols.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../org/eclipse/net4j/FactoriesProtocolProvider.html" title="class in org.eclipse.net4j">FactoriesProtocolProvider</A></B></TD>
<TD>Factory-based <A HREF="../../../org/eclipse/net4j/protocol/IProtocolProvider.html" title="interface in org.eclipse.net4j.protocol"><CODE>protocol provider</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../org/eclipse/net4j/Net4jUtil.html" title="class in org.eclipse.net4j">Net4jUtil</A></B></TD>
<TD>A utility class with various static factory and convenience methods.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../org/eclipse/net4j/TransportConfigurator.html" title="class in org.eclipse.net4j">TransportConfigurator</A></B></TD>
<TD>Reads an XML config file and creates, wires and starts the configured <A HREF="../../../org/eclipse/net4j/acceptor/IAcceptor.html" title="interface in org.eclipse.net4j.acceptor"><CODE>acceptors</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../org/eclipse/net4j/TransportInjector.html" title="class in org.eclipse.net4j">TransportInjector</A></B></TD>
<TD>An element post processor that injects a <A HREF="../../../org/eclipse/net4j/ITransportConfig.html" title="interface in org.eclipse.net4j"><CODE>transport configuration</CODE></A> into the <A HREF="../../../org/eclipse/net4j/connector/IConnector.html" title="interface in org.eclipse.net4j.connector"><CODE>connectors</CODE></A> and <A HREF="../../../org/eclipse/net4j/acceptor/IAcceptor.html" title="interface in org.eclipse.net4j.acceptor"><CODE>acceptors</CODE></A> of a <A HREF="../../../../../org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/container/IManagedContainer.html?is-external=true" title="class or interface in org.eclipse.net4j.util.container"><CODE>managed container</CODE></A>.</TD>
</TR>
</TABLE>
&nbsp;

<P>

<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Enum Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../org/eclipse/net4j/ILocationAware.Location.html" title="enum in org.eclipse.net4j">ILocationAware.Location</A></B></TD>
<TD>A <A HREF="../../../org/eclipse/net4j/ILocationAware.Location.html" title="enum in org.eclipse.net4j"><CODE>location</CODE></A> in a <A HREF="../../../org/eclipse/net4j/ILocationAware.Location.html#CLIENT"><CODE>client</CODE></A>/<A HREF="../../../org/eclipse/net4j/ILocationAware.Location.html#SERVER"><CODE>server</CODE></A> scenario.</TD>
</TR>
</TABLE>
&nbsp;

<P>
<A NAME="package_description"><!-- --></A><H2>
Package org.eclipse.net4j Description
</H2>

<P>
The Net4j transport layer. 
 The five main interfaces of the transport layer are:
        <ul>
                <li><A HREF="../../../org/eclipse/net4j/buffer/IBuffer.html" title="interface in org.eclipse.net4j.buffer"><CODE>IBuffer</CODE></A></li> 
                <li><A HREF="../../../org/eclipse/net4j/channel/IChannel.html" title="interface in org.eclipse.net4j.channel"><CODE>IChannel</CODE></A></li>
                <li><A HREF="../../../org/eclipse/net4j/acceptor/IAcceptor.html" title="interface in org.eclipse.net4j.acceptor"><CODE>IAcceptor</CODE></A></li>
                <li><A HREF="../../../org/eclipse/net4j/connector/IConnector.html" title="interface in org.eclipse.net4j.connector"><CODE>IConnector</CODE></A></li> 
                <li><A HREF="../../../org/eclipse/net4j/protocol/IProtocol.html" title="interface in org.eclipse.net4j.protocol"><CODE>IProtocol</CODE></A></li>
        </ul>
 <p>
 
 <dt><b>Sequence Diagram: Communication Process</b></dt>
 <dd> <img src="doc-files/CommunicationProcess.jpg" title="Communication Process" border="0"
 usemap="#CommunicationProcess.jpg"/></dd>
 <p>
 <MAP NAME="CommunicationProcess.jpg">
 <AREA SHAPE="RECT" COORDS="128,94,247,123" HREF="IConnector.html">
 <AREA SHAPE="RECT" COORDS="648,95,767,123" HREF="IConnector.html">
 <AREA SHAPE="RECT" COORDS="509,254,608,283" HREF="IChannel.html">
 <AREA SHAPE="RECT" COORDS="287,355,387,383" HREF="IChannel.html">
 <AREA SHAPE="RECT" COORDS="818,195,897,222" HREF="IProtocol.html">
 </MAP>
<P>

<P>
<DL>
</DL>
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV PACKAGE&nbsp;
&nbsp;<A HREF="../../../org/eclipse/net4j/acceptor/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?org/eclipse/net4j/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<i>Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) and others.</i>
</BODY>
</HTML>

Back to the top