Asterisk - The Open Source Telephony Project GIT-master-7921072
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
41};
42
43#if defined(__cplusplus) || defined(c_plusplus)
44extern "C" {
45#endif
46
47struct ast_udptl;
48
49typedef int (*ast_udptl_callback)(struct ast_udptl *udptl, struct ast_frame *f, void *data);
50
51struct 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 */
64void __attribute__((format(printf, 2, 3))) ast_udptl_set_tag(struct ast_udptl *udptl, const char *format, ...);
65
66void ast_udptl_set_peer(struct ast_udptl *udptl, const struct ast_sockaddr *them);
67
68void ast_udptl_get_peer(const struct ast_udptl *udptl, struct ast_sockaddr *them);
69
70void ast_udptl_get_us(const struct ast_udptl *udptl, struct ast_sockaddr *us);
71
72void ast_udptl_destroy(struct ast_udptl *udptl);
73
74void ast_udptl_reset(struct ast_udptl *udptl);
75
77
78void ast_udptl_set_data(struct ast_udptl *udptl, void *data);
79
80int ast_udptl_write(struct ast_udptl *udptl, struct ast_frame *f);
81
82struct ast_frame *ast_udptl_read(struct ast_udptl *udptl);
83
84int ast_udptl_fd(const struct ast_udptl *udptl);
85
86int ast_udptl_setqos(struct ast_udptl *udptl, unsigned int tos, unsigned int cos);
87
88void ast_udptl_set_m_type(struct ast_udptl *udptl, unsigned int pt);
89
90void ast_udptl_set_udptlmap_type(struct ast_udptl *udptl, unsigned int pt,
91 char *mimeType, char *mimeSubtype);
92
94
96
97void 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 */
105unsigned 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 */
111void ast_udptl_set_far_max_datagram(struct ast_udptl *udptl, unsigned int max_datagram);
112
113unsigned 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 */
121unsigned int ast_udptl_get_far_max_ifp(struct ast_udptl *udptl);
122
123void ast_udptl_setnat(struct ast_udptl *udptl, int nat);
124
125void ast_udptl_stop(struct ast_udptl *udptl);
126
127#if defined(__cplusplus) || defined(c_plusplus)
128}
129#endif
130
131#endif
unsigned int tos
Definition: chan_iax2.c:355
unsigned int cos
Definition: chan_iax2.c:356
static struct io_context * io
Definition: chan_ooh323.c:401
General Asterisk PBX channel definitions.
Asterisk internal frame definitions.
I/O Management (derived from Cheops-NG)
Network socket handling.
Wrapper for network related headers, masking differences between various operating systems....
Scheduler Routines (derived from cheops)
Data structure associated with a single frame of data.
union ast_frame::@226 data
Socket address structure.
Definition: netsock2.h:97
Structure for an UDPTL session.
Definition: udptl.c:154
ast_udptl_callback callback
Definition: udptl.c:169
struct ast_sockaddr them
Definition: udptl.c:163
void * data
Definition: udptl.c:167
struct ast_frame f[16]
Definition: udptl.c:157
struct ast_sockaddr us
Definition: udptl.c:162
int nat
Definition: udptl.c:160
Global IO variables are now in a struct in order to be made threadsafe.
Definition: io.c:71
Definition: sched.c:76
void ast_udptl_destroy(struct ast_udptl *udptl)
Definition: udptl.c:1148
enum ast_t38_ec_modes ast_udptl_get_error_correction_scheme(const struct ast_udptl *udptl)
Definition: udptl.c:938
void ast_udptl_stop(struct ast_udptl *udptl)
Definition: udptl.c:1143
int ast_udptl_fd(const struct ast_udptl *udptl)
Definition: udptl.c:728
void ast_udptl_reset(struct ast_udptl *udptl)
void ast_udptl_get_peer(const struct ast_udptl *udptl, struct ast_sockaddr *them)
Definition: udptl.c:1133
void ast_udptl_set_peer(struct ast_udptl *udptl, const struct ast_sockaddr *them)
Definition: udptl.c:1128
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
void ast_udptl_set_local_max_ifp(struct ast_udptl *udptl, unsigned int max_ifp)
Definition: udptl.c:971
unsigned int ast_udptl_get_far_max_ifp(struct ast_udptl *udptl)
retrieves far max ifp
Definition: udptl.c:1014
void ast_udptl_setnat(struct ast_udptl *udptl, int nat)
Definition: udptl.c:743
void ast_udptl_get_us(const struct ast_udptl *udptl, struct ast_sockaddr *us)
Definition: udptl.c:1138
struct ast_frame * ast_udptl_read(struct ast_udptl *udptl)
Definition: udptl.c:760
struct ast_udptl * ast_udptl_new_with_bindaddr(struct ast_sched_context *sched, struct io_context *io, int callbackmode, struct ast_sockaddr *in)
Definition: udptl.c:1026
void ast_udptl_set_m_type(struct ast_udptl *udptl, unsigned int pt)
int ast_udptl_setqos(struct ast_udptl *udptl, unsigned int tos, unsigned int cos)
Definition: udptl.c:1123
int ast_udptl_write(struct ast_udptl *udptl, struct ast_frame *f)
Definition: udptl.c:1159
unsigned int ast_udptl_get_local_max_datagram(struct ast_udptl *udptl)
retrieves local_max_datagram.
Definition: udptl.c:982
int(* ast_udptl_callback)(struct ast_udptl *udptl, struct ast_frame *f, void *data)
Definition: udptl.h:49
void ast_udptl_set_data(struct ast_udptl *udptl, void *data)
Definition: udptl.c:733
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
void ast_udptl_set_udptlmap_type(struct ast_udptl *udptl, unsigned int pt, char *mimeType, char *mimeSubtype)
void ast_udptl_set_callback(struct ast_udptl *udptl, ast_udptl_callback callback)
Definition: udptl.c:738
unsigned int ast_udptl_get_far_max_datagram(const struct ast_udptl *udptl)
Definition: udptl.c:1006
void ast_udptl_set_error_correction_scheme(struct ast_udptl *udptl, enum ast_t38_ec_modes ec)
Definition: udptl.c:943
ast_t38_ec_modes
Definition: udptl.h:37
@ UDPTL_ERROR_CORRECTION_FEC
Definition: udptl.h:39
@ UDPTL_ERROR_CORRECTION_NONE
Definition: udptl.h:38
@ UDPTL_ERROR_CORRECTION_REDUNDANCY
Definition: udptl.h:40
FILE * in
Definition: utils/frame.c:33