1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
/* $Id$ */
/*
* Copyright (C) 2003-2006 Benny Prijono <benny@prijono.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef __PJMEDIA_TRANSPORT_H__
#define __PJMEDIA_TRANSPORT_H__
/**
* @file transport.h Media Transport Interface
* @brief Transport interface.
*/
#include <pjmedia/types.h>
/**
* @defgroup PJMEDIA_TRANSPORT Transports
* @ingroup PJMEDIA
* @brief Transports.
* Transport related components.
*/
/**
* @defgroup PJMEDIA_TRANSPORT_H Network Transport Interface
* @ingroup PJMEDIA_TRANSPORT
* @brief PJMEDIA object for sending/receiving media packets over the network
* @{
* The media transport (#pjmedia_transport) is the object to send and
* receive media packets over the network. Currently only media @ref PJMED_STRM
* are using the transport.
*
* Although currently only @ref PJMEDIA_TRANSPORT_UDP is implemented,
* media transport interface is intended to support any custom transports.
*/
PJ_BEGIN_DECL
/*
* Forward declaration for media transport.
*/
typedef struct pjmedia_transport pjmedia_transport;
/**
* This structure describes the operations for the stream transport.
*/
struct pjmedia_transport_op
{
/**
* This function is called by the stream when the transport is about
* to be used by the stream for the first time, and it tells the transport
* about remote RTP address to send the packet and some callbacks to be
* called for incoming packets.
*/
pj_status_t (*attach)(pjmedia_transport *tp,
pjmedia_stream *strm,
const pj_sockaddr_t *rem_addr,
unsigned addr_len,
void (*rtp_cb)(pjmedia_stream*,
const void*,
pj_ssize_t),
void (*rtcp_cb)(pjmedia_stream*,
const void*,
pj_ssize_t));
/**
* This function is called by the stream when the stream is no longer
* need the transport (normally when the stream is about to be closed).
*/
void (*detach)(pjmedia_transport *tp,
pjmedia_stream *strm);
/**
* This function is called by the stream to send RTP packet using the
* transport.
*/
pj_status_t (*send_rtp)(pjmedia_transport *tp,
const void *pkt,
pj_size_t size);
/**
* This function is called by the stream to send RTCP packet using the
* transport.
*/
pj_status_t (*send_rtcp)(pjmedia_transport *tp,
const void *pkt,
pj_size_t size);
/**
* This function can be called to destroy this transport.
*/
pj_status_t (*destroy)(pjmedia_transport *tp);
};
/**
* @see pjmedia_transport_op.
*/
typedef struct pjmedia_transport_op pjmedia_transport_op;
/**
* This structure declares stream transport. A stream transport is called
* by the stream to transmit a packet, and will notify stream when
* incoming packet is arrived.
*/
struct pjmedia_transport
{
/** Transport name (for logging purpose). */
char name[PJ_MAX_OBJ_NAME];
/** Transport's "virtual" function table. */
pjmedia_transport_op *op;
};
PJ_END_DECL
/**
* @}
*/
#endif /* __PJMEDIA_TRANSPORT_H__ */
|
