Added SILC Server library.

[silc.git] / lib / silcutil / silcfdstream.h

diff --git a/lib/silcutil/silcfdstream.h b/lib/silcutil/silcfdstream.h
index 3acb8cecaf78a135f1c50ddb05c781d818b5014f..0b09fd3a520ed8f148d6cf56b7d09dcdca91057e 100644 (file)
--- a/lib/silcutil/silcfdstream.h
+++ b/lib/silcutil/silcfdstream.h
@@ -26,6 +26,9 @@
  * interface should be used only with real file descriptors, not with
  * sockets.  Use the SILC Socket Stream for sockets.
  *
+ * SILC File Descriptor Stream is not thread-safe.  If same stream must be
+ * used in multithreaded environment concurrency control must be employed.
+ *
  ***/
 
 #ifndef SILCFDSTREAM_H
@@ -35,7 +38,7 @@
  *
  * SYNOPSIS
  *
- *    SilcStream silc_fd_stream_create(int fd, SilcSchedule schedule);
+ *    SilcStream silc_fd_stream_create(int fd);
  *
  * DESCRIPTION
  *
@@ -43,15 +46,17 @@
  *    by `fd'.  The stream is closed with the silc_stream_close and destroyed
  *    with the silc_stream_destroy.
  *
+ *    The silc_stream_set_notifier must be called in order to be able to read
+ *    from and write to this file descriptor stream.
+ *
  ***/
-SilcStream silc_fd_stream_create(int fd, SilcSchedule schedule);
+SilcStream silc_fd_stream_create(int fd);
 
 /****f* silcutil/SilcFDStreamAPI/silc_fd_stream_create2
  *
  * SYNOPSIS
  *
- *    SilcStream silc_fd_stream_create2(int read_fd, int write_fd,
- *                                      SilcSchedule schedule);
+ *    SilcStream silc_fd_stream_create2(int read_fd, int write_fd);
  *
  * DESCRIPTION
  *
@@ -60,9 +65,32 @@ SilcStream silc_fd_stream_create(int fd, SilcSchedule schedule);
  *    and `write_fd' opened for writing.  The stream is closed with the
  *    silc_stream_close and destroyed with the silc_stream_destroy.
  *
+ *    The silc_stream_set_notifier must be called in order to be able to read
+ *    from and write to this file descriptor stream.
+ *
+ ***/
+SilcStream silc_fd_stream_create2(int read_fd, int write_fd);
+
+/****f* silcutil/SilcFDStreamAPI/silc_fd_stream_file
+ *
+ * SYNOPSIS
+ *
+ *    SilcStream silc_fd_stream_file(const char *filename, SilcBool reading,
+ *                                   SilcBool writing);
+ *
+ * DESCRIPTION
+ *
+ *    Same as silc_fd_stream_create but creates the stream by opening the
+ *    file indicated by `filename'.  If the `reading' is TRUE the file is
+ *    opened for reading.  If the `writing' is TRUE the file is opened
+ *    for writing.
+ *
+ *    The silc_stream_set_notifier must be called in order to be able to read
+ *    from and write to this file descriptor stream.
+ *
  ***/
-SilcStream silc_fd_stream_create2(int read_fd, int write_fd,
-                                 SilcSchedule schedule);
+SilcStream silc_fd_stream_file(const char *filename, SilcBool reading,
+                              SilcBool writing);
 
 /****f* silcutil/SilcFDStreamAPI/silc_fd_stream_get_info
  *
@@ -78,7 +106,8 @@ SilcStream silc_fd_stream_create2(int read_fd, int write_fd,
  *    function.
  *
  ***/
-SilcBool silc_fd_stream_get_info(SilcStream stream, int *read_fd, int *write_fd);
+SilcBool silc_fd_stream_get_info(SilcStream stream,
+                                int *read_fd, int *write_fd);
 
 /****f* silcutil/SilcFDStreamAPI/silc_fd_stream_get_error
  *