Return-Path: Delivered-To: apmail-incubator-river-commits-archive@minotaur.apache.org Received: (qmail 62019 invoked from network); 24 Dec 2010 20:33:34 -0000 Received: from unknown (HELO mail.apache.org) (140.211.11.3) by 140.211.11.9 with SMTP; 24 Dec 2010 20:33:34 -0000 Received: (qmail 44561 invoked by uid 500); 24 Dec 2010 20:33:34 -0000 Delivered-To: apmail-incubator-river-commits-archive@incubator.apache.org Received: (qmail 44534 invoked by uid 500); 24 Dec 2010 20:33:34 -0000 Mailing-List: contact river-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: river-dev@incubator.apache.org Delivered-To: mailing list river-commits@incubator.apache.org Received: (qmail 44527 invoked by uid 99); 24 Dec 2010 20:33:34 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 24 Dec 2010 20:33:34 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 24 Dec 2010 20:33:28 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 4CA772388A32; Fri, 24 Dec 2010 20:32:59 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1052596 [2/2] - in /incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/tcp: TcpEndpoint.html TcpServerEndpoint.html class-use/ package-frame.html package-summary.html package-tree.html package-use.html Date: Fri, 24 Dec 2010 20:32:59 -0000 To: river-commits@incubator.apache.org From: sijskes@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20101224203259.4CA772388A32@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/tcp/package-frame.html URL: http://svn.apache.org/viewvc/incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/tcp/package-frame.html?rev=1052596&view=auto ============================================================================== --- incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/tcp/package-frame.html (added) +++ incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/tcp/package-frame.html Fri Dec 24 20:32:58 2010 @@ -0,0 +1,34 @@ + + + + + + +net.jini.jeri.tcp (Apache River v2.1.2-SNAPSHOT API Documentation) + + + + + + + + + + + +net.jini.jeri.tcp + + + + +
+Classes  + +
+TcpEndpoint +
+TcpServerEndpoint
+ + + + Added: incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/tcp/package-summary.html URL: http://svn.apache.org/viewvc/incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/tcp/package-summary.html?rev=1052596&view=auto ============================================================================== --- incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/tcp/package-summary.html (added) +++ incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/tcp/package-summary.html Fri Dec 24 20:32:58 2010 @@ -0,0 +1,343 @@ + + + + + + +net.jini.jeri.tcp (Apache River v2.1.2-SNAPSHOT API Documentation) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package net.jini.jeri.tcp +

+Provides implementations of the Endpoint and +ServerEndpoint abstractions that use TCP sockets +as the underlying communication mechanism. +

+See: +
+          Description +

+ + + + + + + + + + + + + +
+Class Summary
TcpEndpointAn implementation of the Endpoint abstraction that uses TCP + sockets (instances of Socket) for the underlying + communication mechanism.
TcpServerEndpointAn implementation of the ServerEndpoint abstraction that + uses TCP sockets (instances of ServerSocket) for the + underlying communication mechanism.
+  + +

+

+Package net.jini.jeri.tcp Description +

+ +

+Provides implementations of the Endpoint and +ServerEndpoint abstractions that use TCP sockets +as the underlying communication mechanism. + +Requests and responses are framed and multiplexed over TCP connections +using the Jini +extensible remote invocation (Jini ERI) multiplexing protocol. + +

A TcpEndpoint can be used to initiate +requests over a TCP connection. Each instance contains a host name +string (which may be a name or an IP address) and a TCP port number, +as well as an optional SocketFactory for customizing +the type of Socket instances to use. When initiating +a new request, a new TCP connection is created to the host and port, +using the socket factory if present, if an existing connection is not +already available for use. + +

A TcpServerEndpoint can be used to listen +for and receive incoming requests over a TCP connection. Each +instance contains a TCP port number to listen on, a host name string +to use in Endpoint instances derived from the instance, +an optional ServerSocketFactory for customizing the +type of ServerSocket instances to use, and an +optional SocketFactory to use in derived +Endpoint instances. When listening for requests, the +port is bound to listen for TCP connections, using the server socket +factory if present. The TcpServerEndpoint.enumerateListenEndpoints method will produce +TcpEndpoint instances with the same host name, port, and +client socket factory for client-side use (for example, to be embedded +in remote proxies). + +

Jini ERI multiplexing protocol mapping

