<p>dexter has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/osmo-mgw/+/18896">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">cosmetic: fix doxygen<br><br>Change-Id: I31f7ccf748d09062dbb82f3e921a90e77db02a3d<br>---<br>M src/libosmo-mgcp/mgcp_network.c<br>1 file changed, 46 insertions(+), 46 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/osmo-mgw refs/changes/96/18896/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/src/libosmo-mgcp/mgcp_network.c b/src/libosmo-mgcp/mgcp_network.c</span><br><span>index 8efc6b7..1ad9c1a 100644</span><br><span>--- a/src/libosmo-mgcp/mgcp_network.c</span><br><span>+++ b/src/libosmo-mgcp/mgcp_network.c</span><br><span>@@ -75,8 +75,8 @@</span><br><span> }</span><br><span> </span><br><span> /*! Determine the local rtp bind IP-address.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[out] addr caller provided memory to store the resulting IP-Address</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] endp mgcp endpoint, that holds a copy of the VTY parameters</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[out] addr caller provided memory to store the resulting IP-Address.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] endp mgcp endpoint, that holds a copy of the VTY parameters.</span><br><span> *</span><br><span> * The local bind IP-address is automatically selected by probing the</span><br><span> * IP-Address of the interface that is pointing towards the remote IP-Address,</span><br><span>@@ -145,12 +145,12 @@</span><br><span> }</span><br><span> </span><br><span> /*! send udp packet.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] fd associated file descriptor</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] addr destination ip-address</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] port destination UDP port (network byte order)</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] buf buffer that holds the data to be send</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] len length of the data to be sent</span><br><span style="color: hsl(0, 100%, 40%);">- * \returns bytes sent, -1 on error */</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] fd associated file descriptor.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] addr destination ip-address.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] port destination UDP port (network byte order).</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] buf buffer that holds the data to be send.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] len length of the data to be sent.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns bytes sent, -1 on error. */</span><br><span> int mgcp_udp_send(int fd, struct in_addr *addr, int port, char *buf, int len)</span><br><span> {</span><br><span> struct sockaddr_in out;</span><br><span>@@ -167,9 +167,9 @@</span><br><span> }</span><br><span> </span><br><span> /*! send RTP dummy packet (to keep NAT connection open).</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] endp mcgp endpoint that holds the RTP connection</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] conn associated RTP connection</span><br><span style="color: hsl(0, 100%, 40%);">- * \returns bytes sent, -1 on error */</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] endp mcgp endpoint that holds the RTP connection.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] conn associated RTP connection.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns bytes sent, -1 on error. */</span><br><span> int mgcp_send_dummy(struct mgcp_endpoint *endp, struct mgcp_conn_rtp *conn)</span><br><span> {</span><br><span> static char buf[] = { MGCP_DUMMY_LOAD };</span><br><span>@@ -395,12 +395,12 @@</span><br><span> }</span><br><span> </span><br><span> /*! dummy callback to disable transcoding (see also cfg->rtp_processing_cb).</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] associated endpoint</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] destination RTP end</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in,out] pointer to buffer with voice data</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] voice data length</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] maximum size of caller provided voice data buffer</span><br><span style="color: hsl(0, 100%, 40%);">- * \returns ignores input parameters, return always 0 */</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] associated endpoint.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] destination RTP end.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in,out] pointer to buffer with voice data.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] voice data length.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] maximum size of caller provided voice data buffer.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns ignores input parameters, return always 0. */</span><br><span> int mgcp_rtp_processing_default(struct mgcp_endpoint *endp,</span><br><span> struct mgcp_rtp_end *dst_end,</span><br><span> char *data, int *len, int buf_size)</span><br><span>@@ -410,10 +410,10 @@</span><br><span> }</span><br><span> </span><br><span> /*! dummy callback to disable transcoding (see also cfg->setup_rtp_processing_cb).</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] associated endpoint</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] destination RTP connnection</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] source RTP connection</span><br><span style="color: hsl(0, 100%, 40%);">- * \returns ignores input parameters, return always 0 */</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] associated endpoint.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] destination RTP connnection.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] source RTP connection.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns ignores input parameters, return always 0. */</span><br><span> int mgcp_setup_rtp_processing_default(struct mgcp_endpoint *endp,</span><br><span> struct mgcp_conn_rtp *conn_dst,</span><br><span> struct mgcp_conn_rtp *conn_src)</span><br><span>@@ -803,14 +803,14 @@</span><br><span> }</span><br><span> </span><br><span> /*! Send RTP/RTCP data to a specified destination connection.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] endp associated endpoint (for configuration, logging)</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] is_rtp flag to specify if the packet is of type RTP or RTCP</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] spoofed source address (set to NULL to disable)</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] buf buffer that contains the RTP/RTCP data</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] len length of the buffer that contains the RTP/RTCP data</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] conn_src associated source connection</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] conn_dst associated destination connection</span><br><span style="color: hsl(0, 100%, 40%);">- * \returns 0 on success, -1 on ERROR */</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] endp associated endpoint (for configuration, logging).</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] is_rtp flag to specify if the packet is of type RTP or RTCP.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] spoofed source address (set to NULL to disable).</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] buf buffer that contains the RTP/RTCP data.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] len length of the buffer that contains the RTP/RTCP data.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] conn_src associated source connection.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] conn_dst associated destination connection.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns 0 on success, -1 on ERROR. */</span><br><span> int mgcp_send(struct mgcp_endpoint *endp, int is_rtp, struct sockaddr_in *addr,</span><br><span> char *buf, int len, struct mgcp_conn_rtp *conn_src,</span><br><span> struct mgcp_conn_rtp *conn_dst)</span><br><span>@@ -1259,12 +1259,12 @@</span><br><span> }</span><br><span> </span><br><span> /*! dispatch incoming RTP packet to opposite RTP connection.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] proto protocol (MGCP_CONN_TYPE_RTP or MGCP_CONN_TYPE_RTCP)</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] addr socket address where the RTP packet has been received from</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] buf buffer that hold the RTP payload</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] buf_size size data length of buf</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] conn originating connection</span><br><span style="color: hsl(0, 100%, 40%);">- * \returns 0 on success, -1 on ERROR */</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] proto protocol (MGCP_CONN_TYPE_RTP or MGCP_CONN_TYPE_RTCP).</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] addr socket address where the RTP packet has been received from.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] buf buffer that hold the RTP payload.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] buf_size size data length of buf.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] conn originating connection.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns 0 on success, -1 on ERROR. */</span><br><span> int mgcp_dispatch_rtp_bridge_cb(int proto, struct sockaddr_in *addr, char *buf,</span><br><span> unsigned int buf_size, struct mgcp_conn *conn)</span><br><span> {</span><br><span>@@ -1399,9 +1399,9 @@</span><br><span> }</span><br><span> </span><br><span> /*! set IP Type of Service parameter.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] fd associated file descriptor</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] tos dscp value</span><br><span style="color: hsl(0, 100%, 40%);">- * \returns 0 on success, -1 on ERROR */</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] fd associated file descriptor.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] tos dscp value.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns 0 on success, -1 on ERROR. */</span><br><span> int mgcp_set_ip_tos(int fd, int tos)</span><br><span> {</span><br><span> int ret;</span><br><span>@@ -1413,10 +1413,10 @@</span><br><span> }</span><br><span> </span><br><span> /*! bind RTP port to osmo_fd.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] source_addr source (local) address to bind on</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] fd associated file descriptor</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] port to bind on</span><br><span style="color: hsl(0, 100%, 40%);">- * \returns 0 on success, -1 on ERROR */</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] source_addr source (local) address to bind on.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] fd associated file descriptor.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] port to bind on.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns 0 on success, -1 on ERROR. */</span><br><span> int mgcp_create_bind(const char *source_addr, struct osmo_fd *fd, int port)</span><br><span> {</span><br><span> int rc;</span><br><span>@@ -1492,10 +1492,10 @@</span><br><span> }</span><br><span> </span><br><span> /*! bind RTP port to endpoint/connection.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] endp endpoint that holds the RTP connection</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] rtp_port port number to bind on</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] conn associated RTP connection</span><br><span style="color: hsl(0, 100%, 40%);">- * \returns 0 on success, -1 on ERROR */</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] endp endpoint that holds the RTP connection.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] rtp_port port number to bind on.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] conn associated RTP connection.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns 0 on success, -1 on ERROR. */</span><br><span> int mgcp_bind_net_rtp_port(struct mgcp_endpoint *endp, int rtp_port,</span><br><span> struct mgcp_conn_rtp *conn)</span><br><span> {</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/osmo-mgw/+/18896">change 18896</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/osmo-mgw/+/18896"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: osmo-mgw </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I31f7ccf748d09062dbb82f3e921a90e77db02a3d </div>
<div style="display:none"> Gerrit-Change-Number: 18896 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: dexter <pmaier@sysmocom.de> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>