lib/silcutil/silcfdstream.h

   1 /*
   2
   3   silcfdstream.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 2005 Pekka Riikonen
   8
   9   This program is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU General Public License as published by
  11   the Free Software Foundation; version 2 of the License.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18 */
  19
  20 /****h* silcutil/SILC File Descriptor Stream Interface
  21  *
  22  * DESCRIPTION
  23  *
  24  * Implementation of SILC File Descriptor Stream.  The file descriptor
  25  * stream can be used read from and write to a file descriptor.  This
  26  * interface should be used only with real file descriptors, not with
  27  * sockets.  Use the SILC Socket Stream for sockets.
  28  *
  29  * SILC File Descriptor Stream is not thread-safe.  If same stream must be
  30  * used in multithreaded environment concurrency control must be employed.
  31  *
  32  ***/
  33
  34 #ifndef SILCFDSTREAM_H
  35 #define SILCFDSTREAM_H
  36
  37 /****f* silcutil/SilcFDStreamAPI/silc_fd_stream_create
  38  *
  39  * SYNOPSIS
  40  *
  41  *    SilcStream silc_fd_stream_create(int fd);
  42  *
  43  * DESCRIPTION
  44  *
  45  *    Creates file descriptor stream for the open file descriptor indicated
  46  *    by `fd'.  The stream is closed with the silc_stream_close and destroyed
  47  *    with the silc_stream_destroy.
  48  *
  49  *    The silc_stream_set_notifier must be called in order to be able to read
  50  *    from and write to this file descriptor stream.
  51  *
  52  ***/
  53 SilcStream silc_fd_stream_create(int fd);
  54
  55 /****f* silcutil/SilcFDStreamAPI/silc_fd_stream_create2
  56  *
  57  * SYNOPSIS
  58  *
  59  *    SilcStream silc_fd_stream_create2(int read_fd, int write_fd);
  60  *
  61  * DESCRIPTION
  62  *
  63  *    Creates file descriptor stream for the open file descriptors indicated
  64  *    by `read_fd' and `write_fd'.  The `read_fd' must be opened for reading
  65  *    and `write_fd' opened for writing.  The stream is closed with the
  66  *    silc_stream_close and destroyed with the silc_stream_destroy.
  67  *
  68  *    The silc_stream_set_notifier must be called in order to be able to read
  69  *    from and write to this file descriptor stream.
  70  *
  71  ***/
  72 SilcStream silc_fd_stream_create2(int read_fd, int write_fd);
  73
  74 /****f* silcutil/SilcFDStreamAPI/silc_fd_stream_file
  75  *
  76  * SYNOPSIS
  77  *
  78  *    SilcStream silc_fd_stream_file(const char *filename, SilcBool reading,
  79  *                                   SilcBool writing);
  80  *
  81  * DESCRIPTION
  82  *
  83  *    Same as silc_fd_stream_create but creates the stream by opening the
  84  *    file indicated by `filename'.  If the `reading' is TRUE the file is
  85  *    opened for reading.  If the `writing' is TRUE the file is opened
  86  *    for writing.
  87  *
  88  *    The silc_stream_set_notifier must be called in order to be able to read
  89  *    from and write to this file descriptor stream.
  90  *
  91  ***/
  92 SilcStream silc_fd_stream_file(const char *filename, SilcBool reading,
  93                                SilcBool writing);
  94
  95 /****f* silcutil/SilcFDStreamAPI/silc_fd_stream_get_info
  96  *
  97  * SYNOPSIS
  98  *
  99  *    SilcBool
 100  *    silc_fd_stream_get_info(SilcStream stream, int *read_fd, int *write_fd);
 101  *
 102  * DESCRIPTION
 103  *
 104  *    Returns the file descriptors associated with the stream.  The 'write_fd'
 105  *    is available only if the stream was created with silc_fd_stream_create2
 106  *    function.
 107  *
 108  ***/
 109 SilcBool silc_fd_stream_get_info(SilcStream stream,
 110                                  int *read_fd, int *write_fd);
 111
 112 /****f* silcutil/SilcFDStreamAPI/silc_fd_stream_get_error
 113  *
 114  * SYNOPSIS
 115  *
 116  *    int silc_fd_stream_get_error(SilcStream stream);
 117  *
 118  * DESCRIPTION
 119  *
 120  *    If error occurred during file descriptor stream operations, this
 121  *    function can be used to retrieve the error number that occurred.
 122  *
 123  ***/
 124 int silc_fd_stream_get_error(SilcStream stream);
 125
 126 #endif /* SILCFDSTREAM_H */