Merge branch 'topic/mm-fixes' of git://208.110.73.182/silc into silc.1.1.branch

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

diff --git a/lib/silcutil/silcfdstream.h b/lib/silcutil/silcfdstream.h
index 9904fcac0dafcffe8290a8242084a0340fcb8ce8..f64d6b53fe5e5d03e3dfc9611cb3ea5de9bd642f 100644 (file)
--- a/lib/silcutil/silcfdstream.h
+++ b/lib/silcutil/silcfdstream.h
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 2005 Pekka Riikonen
+  Copyright (C) 2005 - 2007 Pekka Riikonen
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -38,7 +38,7 @@
  *
  * SYNOPSIS
  *
- *    SilcStream silc_fd_stream_create(int fd, SilcSchedule schedule);
+ *    SilcStream silc_fd_stream_create(int fd);
  *
  * DESCRIPTION
  *
@@ -46,15 +46,17 @@
  *    by `fd'.  The stream is closed with the silc_stream_close and destroyed
  *    with the silc_stream_destroy.
  *
+ *    If the silc_stream_set_notifier is called the stream is set to
+ *    non-blocking mode.
+ *
  ***/
-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
  *
@@ -63,9 +65,50 @@ 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.
  *
+ *    If the silc_stream_set_notifier is called the stream is set to
+ *    non-blocking mode.
+ *
+ ***/
+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.
+ *
+ *    If the silc_stream_set_notifier is called the stream is set to
+ *    non-blocking mode.
+ *
+ ***/
+SilcStream silc_fd_stream_file(const char *filename, SilcBool reading,
+                              SilcBool writing);
+
+/****f* silcutil/SilcFDStreamAPI/silc_fd_stream_file2
+ *
+ * SYNOPSIS
+ *
+ *    SilcStream silc_fd_stream_file2(const char *read_file,
+ *                                    const char *write_file);
+ *
+ * DESCRIPTION
+ *
+ *    Same as silc_fd_stream_file but creates the stream by opening `read_file'
+ *    for reading and `write_file' for writing.
+ *
+ *    If the silc_stream_set_notifier is called the stream is set to
+ *    non-blocking mode.
+ *
  ***/
-SilcStream silc_fd_stream_create2(int read_fd, int write_fd,
-                                 SilcSchedule schedule);
+SilcStream silc_fd_stream_file2(const char *read_file, const char *write_file);
 
 /****f* silcutil/SilcFDStreamAPI/silc_fd_stream_get_info
  *
@@ -81,7 +124,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
  *