KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > ubermq > jms > client > unicast > PipeEndpoint


1 package com.ubermq.jms.client.unicast;
2
3 import com.ubermq.kernel.*;
4 import java.nio.channels.*;
5
6 /**
7  * Represents an endpoint that NIO pipes can connect to locally.
8  */
9 public interface PipeEndpoint
10 {
11     /**
12      * Pipes are first class constructs in this message server implementation.
13      * A pipe connection factory can call this method on an in-process server
14      * and directly connect to the server, and receive datagrams.
15      * <P>
16      * This method creates a pipe and registers it with the server's I/O
17      * process and internal datagram processor. The caller is responsible
18      * for registering a client-side message handler and servicing the Pipe
19      * from an I/O standpoint.
20      * <P>
21      * @param upstream the Upstream pipe, representing data flowing from
22      * the client to the server.
23      * @param downstream the Downstream pipe, representing data flowing from
24      * the server to the client.
25      * @param df the datagram factory to use to service this connection.
26      * @return the <code>PipeConnectionInfo</code> created by this pipe connection.
27      * @throws IOException if the pipes are not valid.
28      */
29     public PipeConnectionInfo connectPipes(Pipe upstream,
30                                              Pipe downstream,
31                                              IDatagramFactory df)
32         throws java.io.IOException JavaDoc;
33 }
34
Popular Tags