Ignore:
Timestamp:
2010-11-19T22:04:12Z (14 years ago)
Author:
Jiri Svoboda <jiri@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
0b4a67a, fdbc3ff
Parents:
a7811f17 (diff), 1bfd3d3 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.
Message:

Merge netstart removal and doxytag cleanup.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • uspace/lib/c/generic/net/socket_client.c

    ra7811f17 ra9c6b966  
    178178/** Returns the active sockets.
    179179 *
    180  *  @returns            The active sockets.
     180 *  @return             The active sockets.
    181181 */
    182182static sockets_t *socket_get_sockets(void)
    … …  
    286286 * Connects to the TCP module if necessary.
    287287 *
    288  * @returns             The TCP module phone.
    289  * @returns             Other error codes as defined for the
     288 * @return              The TCP module phone.
     289 * @return              Other error codes as defined for the
    290290 *                      bind_service_timeout() function.
    291291 */
    … …  
    305305 * Connects to the UDP module if necessary.
    306306 *
    307  * @returns             The UDP module phone.
    308  * @returns             Other error codes as defined for the
     307 * @return              The UDP module phone.
     308 * @return              Other error codes as defined for the
    309309 *                      bind_service_timeout() function.
    310310 */
    … …  
    322322/** Tries to find a new free socket identifier.
    323323 *
    324  * @returns             The new socket identifier.
    325  * @returns             ELIMIT if there is no socket identifier available.
     324 * @return              The new socket identifier.
     325 * @return              ELIMIT if there is no socket identifier available.
    326326 */
    327327static int socket_generate_new_id(void)
    … …  
    387387 * @param[in] type      Socket type.
    388388 * @param[in] protocol  Socket protocol.
    389  * @returns             The socket identifier on success.
    390  * @returns             EPFNOTSUPPORT if the protocol family is not supported.
    391  * @returns             ESOCKNOTSUPPORT if the socket type is not supported.
    392  * @returns             EPROTONOSUPPORT if the protocol is not supported.
    393  * @returns             ENOMEM if there is not enough memory left.
    394  * @returns             ELIMIT if there was not a free socket identifier found
     389 * @return              The socket identifier on success.
     390 * @return              EPFNOTSUPPORT if the protocol family is not supported.
     391 * @return              ESOCKNOTSUPPORT if the socket type is not supported.
     392 * @return              EPROTONOSUPPORT if the protocol is not supported.
     393 * @return              ENOMEM if there is not enough memory left.
     394 * @return              ELIMIT if there was not a free socket identifier found
    395395 *                      this time.
    396  * @returns             Other error codes as defined for the NET_SOCKET message.
    397  * @returns             Other error codes as defined for the
     396 * @return              Other error codes as defined for the NET_SOCKET message.
     397 * @return              Other error codes as defined for the
    398398 *                      bind_service_timeout() function.
    399399 */
    … …  
    509509 * @param[in] data      The data to be sent.
    510510 * @param[in] datalength The data length.
    511  * @returns             EOK on success.
    512  * @returns             ENOTSOCK if the socket is not found.
    513  * @returns             EBADMEM if the data parameter is NULL.
    514  * @returns             NO_DATA if the datalength parameter is zero (0).
    515  * @returns             Other error codes as defined for the spcific message.
     511 * @return              EOK on success.
     512 * @return              ENOTSOCK if the socket is not found.
     513 * @return              EBADMEM if the data parameter is NULL.
     514 * @return              NO_DATA if the datalength parameter is zero (0).
     515 * @return              Other error codes as defined for the spcific message.
    516516 */
    517517static int
    … …  
    554554 * @param[in] my_addr   The port address.
    555555 * @param[in] addrlen   The address length.
    556  * @returns             EOK on success.
    557  * @returns             ENOTSOCK if the socket is not found.
    558  * @returns             EBADMEM if the my_addr parameter is NULL.
    559  * @returns             NO_DATA if the addlen parameter is zero.
    560  * @returns             Other error codes as defined for the NET_SOCKET_BIND
     556 * @return              EOK on success.
     557 * @return              ENOTSOCK if the socket is not found.
     558 * @return              EBADMEM if the my_addr parameter is NULL.
     559 * @return              NO_DATA if the addlen parameter is zero.
     560 * @return              Other error codes as defined for the NET_SOCKET_BIND
    561561 *                      message.
    562562 */
    … …  
    575575 * @param[in] socket_id Socket identifier.
    576576 * @param[in] backlog   The maximum number of waiting sockets to be accepted.
    577  * @returns             EOK on success.
    578  * @returns             EINVAL if the backlog parameter is not positive (<=0).
    579  * @returns             ENOTSOCK if the socket is not found.
    580  * @returns             Other error codes as defined for the NET_SOCKET_LISTEN
     577 * @return              EOK on success.
     578 * @return              EINVAL if the backlog parameter is not positive (<=0).
     579 * @return              ENOTSOCK if the socket is not found.
     580 * @return              Other error codes as defined for the NET_SOCKET_LISTEN
    581581 *                      message.
    582582 */
    … …  
    613613 * @param[out] cliaddr  The remote client address.
    614614 * @param[in] addrlen   The address length.
    615  * @returns             EOK on success.
    616  * @returns             EBADMEM if the cliaddr or addrlen parameter is NULL.
    617  * @returns             EINVAL if the backlog parameter is not positive (<=0).
    618  * @returns             ENOTSOCK if the socket is not found.
    619  * @returns             Other error codes as defined for the NET_SOCKET_ACCEPT
     615 * @return              EOK on success.
     616 * @return              EBADMEM if the cliaddr or addrlen parameter is NULL.
     617 * @return              EINVAL if the backlog parameter is not positive (<=0).
     618 * @return              ENOTSOCK if the socket is not found.
     619 * @return              Other error codes as defined for the NET_SOCKET_ACCEPT
    620620 *                      message.
    621621 */
    … …  
    716716 * @param[in] serv_addr The remote server address.
    717717 * @param[in] addrlen   The address length.
    718  * @returns             EOK on success.
    719  * @returns             EBADMEM if the serv_addr parameter is NULL.
    720  * @returns             NO_DATA if the addlen parameter is zero.
    721  * @returns             ENOTSOCK if the socket is not found.
    722  * @returns             Other error codes as defined for the NET_SOCKET_CONNECT
     718 * @return              EOK on success.
     719 * @return              EBADMEM if the serv_addr parameter is NULL.
     720 * @return              NO_DATA if the addlen parameter is zero.
     721 * @return              ENOTSOCK if the socket is not found.
     722 * @return              Other error codes as defined for the NET_SOCKET_CONNECT
    723723 *                      message.
    724724 */
    … …  
    756756 *
    757757 * @param[in] socket_id Socket identifier.
    758  * @returns             EOK on success.
    759  * @returns             ENOTSOCK if the socket is not found.
    760  * @returns             EINPROGRESS if there is another blocking function in
     758 * @return              EOK on success.
     759 * @return              ENOTSOCK if the socket is not found.
     760 * @return              EINPROGRESS if there is another blocking function in
    761761 *                      progress.
    762  * @returns             Other error codes as defined for the NET_SOCKET_CLOSE
     762 * @return              Other error codes as defined for the NET_SOCKET_CLOSE
    763763 *                      message.
    764764 */
    … …  
    806806 *                      sockets.
    807807 * @param[in] addrlen   The address length. Used only if toaddr is not NULL.
    808  * @returns             EOK on success.
    809  * @returns             ENOTSOCK if the socket is not found.
    810  * @returns             EBADMEM if the data or toaddr parameter is NULL.
    811  * @returns             NO_DATA if the datalength or the addrlen parameter is
     808 * @return              EOK on success.
     809 * @return              ENOTSOCK if the socket is not found.
     810 * @return              EBADMEM if the data or toaddr parameter is NULL.
     811 * @return              NO_DATA if the datalength or the addrlen parameter is
    812812 *                      zero (0).
    813  * @returns             Other error codes as defined for the NET_SOCKET_SENDTO
     813 * @return              Other error codes as defined for the NET_SOCKET_SENDTO
    814814 *                      message.
    815815 */
    … …  
    908908 * @param[in] datalength The data length.
    909909 * @param[in] flags     Various send flags.
    910  * @returns             EOK on success.
    911  * @returns             ENOTSOCK if the socket is not found.
    912  * @returns             EBADMEM if the data parameter is NULL.
    913  * @returns             NO_DATA if the datalength parameter is zero.
    914  * @returns             Other error codes as defined for the NET_SOCKET_SEND
     910 * @return              EOK on success.
     911 * @return              ENOTSOCK if the socket is not found.
     912 * @return              EBADMEM if the data parameter is NULL.
     913 * @return              NO_DATA if the datalength parameter is zero.
     914 * @return              Other error codes as defined for the NET_SOCKET_SEND
    915915 *                      message.
    916916 */
    … …  
    932932 * @param[in] toaddr    The destination address.
    933933 * @param[in] addrlen   The address length.
    934  * @returns             EOK on success.
    935  * @returns             ENOTSOCK if the socket is not found.
    936  * @returns             EBADMEM if the data or toaddr parameter is NULL.
    937  * @returns             NO_DATA if the datalength or the addrlen parameter is
     934 * @return              EOK on success.
     935 * @return              ENOTSOCK if the socket is not found.
     936 * @return              EBADMEM if the data or toaddr parameter is NULL.
     937 * @return              NO_DATA if the datalength or the addrlen parameter is
    938938 *                      zero.
    939  * @returns             Other error codes as defined for the NET_SOCKET_SENDTO
     939 * @return              Other error codes as defined for the NET_SOCKET_SENDTO
    940940 *                      message.
    941941 */
    … …  
    966966 *                      read. The actual address length is set. Used only if
    967967 *                      fromaddr is not NULL.
    968  * @returns             EOK on success.
    969  * @returns             ENOTSOCK if the socket is not found.
    970  * @returns             EBADMEM if the data parameter is NULL.
    971  * @returns             NO_DATA if the datalength or addrlen parameter is zero.
    972  * @returns             Other error codes as defined for the spcific message.
     968 * @return              EOK on success.
     969 * @return              ENOTSOCK if the socket is not found.
     970 * @return              EBADMEM if the data parameter is NULL.
     971 * @return              NO_DATA if the datalength or addrlen parameter is zero.
     972 * @return              Other error codes as defined for the spcific message.
    973973 */
    974974static int
    … …  
    10951095 * @param[in] datalength The data length.
    10961096 * @param[in] flags     Various receive flags.
    1097  * @returns             EOK on success.
    1098  * @returns             ENOTSOCK if the socket is not found.
    1099  * @returns             EBADMEM if the data parameter is NULL.
    1100  * @returns             NO_DATA if the datalength parameter is zero.
    1101  * @returns             Other error codes as defined for the NET_SOCKET_RECV
     1097 * @return              EOK on success.
     1098 * @return              ENOTSOCK if the socket is not found.
     1099 * @return              EBADMEM if the data parameter is NULL.
     1100 * @return              NO_DATA if the datalength parameter is zero.
     1101 * @return              Other error codes as defined for the NET_SOCKET_RECV
    11021102 *                      message.
    11031103 */
    … …  
    11181118 * @param[in,out] addrlen The address length. The maximum address length is
    11191119 *                      read. The actual address length is set.
    1120  * @returns             EOK on success.
    1121  * @returns             ENOTSOCK if the socket is not found.
    1122  * @returns             EBADMEM if the data or fromaddr parameter is NULL.
    1123  * @returns             NO_DATA if the datalength or addrlen parameter is zero.
    1124  * @returns             Other error codes as defined for the NET_SOCKET_RECVFROM
     1120 * @return              EOK on success.
     1121 * @return              ENOTSOCK if the socket is not found.
     1122 * @return              EBADMEM if the data or fromaddr parameter is NULL.
     1123 * @return              NO_DATA if the datalength or addrlen parameter is zero.
     1124 * @return              Other error codes as defined for the NET_SOCKET_RECVFROM
    11251125 *                      message.
    11261126 */
    … …  
    11481148 * @param[in,out] optlen The value buffer length. The maximum length is read.
    11491149 *                      The actual length is set.
    1150  * @returns             EOK on success.
    1151  * @returns             ENOTSOCK if the socket is not found.
    1152  * @returns             EBADMEM if the value or optlen parameter is NULL.
    1153  * @returns             NO_DATA if the optlen parameter is zero.
    1154  * @returns             Other error codes as defined for the
     1150 * @return              EOK on success.
     1151 * @return              ENOTSOCK if the socket is not found.
     1152 * @return              EBADMEM if the value or optlen parameter is NULL.
     1153 * @return              NO_DATA if the optlen parameter is zero.
     1154 * @return              Other error codes as defined for the
    11551155 *                      NET_SOCKET_GETSOCKOPT message.
    11561156 */
    … …  
    12011201 * @param[in] value     The value to be set.
    12021202 * @param[in] optlen    The value length.
    1203  * @returns             EOK on success.
    1204  * @returns             ENOTSOCK if the socket is not found.
    1205  * @returns             EBADMEM if the value parameter is NULL.
    1206  * @returns             NO_DATA if the optlen parameter is zero.
    1207  * @returns             Other error codes as defined for the
     1203 * @return              EOK on success.
     1204 * @return              ENOTSOCK if the socket is not found.
     1205 * @return              EBADMEM if the value parameter is NULL.
     1206 * @return              NO_DATA if the optlen parameter is zero.
     1207 * @return              Other error codes as defined for the
    12081208 *                      NET_SOCKET_SETSOCKOPT message.
    12091209 */
Note: See TracChangeset for help on using the changeset viewer.