Changeset 483 for pjproject/trunk/pjmedia/include/pjmedia/transport_udp.h

Timestamp:

Jun 1, 2006 11:37:30 AM (18 years ago)

Author:

bennylp

Message:

Added options in pjmedia UDP transport to disable source address checking

File:

• pjproject/trunk/pjmedia/include/pjmedia/transport_udp.h (modified) (1 diff)

pjproject/trunk/pjmedia/include/pjmedia/transport_udp.h

@@ -30 +30 @@
 
 /**
- * Create UDP stream transport.
+ * Options that can be specified when creating UDP transport.
+ */
+enum pjmedia_transport_udp_options
+{
+    /**
+     * Normally the UDP transport will continuously check the source address
+     * of incoming packets to see if it is different than the configured
+     * remote address, and switch the remote address to the source address
+     * of the packet if they are different after several packets are
+     * received.
+     * Specifying this option will disable this feature.
+     */
+    PJMEDIA_UDP_NO_SRC_ADDR_CHECKING = 1,
+};
+
+
+/**
+ * Create an RTP and RTCP sockets and bind RTP the socket to the specified
+ * port to create media transport.
+ *
+ * @param endpt     The media endpoint instance.
+ * @param name      Optional name to be assigned to the transport.
+ * @param port      UDP port number for the RTP socket. The RTCP port number
+ *                  will be set to one above RTP port.
+ * @param options   Options, bitmask of #pjmedia_transport_udp_options.
+ * @param p_tp      Pointer to receive the transport instance.
+ *
+ * @return          PJ_SUCCESS on success.
  */
 PJ_DECL(pj_status_t) pjmedia_transport_udp_create(pjmedia_endpt *endpt,
                                                   const char *name,
                                                   int port,
+                                                  unsigned options,
                                                   pjmedia_transport **p_tp);
 
 
 /**
- * Create UDP stream transport from existing socket info.
+ * Create UDP stream transport from existing sockets. Use this function when
+ * the sockets have previously been created.
+ *
+ * @param endpt     The media endpoint instance.
+ * @param name      Optional name to be assigned to the transport.
+ * @param si        Media socket info containing the RTP and RTCP sockets.
+ * @param options   Options, bitmask of #pjmedia_transport_udp_options.
+ * @param p_tp      Pointer to receive the transport instance.
+ *
+ * @return          PJ_SUCCESS on success.
  */
 PJ_DECL(pj_status_t) pjmedia_transport_udp_attach(pjmedia_endpt *endpt,
                                                   const char *name,
                                                   const pjmedia_sock_info *si,
+                                                  unsigned options,
                                                   pjmedia_transport **p_tp);
 
 
 /**
- * Close UDP transport.
+ * Close UDP transport. Application can also use the "destroy" member of
+ * media transport interface to close the UDP transport.
  */
 PJ_DECL(pj_status_t) pjmedia_transport_udp_close(pjmedia_transport *tp);