| Tristan Matthews | 0a329cc | 2013-07-17 13:20:14 -0400 | [diff] [blame] | 1 | /* $Id$ */ |
| 2 | /* |
| 3 | * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com) |
| 4 | * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org> |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; either version 2 of the License, or |
| 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU General Public License |
| 17 | * along with this program; if not, write to the Free Software |
| 18 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 19 | */ |
| 20 | #ifndef __PJMEDIA_TRANSPORT_ADAPTER_SAMPLE_H__ |
| 21 | #define __PJMEDIA_TRANSPORT_ADAPTER_SAMPLE_H__ |
| 22 | |
| 23 | |
| 24 | /** |
| 25 | * @file transport_adapter_sample.h |
| 26 | * @brief Sample Media Transport Adapter |
| 27 | */ |
| 28 | |
| 29 | #include <pjmedia/transport.h> |
| 30 | |
| 31 | |
| 32 | /** |
| 33 | * @defgroup PJMEDIA_TRANSPORT_ADAPTER_SAMPLE Sample Transport Adapter |
| 34 | * @ingroup PJMEDIA_TRANSPORT |
| 35 | * @brief Example on how to create transport adapter. |
| 36 | * @{ |
| 37 | * |
| 38 | * This describes a sample implementation of transport adapter, similar to |
| 39 | * the way the SRTP transport adapter works. |
| 40 | */ |
| 41 | |
| 42 | PJ_BEGIN_DECL |
| 43 | |
| 44 | |
| 45 | /** |
| 46 | * Create the transport adapter, specifying the underlying transport to be |
| 47 | * used to send and receive RTP/RTCP packets. |
| 48 | * |
| 49 | * @param endpt The media endpoint. |
| 50 | * @param name Optional name to identify this media transport |
| 51 | * for logging purposes. |
| 52 | * @param base_tp The base/underlying media transport to send and |
| 53 | * receive RTP/RTCP packets. |
| 54 | * @param del_base Specify whether the base transport should also be |
| 55 | * destroyed when destroy() is called upon us. |
| 56 | * @param p_tp Pointer to receive the media transport instance. |
| 57 | * |
| 58 | * @return PJ_SUCCESS on success, or the appropriate error code. |
| 59 | */ |
| 60 | PJ_DECL(pj_status_t) pjmedia_tp_adapter_create( pjmedia_endpt *endpt, |
| 61 | const char *name, |
| 62 | pjmedia_transport *base_tp, |
| 63 | pj_bool_t del_base, |
| 64 | pjmedia_transport **p_tp); |
| 65 | |
| 66 | PJ_END_DECL |
| 67 | |
| 68 | |
| 69 | /** |
| 70 | * @} |
| 71 | */ |
| 72 | |
| 73 | |
| 74 | #endif /* __PJMEDIA_TRANSPORT_ADAPTER_SAMPLE_H__ */ |
| 75 | |
| 76 | |