Be consistent... Use Name: consistent in function headers vs Function:

This commit is contained in:
Gregory Nutt
2017-04-21 16:33:14 -06:00
parent 2c4800f511
commit d5207efb5a
213 changed files with 730 additions and 730 deletions
+2 -2
View File
@@ -61,7 +61,7 @@
****************************************************************************/
/****************************************************************************
* Function: psock_accept
* Name: psock_accept
*
* Description:
* The psock_accept function is used with connection-based socket types
@@ -305,7 +305,7 @@ errout:
}
/****************************************************************************
* Function: accept
* Name: accept
*
* Description:
* The accept function is used with connection-based socket types
+3 -3
View File
@@ -68,7 +68,7 @@
****************************************************************************/
/****************************************************************************
* Function: pkt_bind
* Name: pkt_bind
*
* Description:
* Bind a raw socket to an network device.
@@ -122,7 +122,7 @@ static int pkt_bind(FAR struct pkt_conn_s *conn,
****************************************************************************/
/****************************************************************************
* Function: psock_bind
* Name: psock_bind
*
* Description:
* bind() gives the socket 'psock' the local address 'addr'. 'addr' is
@@ -345,7 +345,7 @@ errout:
}
/****************************************************************************
* Function: bind
* Name: bind
*
* Description:
* bind() gives the socket 'sockfd' the local address 'addr'. 'addr' is
+3 -3
View File
@@ -64,7 +64,7 @@
****************************************************************************/
/****************************************************************************
* Function: get_ipv4_sockname
* Name: get_ipv4_sockname
*
* Description:
* The getsockname() function retrieves the locally-bound name of the
@@ -187,7 +187,7 @@ int ipv4_getsockname(FAR struct socket *psock, FAR struct sockaddr *addr,
#endif
/****************************************************************************
* Function: ipv6_getsockname
* Name: ipv6_getsockname
*
* Description:
* The getsockname() function retrieves the locally-bound name of the
@@ -314,7 +314,7 @@ int ipv6_getsockname(FAR struct socket *psock, FAR struct sockaddr *addr,
****************************************************************************/
/****************************************************************************
* Function: getsockname
* Name: getsockname
*
* Description:
* The getsockname() function retrieves the locally-bound name of the
+2 -2
View File
@@ -56,7 +56,7 @@
****************************************************************************/
/****************************************************************************
* Function: psock_getsockopt
* Name: psock_getsockopt
*
* Description:
* getsockopt() retrieve thse value for the option specified by the
@@ -277,7 +277,7 @@ errout:
}
/****************************************************************************
* Function: getsockopt
* Name: getsockopt
*
* Description:
* getsockopt() retrieve thse value for the option specified by the
+2 -2
View File
@@ -55,7 +55,7 @@
****************************************************************************/
/****************************************************************************
* Function: psock_listen
* Name: psock_listen
*
* Description:
* To accept connections, a socket is first created with psock_socket(), a
@@ -168,7 +168,7 @@ errout:
}
/****************************************************************************
* Function: listen
* Name: listen
*
* Description:
* To accept connections, a socket is first created with socket(), a
+1 -1
View File
@@ -58,7 +58,7 @@
****************************************************************************/
/****************************************************************************
* Function: net_clone
* Name: net_clone
*
* Description:
* Performs the low level, common portion of net_dupsd() and net_dupsd2()
+7 -7
View File
@@ -91,7 +91,7 @@ struct tcp_close_s
****************************************************************************/
/****************************************************************************
* Function: close_timeout
* Name: close_timeout
*
* Description:
* Check for a timeout on a lingering close.
@@ -136,7 +136,7 @@ static inline int close_timeout(FAR struct tcp_close_s *pstate)
#endif /* NET_TCP_HAVE_STACK && CONFIG_NET_SOLINGER */
/****************************************************************************
* Function: netclose_interrupt
* Name: netclose_interrupt
*
* Description:
* Handle network callback events.
@@ -260,7 +260,7 @@ end_wait:
#endif /* NET_TCP_HAVE_STACK */
/****************************************************************************
* Function: netclose_txnotify
* Name: netclose_txnotify
*
* Description:
* Notify the appropriate device driver that we are have data ready to
@@ -317,7 +317,7 @@ static inline void netclose_txnotify(FAR struct socket *psock,
#endif /* NET_TCP_HAVE_STACK */
/****************************************************************************
* Function: netclose_disconnect
* Name: netclose_disconnect
*
* Description:
* Break any current TCP connection
@@ -455,7 +455,7 @@ static inline int netclose_disconnect(FAR struct socket *psock)
#endif /* NET_TCP_HAVE_STACK */
/****************************************************************************
* Function: local_close
* Name: local_close
*
* Description:
* Performs the close operation on a local socket instance
@@ -498,7 +498,7 @@ static void local_close(FAR struct socket *psock)
****************************************************************************/
/****************************************************************************
* Function: psock_close
* Name: psock_close
*
* Description:
* Performs the close operation on a socket instance
@@ -733,7 +733,7 @@ errout:
}
/****************************************************************************
* Function: net_close
* Name: net_close
*
* Description:
* Performs the close operation on socket descriptors
+1 -1
View File
@@ -53,7 +53,7 @@
****************************************************************************/
/****************************************************************************
* Function: net_dupsd
* Name: net_dupsd
*
* Description:
* Clone a socket descriptor to an arbitrary descriptor number. If file
+1 -1
View File
@@ -53,7 +53,7 @@
****************************************************************************/
/****************************************************************************
* Function: net_dupsd2
* Name: net_dupsd2
*
* Description:
* Clone a socket descriptor to an arbitray descriptor number. If file
+4 -4
View File
@@ -70,7 +70,7 @@
****************************************************************************/
/****************************************************************************
* Function: net_pollsetup
* Name: net_pollsetup
*
* Description:
* Setup to monitor events on one socket
@@ -138,7 +138,7 @@ static inline int net_pollsetup(FAR struct socket *psock,
}
/****************************************************************************
* Function: net_pollteardown
* Name: net_pollteardown
*
* Description:
* Teardown monitoring of events on an socket
@@ -211,7 +211,7 @@ static inline int net_pollteardown(FAR struct socket *psock,
****************************************************************************/
/****************************************************************************
* Function: psock_poll
* Name: psock_poll
*
* Description:
* The standard poll() operation redirects operations on socket descriptors
@@ -264,7 +264,7 @@ int psock_poll(FAR struct socket *psock, FAR struct pollfd *fds, bool setup)
}
/****************************************************************************
* Function: net_poll
* Name: net_poll
*
* Description:
* The standard poll() operation redirects operations on socket descriptors
+5 -5
View File
@@ -115,7 +115,7 @@ struct sendfile_s
****************************************************************************/
/****************************************************************************
* Function: sendfile_timeout
* Name: sendfile_timeout
*
* Description:
* Check for send timeout.
@@ -238,7 +238,7 @@ static uint16_t ack_interrupt(FAR struct net_driver_s *dev, FAR void *pvconn,
}
/****************************************************************************
* Function: sendfile_addrcheck
* Name: sendfile_addrcheck
*
* Description:
* Check if the destination IP address is in the IPv4 ARP or IPv6 Neighbor
@@ -301,7 +301,7 @@ static inline bool sendfile_addrcheck(FAR struct tcp_conn_s *conn)
#endif /* CONFIG_NET_ETHERNET */
/****************************************************************************
* Function: sendfile_interrupt
* Name: sendfile_interrupt
*
* Description:
* This function is called from the interrupt level to perform the actual
@@ -478,7 +478,7 @@ wait:
}
/****************************************************************************
* Function: sendfile_txnotify
* Name: sendfile_txnotify
*
* Description:
* Notify the appropriate device driver that we are have data ready to
@@ -537,7 +537,7 @@ static inline void sendfile_txnotify(FAR struct socket *psock,
****************************************************************************/
/****************************************************************************
* Function: net_sendfile
* Name: net_sendfile
*
* Description:
* The send() call may be used only when the socket is in a connected state
+1 -1
View File
@@ -52,7 +52,7 @@
****************************************************************************/
/****************************************************************************
* Function: net_timeo
* Name: net_timeo
*
* Description:
* Check if a timeout has elapsed. This can be called from a socket poll
+1 -1
View File
@@ -51,7 +51,7 @@
****************************************************************************/
/****************************************************************************
* Function: recv
* Name: recv
*
* Description:
* The recv() call is identical to recvfrom() with a NULL from parameter.
+23 -23
View File
@@ -115,7 +115,7 @@ struct recvfrom_s
****************************************************************************/
/****************************************************************************
* Function: recvfrom_add_recvlen
* Name: recvfrom_add_recvlen
*
* Description:
* Update information about space available for new data and update size
@@ -149,7 +149,7 @@ static inline void recvfrom_add_recvlen(FAR struct recvfrom_s *pstate,
#endif /* NET_UDP_HAVE_STACK || NET_TCP_HAVE_STACK || CONFIG_NET_PKT */
/****************************************************************************
* Function: recvfrom_newdata
* Name: recvfrom_newdata
*
* Description:
* Copy the read data from the packet
@@ -197,7 +197,7 @@ static size_t recvfrom_newdata(FAR struct net_driver_s *dev,
#endif /* NET_UDP_HAVE_STACK || NET_TCP_HAVE_STACK */
/****************************************************************************
* Function: recvfrom_newpktdata
* Name: recvfrom_newpktdata
*
* Description:
* Copy the read data from the packet
@@ -241,7 +241,7 @@ static void recvfrom_newpktdata(FAR struct net_driver_s *dev,
#endif /* CONFIG_NET_PKT */
/****************************************************************************
* Function: recvfrom_newtcpdata
* Name: recvfrom_newtcpdata
*
* Description:
* Copy the read data from the packet
@@ -313,7 +313,7 @@ static inline void recvfrom_newtcpdata(FAR struct net_driver_s *dev,
#endif /* NET_TCP_HAVE_STACK */
/****************************************************************************
* Function: recvfrom_newudpdata
* Name: recvfrom_newudpdata
*
* Description:
* Copy the read data from the packet
@@ -345,7 +345,7 @@ static inline void recvfrom_newudpdata(FAR struct net_driver_s *dev,
#endif /* NET_UDP_HAVE_STACK */
/****************************************************************************
* Function: recvfrom_tcpreadahead
* Name: recvfrom_tcpreadahead
*
* Description:
* Copy the read data from the packet
@@ -513,7 +513,7 @@ out:
#endif
/****************************************************************************
* Function: recvfrom_timeout
* Name: recvfrom_timeout
*
* Description:
* Check for recvfrom timeout.
@@ -587,7 +587,7 @@ static int recvfrom_timeout(struct recvfrom_s *pstate)
#endif /* NET_UDP_HAVE_STACK || NET_TCP_HAVE_STACK */
/****************************************************************************
* Function: recvfrom_pktsender
* Name: recvfrom_pktsender
*
* Description:
*
@@ -607,7 +607,7 @@ static inline void recvfrom_pktsender(FAR struct net_driver_s *dev,
#endif /* CONFIG_NET_PKT */
/****************************************************************************
* Function: recvfrom_pktinterrupt
* Name: recvfrom_pktinterrupt
*
* Description:
*
@@ -670,7 +670,7 @@ static uint16_t recvfrom_pktinterrupt(FAR struct net_driver_s *dev,
#endif /* CONFIG_NET_PKT */
/****************************************************************************
* Function: recvfrom_tcpsender
* Name: recvfrom_tcpsender
*
* Description:
* Getting the sender's address from the UDP packet
@@ -741,7 +741,7 @@ static inline void recvfrom_tcpsender(FAR struct net_driver_s *dev,
#endif /* NET_TCP_HAVE_STACK */
/****************************************************************************
* Function: recvfrom_tcpinterrupt
* Name: recvfrom_tcpinterrupt
*
* Description:
* This function is called from the interrupt level to perform the actual
@@ -964,7 +964,7 @@ static uint16_t recvfrom_tcpinterrupt(FAR struct net_driver_s *dev,
#endif /* NET_TCP_HAVE_STACK */
/****************************************************************************
* Function: recvfrom_udpsender
* Name: recvfrom_udpsender
*
* Description:
* Getting the sender's address from the UDP packet
@@ -1065,7 +1065,7 @@ static inline void recvfrom_udpsender(struct net_driver_s *dev, struct recvfrom_
#endif /* NET_UDP_HAVE_STACK */
/****************************************************************************
* Function: recvfrom_udp_terminate
* Name: recvfrom_udp_terminate
*
* Description:
* Terminate the UDP transfer.
@@ -1101,7 +1101,7 @@ static void recvfrom_udp_terminate(FAR struct recvfrom_s *pstate, int result)
#endif /* NET_UDP_HAVE_STACK */
/****************************************************************************
* Function: recvfrom_udp_interrupt
* Name: recvfrom_udp_interrupt
*
* Description:
* This function is called from the interrupt level to perform the actual
@@ -1195,7 +1195,7 @@ static uint16_t recvfrom_udp_interrupt(FAR struct net_driver_s *dev,
#endif /* NET_UDP_HAVE_STACK */
/****************************************************************************
* Function: recvfrom_init
* Name: recvfrom_init
*
* Description:
* Initialize the state structure
@@ -1253,7 +1253,7 @@ static void recvfrom_init(FAR struct socket *psock, FAR void *buf,
#endif /* NET_UDP_HAVE_STACK || NET_TCP_HAVE_STACK */
/****************************************************************************
* Function: recvfrom_result
* Name: recvfrom_result
*
* Description:
* Evaluate the result of the recv operations
@@ -1302,7 +1302,7 @@ static ssize_t recvfrom_result(int result, struct recvfrom_s *pstate)
#endif /* NET_UDP_HAVE_STACK || NET_TCP_HAVE_STACK */
/****************************************************************************
* Function: recvfromo_pkt_rxnotify
* Name: recvfromo_pkt_rxnotify
*
* Description:
* Notify the appropriate device driver that we are ready to receive a
@@ -1324,7 +1324,7 @@ static void recvfromo_pkt_rxnotify(FAR struct pkt_conn_s *conn)
#endif
/****************************************************************************
* Function: recvfrom_udp_rxnotify
* Name: recvfrom_udp_rxnotify
*
* Description:
* Notify the appropriate device driver that we are ready to receive a
@@ -1381,7 +1381,7 @@ static inline void recvfrom_udp_rxnotify(FAR struct socket *psock,
#endif /* NET_UDP_HAVE_STACK */
/****************************************************************************
* Function: pkt_recvfrom
* Name: pkt_recvfrom
*
* Description:
* Perform the recvfrom operation for packet socket
@@ -1475,7 +1475,7 @@ errout_with_state:
#endif /* CONFIG_NET_PKT */
/****************************************************************************
* Function: udp_recvfrom
* Name: udp_recvfrom
*
* Description:
* Perform the recvfrom operation for a UDP SOCK_DGRAM
@@ -1615,7 +1615,7 @@ errout_with_state:
#endif /* NET_UDP_HAVE_STACK */
/****************************************************************************
* Function: tcp_recvfrom
* Name: tcp_recvfrom
*
* Description:
* Perform the recvfrom operation for a TCP/IP SOCK_STREAM
@@ -1797,7 +1797,7 @@ static ssize_t tcp_recvfrom(FAR struct socket *psock, FAR void *buf, size_t len,
****************************************************************************/
/****************************************************************************
* Function: psock_recvfrom
* Name: psock_recvfrom
*
* Description:
* recvfrom() receives messages from a socket, and may be used to receive
@@ -2057,7 +2057,7 @@ errout:
}
/****************************************************************************
* Function: recvfrom
* Name: recvfrom
*
* Description:
* recvfrom() receives messages from a socket, and may be used to receive
+2 -2
View File
@@ -58,7 +58,7 @@
****************************************************************************/
/****************************************************************************
* Function: psock_send
* Name: psock_send
*
* Description:
* The send() call may be used only when the socket is in a connected state
@@ -259,7 +259,7 @@ ssize_t psock_send(FAR struct socket *psock, FAR const void *buf, size_t len,
}
/****************************************************************************
* Function: send
* Name: send
*
* Description:
* The send() call may be used only when the socket is in a connected state
+2 -2
View File
@@ -59,7 +59,7 @@
****************************************************************************/
/****************************************************************************
* Function: psock_sendto
* Name: psock_sendto
*
* Description:
* If sendto() is used on a connection-mode (SOCK_STREAM, SOCK_SEQPACKET)
@@ -279,7 +279,7 @@ errout:
}
/****************************************************************************
* Function: sendto
* Name: sendto
*
* Description:
* If sendto() is used on a connection-mode (SOCK_STREAM, SOCK_SEQPACKET)
+2 -2
View File
@@ -60,7 +60,7 @@
****************************************************************************/
/****************************************************************************
* Function: psock_setsockopt
* Name: psock_setsockopt
*
* Description:
* psock_setsockopt() sets the option specified by the 'option' argument,
@@ -315,7 +315,7 @@ errout:
}
/****************************************************************************
* Function: setsockopt
* Name: setsockopt
*
* Description:
* setsockopt() sets the option specified by the 'option' argument,
+2 -2
View File
@@ -205,7 +205,7 @@ static int psock_local_alloc(FAR struct socket *psock)
****************************************************************************/
/****************************************************************************
* Function: psock_socket
* Name: psock_socket
*
* Description:
* socket() creates an endpoint for communication and returns a socket
@@ -545,7 +545,7 @@ errout:
}
/****************************************************************************
* Function: socket
* Name: socket
*
* Description:
* socket() creates an endpoint for communication and returns a descriptor.
+4 -4
View File
@@ -293,7 +293,7 @@ void net_lostconnection(FAR struct socket *psock, uint16_t flags);
#endif
/****************************************************************************
* Function: psock_close
* Name: psock_close
*
* Description:
* Performs the close operation on a socket instance
@@ -311,7 +311,7 @@ void net_lostconnection(FAR struct socket *psock, uint16_t flags);
int psock_close(FAR struct socket *psock);
/****************************************************************************
* Function: net_close
* Name: net_close
*
* Description:
* Performs the close operation on socket descriptors
@@ -329,7 +329,7 @@ int psock_close(FAR struct socket *psock);
int net_close(int sockfd);
/****************************************************************************
* Function: net_timeo
* Name: net_timeo
*
* Description:
* Check if a timeout has elapsed. This can be called from a socket poll
@@ -351,7 +351,7 @@ int net_timeo(systime_t start_time, socktimeo_t timeo);
#endif
/****************************************************************************
* Function: psock_send
* Name: psock_send
*
* Description:
* The send() call may be used only when the socket is in a connected state