Asterisk - The Open Source Telephony Project  21.4.1
udptl.h
Go to the documentation of this file.
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * UDPTL support for T.38
5  *
6  * Copyright (C) 2005, Steve Underwood, partly based on RTP code which is
7  * Copyright (C) 1999-2004, Digium, Inc.
8  *
9  * Steve Underwood <steveu@coppice.org>
10  *
11  * This program is free software, distributed under the terms of
12  * the GNU General Public License
13  *
14  * A license has been granted to Digium (via disclaimer) for the use of
15  * this code.
16  */
17 
18 /*! \file
19  * \brief UDPTL support for T.38
20  * \author Steve Underwood <steveu@coppice.org>
21  * \ref udptl.c
22  * \todo add doxygen documentation to this file!
23  */
24 
25 
26 #ifndef _ASTERISK_UDPTL_H
27 #define _ASTERISK_UDPTL_H
28 
29 #include "asterisk/network.h"
30 #include "asterisk/frame.h"
31 #include "asterisk/io.h"
32 #include "asterisk/sched.h"
33 #include "asterisk/channel.h"
34 #include "asterisk/netsock2.h"
35 
36 
37 enum ast_t38_ec_modes {
38  UDPTL_ERROR_CORRECTION_NONE,
39  UDPTL_ERROR_CORRECTION_FEC,
40  UDPTL_ERROR_CORRECTION_REDUNDANCY
41 };
42 
43 #if defined(__cplusplus) || defined(c_plusplus)
44 extern "C" {
45 #endif
46 
47 struct ast_udptl;
48 
49 typedef int (*ast_udptl_callback)(struct ast_udptl *udptl, struct ast_frame *f, void *data);
50 
51 struct ast_udptl *ast_udptl_new_with_bindaddr(struct ast_sched_context *sched, struct io_context *io, int callbackmode, struct ast_sockaddr *in);
52 
53 /*!
54  * \brief Associates a character string 'tag' with a UDPTL session.
55  * \param udptl The UDPTL session.
56  * \param format printf-style format string used to construct the tag
57  *
58  * This function formats a tag for the specified UDPTL
59  * session, so that any log messages generated by the UDPTL stack
60  * related to that session will include the tag and the reader of
61  * the messages will be able to identify which endpoint caused them
62  * to be generated.
63  */
64 void __attribute__((format(printf, 2, 3))) ast_udptl_set_tag(struct ast_udptl *udptl, const char *format, ...);
65 
66 void ast_udptl_set_peer(struct ast_udptl *udptl, const struct ast_sockaddr *them);
67 
68 void ast_udptl_get_peer(const struct ast_udptl *udptl, struct ast_sockaddr *them);
69 
70 void ast_udptl_get_us(const struct ast_udptl *udptl, struct ast_sockaddr *us);
71 
72 void ast_udptl_destroy(struct ast_udptl *udptl);
73 
74 void ast_udptl_reset(struct ast_udptl *udptl);
75 
76 void ast_udptl_set_callback(struct ast_udptl *udptl, ast_udptl_callback callback);
77 
78 void ast_udptl_set_data(struct ast_udptl *udptl, void *data);
79 
80 int ast_udptl_write(struct ast_udptl *udptl, struct ast_frame *f);
81 
82 struct ast_frame *ast_udptl_read(struct ast_udptl *udptl);
83 
84 int ast_udptl_fd(const struct ast_udptl *udptl);
85 
86 int ast_udptl_setqos(struct ast_udptl *udptl, unsigned int tos, unsigned int cos);
87 
88 void ast_udptl_set_m_type(struct ast_udptl *udptl, unsigned int pt);
89 
90 void ast_udptl_set_udptlmap_type(struct ast_udptl *udptl, unsigned int pt,
91  char *mimeType, char *mimeSubtype);
92 
93 enum ast_t38_ec_modes ast_udptl_get_error_correction_scheme(const struct ast_udptl *udptl);
94 
95 void ast_udptl_set_error_correction_scheme(struct ast_udptl *udptl, enum ast_t38_ec_modes ec);
96 
97 void ast_udptl_set_local_max_ifp(struct ast_udptl *udptl, unsigned int max_ifp);
98 
99 /*!
100  * \brief retrieves local_max_datagram.
101  *
102  * \return positive value representing max datagram size.
103  * \retval 0 if no value is present
104  */
105 unsigned int ast_udptl_get_local_max_datagram(struct ast_udptl *udptl);
106 
107 /*!
108  * \brief sets far max datagram size. If max_datagram is = 0, the far max datagram
109  * size is set to a default value.
110  */
111 void ast_udptl_set_far_max_datagram(struct ast_udptl *udptl, unsigned int max_datagram);
112 
113 unsigned int ast_udptl_get_far_max_datagram(const struct ast_udptl *udptl);
114 
115 /*!
116  * \brief retrieves far max ifp
117  *
118  * \return positive value representing max ifp size
119  * \retval 0 if no value is present
120  */
121 unsigned int ast_udptl_get_far_max_ifp(struct ast_udptl *udptl);
122 
123 void ast_udptl_setnat(struct ast_udptl *udptl, int nat);
124 
125 void ast_udptl_stop(struct ast_udptl *udptl);
126 
127 #if defined(__cplusplus) || defined(c_plusplus)
128 }
129 #endif
130 
131 #endif
unsigned int ast_udptl_get_local_max_datagram(struct ast_udptl *udptl)
retrieves local_max_datagram.
Definition: udptl.c:982
Definition: sched.c:76
Structure for an UDPTL session.
Definition: udptl.c:154
void ast_udptl_set_far_max_datagram(struct ast_udptl *udptl, unsigned int max_datagram)
sets far max datagram size. If max_datagram is = 0, the far max datagram size is set to a default val...
Definition: udptl.c:995
I/O Management (derived from Cheops-NG)
Socket address structure.
Definition: netsock2.h:97
General Asterisk PBX channel definitions.
Global IO variables are now in a struct in order to be made threadsafe.
Definition: io.c:71
Scheduler Routines (derived from cheops)
Asterisk internal frame definitions.
Network socket handling.
Wrapper for network related headers, masking differences between various operating systems...
unsigned int ast_udptl_get_far_max_ifp(struct ast_udptl *udptl)
retrieves far max ifp
Definition: udptl.c:1014
union ast_frame::@224 data
void ast_udptl_set_tag(struct ast_udptl *udptl, const char *format,...)
Associates a character string 'tag' with a UDPTL session.
Definition: udptl.c:1110
Data structure associated with a single frame of data.