diff options
Diffstat (limited to 'plugins/org.eclipse.tm.tcf.core/src/org/eclipse/tm/tcf/services/IStreams.java')
| -rw-r--r-- | plugins/org.eclipse.tm.tcf.core/src/org/eclipse/tm/tcf/services/IStreams.java | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/plugins/org.eclipse.tm.tcf.core/src/org/eclipse/tm/tcf/services/IStreams.java b/plugins/org.eclipse.tm.tcf.core/src/org/eclipse/tm/tcf/services/IStreams.java index 9867f420b..c964d6d62 100644 --- a/plugins/org.eclipse.tm.tcf.core/src/org/eclipse/tm/tcf/services/IStreams.java +++ b/plugins/org.eclipse.tm.tcf.core/src/org/eclipse/tm/tcf/services/IStreams.java @@ -1,10 +1,10 @@ /******************************************************************************* * Copyright (c) 2009 Wind River Systems, Inc. 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 - * + * 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: * Wind River Systems - initial API and implementation *******************************************************************************/ @@ -15,13 +15,13 @@ import org.eclipse.tm.tcf.protocol.IToken; /** * Streams service is a generic interface to support streaming of data between host and remote agents. - * + * * The service supports: * 1. Asynchronous overlapped data streaming: multiple 'read' or 'write' command can be issued at same time, both peers * can continue data processing concurrently with data transmission. * 2. Multicast: multiple clients can receive data from same stream. * 3. Subscription model: clients are required to expressed interest in particular streams by subscribing for the service. - * 4. Flow control: peers can throttle data flow of individual streams by delaying 'read' and 'write' commands. + * 4. Flow control: peers can throttle data flow of individual streams by delaying 'read' and 'write' commands. */ public interface IStreams extends IService { @@ -32,8 +32,8 @@ public interface IStreams extends IService { /** * Clients can implement StreamsListener interface to be notified - * when a stream is created or disposed. The interface is registered with 'subscribe' command. - * + * when a stream is created or disposed. The interface is registered with 'subscribe' command. + * * When new stream is created, client must decide if it is interested in that particular stream instance. * If not interested, client should send 'disconnect' command to allow remote peer to free resources and bandwidth. * If not disconnected, client is required to send 'read' commands as necessary to prevent stream buffer overflow. @@ -41,7 +41,7 @@ public interface IStreams extends IService { interface StreamsListener { /** - * Called when a new stream is created. + * Called when a new stream is created. * @param stream_type - source type of the stream. * @param stream_id - ID of the stream. * @param context_id - a context ID that is associated with the stream, or null. @@ -51,7 +51,7 @@ public interface IStreams extends IService { void created(String stream_type, String stream_id, String context_id); /** - * Called when a stream is disposed. + * Called when a stream is disposed. * @param stream_type - source type of the stream. * @param stream_id - ID of the stream. */ @@ -118,7 +118,7 @@ public interface IStreams extends IService { * @param lost_size - number of bytes that were lost because of buffer overflow. * 'lost_size' -1 means unknown number of bytes were lost. * if both 'lost_size' and 'data.length' are non-zero then lost bytes are considered - * located right before read bytes. + * located right before read bytes. * @param data - bytes read from the stream. * @param eos - true if end of stream was reached. */ @@ -153,7 +153,7 @@ public interface IStreams extends IService { } /** - * Send End Of Stream marker to a stream. No more writing to the stream is allowed after that. + * Send End Of Stream marker to a stream. No more writing to the stream is allowed after that. * @param stream_id - ID of the stream. * @param done - command result call back object. * @return - pending command handle. |