1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
/***************************************************************************
* Copyright (c) 2004 - 2009 Eike Stepper (Berlin, Germany) and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Eike Stepper - initial API and implementation
**************************************************************************/
package org.eclipse.net4j.connector;
import org.eclipse.net4j.ILocationAware;
import org.eclipse.net4j.buffer.IBuffer;
import org.eclipse.net4j.channel.IChannel;
import org.eclipse.net4j.channel.IChannelMultiplexer;
import org.eclipse.net4j.util.collection.Closeable;
import org.eclipse.net4j.util.security.IUserAware;
/**
* One endpoint of a physical connection of arbitrary nature between two communicating parties. A {@link IConnector}
* encapsulates the process of establishing and closing such connections and has a {@link ILocationAware.Location
* location} of {@link ILocationAware.Location#CLIENT CLIENT} or {@link ILocationAware.Location#SERVER SERVER} with
* respect to this process. Once a connection is established either party can use its connector to open multiple
* {@link IChannel}s to asynchronously exchange {@link IBuffer}s.
* <p>
* This interface is <b>not</b> intended to be implemented by clients. Providers of connectors for new physical
* connection types have to implement org.eclipse.internal.net4j.connector.InternalConnector.
* <p>
* <dt><b>Class Diagram:</b></dt>
* <dd><img src="doc-files/Connectors.png" title="Diagram Connectors" border="0" usemap="Connectors.png"/></dd>
* <p>
* <MAP NAME="Connectors.png"> <AREA SHAPE="RECT" COORDS="259,15,400,75" HREF="IConnectorCredentials.html"> <AREA
* SHAPE="RECT" COORDS="12,174,138,245" HREF="ConnectorLocation.html"> <AREA SHAPE="RECT" COORDS="258,139,401,281"
* HREF="IConnector.html"> <AREA SHAPE="RECT" COORDS="518,156,642,263" HREF="ConnectorState.html"> <AREA SHAPE="RECT"
* COORDS="280,360,380,410" HREF="IChannel.html"> </MAP>
* <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>
*
* @author Eike Stepper
*/
public interface IConnector extends IChannelMultiplexer, IUserAware, Closeable
{
/**
* @since 2.0
*/
public static final long NO_TIMEOUT = -1;
public String getURL();
/**
* Returns the current state of this onnector.
*/
public ConnectorState getState();
/**
* Same as <code>{@link #getState()} == {@link ConnectorState#CONNECTED}</code>.
*/
public boolean isConnected();
/**
* Synchronous connect with infinite timeout value. Same as {@link #connect() connect(NO_TIMEOUT)}.
*
* @since 2.0
*/
public boolean connect() throws ConnectorException;
/**
* Synchronous connect. Blocks until <code>{@link #isConnected()} == true</code> or the given timeout expired.
*
* @param timeout
* The maximum number of milli seconds to block or {@link #NO_TIMEOUT} to block indefinetely in case no
* connection occurs.
*/
public boolean connect(long timeout) throws ConnectorException;
/**
* Asynchronous connect. May leave this {@link IConnector} in a state where <code>{@link #isConnected()} == false
* </code>.
*
* @see #waitForConnection(long)
* @see #connect(long)
*/
public void connectAsync() throws ConnectorException;
/**
* Blocks until <code>{@link #isConnected()} == true</code> or the given timeout expired.
*
* @param timeout
* The maximum number of milli seconds to block or {@link #NO_TIMEOUT} to block indefinetely in case no
* connection occurs.
* @throws ConnectorException
*/
public boolean waitForConnection(long timeout) throws ConnectorException;
}
|
