diff options
Diffstat (limited to 'plugins/org.eclipse.net4j/src/org/eclipse/net4j/connector/IConnector.java')
-rw-r--r-- | plugins/org.eclipse.net4j/src/org/eclipse/net4j/connector/IConnector.java | 216 |
1 files changed, 108 insertions, 108 deletions
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/connector/IConnector.java b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/connector/IConnector.java index 123aaa2c8b..cf06eb171d 100644 --- a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/connector/IConnector.java +++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/connector/IConnector.java @@ -1,108 +1,108 @@ -/*
- * Copyright (c) 2004 - 2012 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.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 org.eclipse.net4j.ILocationAware.Location location} of
- * {@link org.eclipse.net4j.ILocationAware.Location#CLIENT CLIENT} or
- * {@link org.eclipse.net4j.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/IConnector-1.gif" title="Diagram Connectors" border="0" usemap="IConnector-1.gif"/></dd>
- * <p>
- * <MAP NAME="IConnector-1.gif"> <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/IConnector-2.gif" title="Communication Process" border="0" usemap="#IConnector-2.gif"/></dd>
- * <p>
- * <MAP NAME="IConnector-2.gif"> <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
- * @noimplement This interface is not intended to be implemented by clients.
- */
-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 connector.
- */
- 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)}.
- *
- * @throws ConnectorException
- * @since 4.0
- */
- public void 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.
- * @throws ConnectorException
- * @since 4.0
- */
- public void connect(long timeout) throws ConnectorException;
-
- /**
- * Asynchronous connect. May leave this {@link IConnector} in a state where <code>{@link #isConnected()} == false
- * </code>.
- *
- * @throws ConnectorException
- * @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
- * @since 4.0
- */
- public void waitForConnection(long timeout) throws ConnectorException;
-}
+/* + * Copyright (c) 2004 - 2012 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.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 org.eclipse.net4j.ILocationAware.Location location} of + * {@link org.eclipse.net4j.ILocationAware.Location#CLIENT CLIENT} or + * {@link org.eclipse.net4j.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/IConnector-1.gif" title="Diagram Connectors" border="0" usemap="IConnector-1.gif"/></dd> + * <p> + * <MAP NAME="IConnector-1.gif"> <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/IConnector-2.gif" title="Communication Process" border="0" usemap="#IConnector-2.gif"/></dd> + * <p> + * <MAP NAME="IConnector-2.gif"> <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 + * @noimplement This interface is not intended to be implemented by clients. + */ +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 connector. + */ + 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)}. + * + * @throws ConnectorException + * @since 4.0 + */ + public void 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. + * @throws ConnectorException + * @since 4.0 + */ + public void connect(long timeout) throws ConnectorException; + + /** + * Asynchronous connect. May leave this {@link IConnector} in a state where <code>{@link #isConnected()} == false + * </code>. + * + * @throws ConnectorException + * @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 + * @since 4.0 + */ + public void waitForConnection(long timeout) throws ConnectorException; +} |