+ +TcpEndpoint and TcpServerEndpoint map, +respectively, OutboundRequest and InboundRequest instances to distinct sessions of a Jini +ERI multiplexing protocol connection. For each new request initiated, +a TcpEndpoint starts a new session as the client of a +connection to the remote endpoint. As the server of an accepted +connection, a TcpServerEndpoint creates a new +InboundRequest to represent each session started by the +remote endpoint. Request data is transmitted as the data sent for the +corresponding session by the client, and response data is transmitted +as the data sent for the corresponding session by the server. TCP +connections are reused by a TcpEndpoint when possible. + +

Constraint support

+ +TcpEndpoint and TcpServerEndpoint support +the transport layer aspects of at least the following constraints: + + + +(Note that ClientMaxPrincipal, +ClientMaxPrincipalType, ClientMinPrincipal, +ClientMinPrincipalType, ServerMinPrincipal, +DelegationAbsoluteTime, and +DelegationRelativeTime constraints are trivially +supported if ClientAuthentication.YES, +ServerAuthentication.YES, and Delegation.YES +are not supported.) +

+ +

+

+
Since:
+
2.0
+
Version:
+
2.0
+
Implementation Specifics:
+
This implementation uses ConnectionManager and ServerConnectionManager for connection +management. + +

Logging

+ +This implementation uses the Logger named +net.jini.jeri.tcp.client to log information at the +following levels: + +

+ +
Level Description + +
FAILED + exceptions thrown attempting to initiate a request + +
HANDLED + exceptions caught attempting to connect a socket, set + options on a client-side socket, or reuse a connection + +
FINE + client-side socket operations (create, connect, reuse, and + close) + +
+ +

This implementation uses the Logger named +net.jini.jeri.tcp.server to log information at the +following levels: + +

+ +
Level Description + +
WARNING + exceptions accepting on a server socket + +
HANDLED + exceptions caught setting options on a server-side socket + +
FINE + server-side socket operations (create, accept, and close) + +
+ +

System Properties

+ +This implementation recognizes the following system properties: + +

    + +
  • com.sun.jini.jeri.tcp.useNIO - This property is +interpreted as a boolean value (see Boolean.getBoolean). If +true, then when not using a socket factory, the +implementation will use java.nio.channels APIs to create +sockets that have associated selectable channels; specifically: + + + +Otherwise, when not using a socket factory, the implementation will +create sockets that do not have channels: + + + +
+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright 2007, multiple authors.
Licensed under the Apache License, Version 2.0, see the NOTICE file for attributions. + + Added: incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/tcp/package-tree.html URL: http://svn.apache.org/viewvc/incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/tcp/package-tree.html?rev=1052596&view=auto ============================================================================== --- incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/tcp/package-tree.html (added) +++ incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/tcp/package-tree.html Fri Dec 24 20:32:58 2010 @@ -0,0 +1,151 @@ + + + + + + +net.jini.jeri.tcp Class Hierarchy (Apache River v2.1.2-SNAPSHOT API Documentation) + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package net.jini.jeri.tcp +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright 2007, multiple authors.
Licensed under the Apache License, Version 2.0, see the NOTICE file for attributions. + + Added: incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/tcp/package-use.html URL: http://svn.apache.org/viewvc/incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/tcp/package-use.html?rev=1052596&view=auto ============================================================================== --- incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/tcp/package-use.html (added) +++ incubator/river/site/trunk/content/river/doc/api/net/jini/jeri/tcp/package-use.html Fri Dec 24 20:32:58 2010 @@ -0,0 +1,178 @@ + + + + + + +Uses of Package net.jini.jeri.tcp (Apache River v2.1.2-SNAPSHOT API Documentation) + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
net.jini.jeri.tcp

+
+ + + + + + + + + +
+Packages that use net.jini.jeri.tcp
net.jini.jeri.tcpProvides implementations of the Endpoint and +ServerEndpoint abstractions that use TCP sockets +as the underlying communication mechanism. 
+  +

+ + + + + + + + + + + +
+Classes in net.jini.jeri.tcp used by net.jini.jeri.tcp
TcpEndpoint + +
+          An implementation of the Endpoint abstraction that uses TCP + sockets (instances of Socket) for the underlying + communication mechanism.
TcpServerEndpoint + +
+          An implementation of the ServerEndpoint abstraction that + uses TCP sockets (instances of ServerSocket) for the + underlying communication mechanism.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright 2007, multiple authors.
Licensed under the Apache License, Version 2.0, see the NOTICE file for attributions. + +