res_rtp_asterisk.c: Fix rtp source address learning for broken clients
[asterisk/asterisk.git] / include / asterisk / iostream.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2015, Digium, Inc.
5  *
6  * Timo Teräs <timo.teras@iki.fi>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 #ifndef _ASTERISK_IOSTREAM_H
20 #define _ASTERISK_IOSTREAM_H
21
22 /*!
23  * \file iostream.h
24  *
25  * \brief Generic abstraction for input/output streams.
26  */
27
28 #if defined(HAVE_OPENSSL)
29 #define DO_SSL  /* comment in/out if you want to support ssl */
30 #endif
31
32 #ifdef DO_SSL
33 #include <openssl/ssl.h>
34 #include <openssl/err.h>
35 #include <openssl/x509v3.h>
36 #else
37 /* declare dummy types so we can define a pointer to them */
38 typedef struct {} SSL;
39 typedef struct {} SSL_CTX;
40 #endif /* DO_SSL */
41
42 struct ast_iostream;
43
44 /*!
45  * \brief Disable the iostream timeout timer.
46  *
47  * \param stream iostream control data.
48  *
49  * \return Nothing
50  */
51 void ast_iostream_set_timeout_disable(struct ast_iostream *stream);
52
53 /*!
54  * \brief Set the iostream inactivity timeout timer.
55  *
56  * \param stream iostream control data.
57  * \param timeout Number of milliseconds to wait for data transfer with the peer.
58  *
59  * \details This is basically how much time we are willing to spend
60  * in an I/O call before we declare the peer unresponsive.
61  *
62  * \note Setting timeout to -1 disables the timeout.
63  * \note Setting this timeout replaces the I/O sequence timeout timer.
64  *
65  * \return Nothing
66  */
67 void ast_iostream_set_timeout_inactivity(struct ast_iostream *stream, int timeout);
68
69 void ast_iostream_set_timeout_idle_inactivity(struct ast_iostream *stream, int timeout, int timeout_reset);
70
71 /*!
72  * \brief Set the iostream I/O sequence timeout timer.
73  *
74  * \param stream iostream control data.
75  * \param start Time the I/O sequence timer starts.
76  * \param timeout Number of milliseconds from the start time before timeout.
77  *
78  * \details This is how much time are we willing to allow the peer
79  * to complete an operation that can take several I/O calls.  The
80  * main use is as an authentication timer with us.
81  *
82  * \note Setting timeout to -1 disables the timeout.
83  * \note Setting this timeout replaces the inactivity timeout timer.
84  *
85  * \return Nothing
86  */
87 void ast_iostream_set_timeout_sequence(struct ast_iostream *stream, struct timeval start, int timeout);
88
89 /*!
90  * \brief Set the iostream if it can exclusively depend upon the set timeouts.
91  *
92  * \param stream iostream control data.
93  * \param exclusive_input TRUE if stream can exclusively wait for fd input.
94  * Otherwise, the stream will not wait for fd input.  It will wait while
95  * trying to send data.
96  *
97  * \note The stream timeouts still need to be set.
98  *
99  * \return Nothing
100  */
101 void ast_iostream_set_exclusive_input(struct ast_iostream *stream, int exclusive_input);
102
103 int ast_iostream_get_fd(struct ast_iostream *stream);
104 void ast_iostream_nonblock(struct ast_iostream *stream);
105
106 SSL* ast_iostream_get_ssl(struct ast_iostream *stream);
107
108 ssize_t ast_iostream_read(struct ast_iostream *stream, void *buf, size_t count);
109 ssize_t ast_iostream_gets(struct ast_iostream *stream, char *buf, size_t count);
110 ssize_t ast_iostream_discard(struct ast_iostream *stream, size_t count);
111 ssize_t ast_iostream_write(struct ast_iostream *stream, const void *buf, size_t count);
112 ssize_t ast_iostream_printf(struct ast_iostream *stream, const void *fmt, ...);
113
114 struct ast_iostream* ast_iostream_from_fd(int *fd);
115 int ast_iostream_start_tls(struct ast_iostream **stream, SSL_CTX *ctx, int client);
116 int ast_iostream_close(struct ast_iostream *stream);
117
118 #endif /* _ASTERISK_IOSTREAM_H */