diff options
| author | Eugene Tarassov | 2016-03-16 16:49:45 +0000 |
|---|---|---|
| committer | Eugene Tarassov | 2016-03-16 16:49:45 +0000 |
| commit | b65b8b2a272071c010b5ce14d228422bced49de7 (patch) | |
| tree | 9a4c12ba07dc39792d382d141a515ac0fb6fe16e /docs | |
| parent | b01e6f17640af1dd44a466f81e13957af2550f4d (diff) | |
| download | org.eclipse.tcf-b65b8b2a272071c010b5ce14d228422bced49de7.tar.gz org.eclipse.tcf-b65b8b2a272071c010b5ce14d228422bced49de7.tar.xz org.eclipse.tcf-b65b8b2a272071c010b5ce14d228422bced49de7.zip | |
TCF Docs: fixed ambiguity in the Streams service specs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/TCF Service - Streams.html | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/TCF Service - Streams.html b/docs/TCF Service - Streams.html index edd875ab2..b69a9db0f 100644 --- a/docs/TCF Service - Streams.html +++ b/docs/TCF Service - Streams.html @@ -135,9 +135,10 @@ R • <i><token></i> • <i><string: data></i> • <i><e </font></b></pre> <ul> - <li><dt><code><b>data</b></code> <dd>BASE64 encoded bytes that were read from the stream. + <li><dt><code><b>data</b></code> <dd>Data bytes that were read from the stream. By default, data is BASE64 encoded. + Peers can send unencoded binary data if both implement ZeroCopy service. <li><dt><code><b>lost size</b></code> <dd>Number of bytes that were lost because of buffer overflow. - -1 means unknown number of bytes were lost. if both 'lost_size' and 'data.length' are non-zero then lost bytes are considered + -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. <li><dt><code><b>EOS</b></code> <dd>true if end of stream was reached. </ul> @@ -150,8 +151,9 @@ C • <i><token></i> • Streams • write • <i><string: <ul> <li><dt><code><b>stream ID</b></code> <dd>ID of stream that will receive the data. - <li><dt><code><b>size</b></code> <dd>Number of bytes to write. Length of <code><b>data</b></code> must match the size. - <li><dt><code><b>data</b></code> <dd>BASE64 encoded bytes that will be written to the stream. + <li><dt><code><b>size</b></code> <dd>Number of bytes to write. Length of unencoded <code><b>data</b></code> must match the size. + <li><dt><code><b>data</b></code> <dd>Data bytes that will be written to the stream. By default, data is BASE64 encoded. + Peers can send unencoded binary data if both implement ZeroCopy service. </ul> <p>The command writes data to a stream. If stream buffer is full, the command will wait until space is available. |