5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 2005 Pekka Riikonen
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.
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.
20 /****h* silcutil/SILC File Descriptor Stream Interface
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.
29 * SILC File Descriptor Stream is not thread-safe. If same stream must be
30 * used in multithreaded environment concurrency control must be employed.
34 #ifndef SILCFDSTREAM_H
35 #define SILCFDSTREAM_H
37 /****f* silcutil/SilcFDStreamAPI/silc_fd_stream_create
41 * SilcStream silc_fd_stream_create(int fd, SilcSchedule schedule);
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.
50 SilcStream silc_fd_stream_create(int fd, SilcSchedule schedule);
52 /****f* silcutil/SilcFDStreamAPI/silc_fd_stream_create2
56 * SilcStream silc_fd_stream_create2(int read_fd, int write_fd,
57 * SilcSchedule schedule);
61 * Creates file descriptor stream for the open file descriptors indicated
62 * by `read_fd' and `write_fd'. The `read_fd' must be opened for reading
63 * and `write_fd' opened for writing. The stream is closed with the
64 * silc_stream_close and destroyed with the silc_stream_destroy.
67 SilcStream silc_fd_stream_create2(int read_fd, int write_fd,
68 SilcSchedule schedule);
70 /****f* silcutil/SilcFDStreamAPI/silc_fd_stream_get_info
75 * silc_fd_stream_get_info(SilcStream stream, int *read_fd, int *write_fd);
79 * Returns the file descriptors associated with the stream. The 'write_fd'
80 * is available only if the stream was created with silc_fd_stream_create2
84 SilcBool silc_fd_stream_get_info(SilcStream stream, int *read_fd, int *write_fd);
86 /****f* silcutil/SilcFDStreamAPI/silc_fd_stream_get_error
90 * int silc_fd_stream_get_error(SilcStream stream);
94 * If error occurred during file descriptor stream operations, this
95 * function can be used to retrieve the error number that occurred.
98 int silc_fd_stream_get_error(SilcStream stream);
100 #endif /* SILCFDSTREAM_H */