diff options
| author | Sree Harsha Totakura <totakura@in.tum.de> | 2011-12-09 15:55:00 +0000 |
|---|---|---|
| committer | Sree Harsha Totakura <totakura@in.tum.de> | 2011-12-09 15:55:00 +0000 |
| commit | 04ae1bc73842a2aad9ca73d9abb6875a58cbdd40 (patch) | |
| tree | 54ccd89279fba2451162702fae3bb465406157bc /src/stream | |
| parent | 32538d64d62d3be3e46b9cbc128d966e10f4141e (diff) | |
| download | gnunet-04ae1bc73842a2aad9ca73d9abb6875a58cbdd40.tar.gz gnunet-04ae1bc73842a2aad9ca73d9abb6875a58cbdd40.zip | |
added API definitions for stream library
Diffstat (limited to 'src/stream')
| -rw-r--r-- | src/stream/README | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/src/stream/README b/src/stream/README new file mode 100644 index 000000000..9b550b09b --- /dev/null +++ b/src/stream/README | |||
| @@ -0,0 +1,11 @@ | |||
| 1 | The aim of the stream library is to provide stream connections between peers in | ||
| 2 | GNUnet. This is a convenience library which hides the complexity of dividing | ||
| 3 | data stream into packets, transmitting them and retransmitting them in case of | ||
| 4 | errors. | ||
| 5 | |||
| 6 | This library's API are similar to unix PIPE API. The user is expected to open a | ||
| 7 | stream to a listening target peer. Once the stream is established, the user can | ||
| 8 | use it as a pipe. Any data written into the stream will be readable by the | ||
| 9 | target peer. | ||
| 10 | |||
| 11 | This library uses mesh API for establishing streams between peers. \ No newline at end of file | ||