Changeset 1735 for pjproject/trunk/pjmedia/include/pjmedia/transport_ice.h
- Timestamp:
- Jan 23, 2008 8:39:07 PM (16 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
pjproject/trunk/pjmedia/include/pjmedia/transport_ice.h
r1436 r1735 17 17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 18 18 */ 19 #ifndef __ pjmedia_ice_H__20 #define __ pjmedia_ice_H__19 #ifndef __PJMEDIA_TRANSPORT_ICE_H__ 20 #define __PJMEDIA_TRANSPORT_ICE_H__ 21 21 22 22 … … 75 75 const pjmedia_ice_cb *cb, 76 76 pjmedia_transport **p_tp); 77 78 /**79 * Destroy the media transport.80 *81 * @param tp The media transport.82 *83 * @return PJ_SUCCESS.84 */85 PJ_DECL(pj_status_t) pjmedia_ice_destroy(pjmedia_transport *tp);86 77 87 78 … … 170 161 const pj_str_t *local_passwd); 171 162 172 /**173 * Modify the SDP to add ICE specific SDP attributes before sending174 * the SDP to remote host.175 *176 * @param tp The media transport.177 * @param pool Pool to allocate memory for the SDP elements.178 * @param sdp The SDP descriptor to be modified.179 *180 * @return PJ_SUCCESS, or the appropriate error code.181 */182 PJ_DECL(pj_status_t) pjmedia_ice_modify_sdp(pjmedia_transport *tp,183 pj_pool_t *pool,184 pjmedia_sdp_session *sdp);185 186 /**187 * Start ICE connectivity checks.188 *189 * This function will pair the local and remote candidates to create190 * check list. Once the check list is created and sorted based on the191 * priority, ICE periodic checks will be started. This function will192 * return immediately, and application will be notified about the193 * connectivity check status in the callback.194 *195 * @param tp The media transport.196 * @param pool Memory pool to parse the SDP.197 * @param rem_sdp The SDP received from remote agent.198 * @param media_index The media index (in SDP) to process.199 *200 * @return PJ_SUCCESS, or the appropriate error code.201 */202 PJ_DECL(pj_status_t) pjmedia_ice_start_ice(pjmedia_transport *tp,203 pj_pool_t *pool,204 const pjmedia_sdp_session *rem_sdp,205 unsigned media_index);206 207 /**208 * Stop the ICE session (typically when the call is terminated). Application209 * may restart the ICE session again by calling #pjmedia_ice_init_ice(),210 * for example to use this media transport for the next call.211 *212 * @param tp The media transport.213 *214 * @return PJ_SUCCESS, or the appropriate error code.215 */216 PJ_DECL(pj_status_t) pjmedia_ice_stop_ice(pjmedia_transport *tp);217 218 219 /**220 * Simulate packet lost in the specified direction (for testing purposes).221 * When enabled, the transport will randomly drop packets to the specified222 * direction.223 *224 * @param tp The ICE media transport.225 * @param dir Media direction to which packets will be randomly dropped.226 * @param pct_lost Percent lost (0-100). Set to zero to disable packet227 * lost simulation.228 *229 * @return PJ_SUCCESS on success.230 */231 PJ_DECL(pj_status_t) pjmedia_ice_simulate_lost(pjmedia_transport *tp,232 pjmedia_dir dir,233 unsigned pct_lost);234 235 236 237 163 238 164 PJ_END_DECL … … 244 170 245 171 246 #endif /* __ pjmedia_ice_H__ */172 #endif /* __PJMEDIA_TRANSPORT_ICE_H__ */ 247 173 248 174
Note: See TracChangeset
for help on using the changeset viewer.