Mirrors_Framework/nuttx
1
0
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2026-06-06 08:36:24 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Standardization of some function headers.

Browse Source
This commit is contained in:
Gregory Nutt
2018-03-13 09:52:27 -06:00
parent c268288c17
commit b54ffe858a
488 changed files with 2008 additions and 2007 deletions
Download Patch File Download Diff File Expand all files Collapse all files
net/tcp/tcp.h
+16 -16
View File
@@ -534,7 +534,7 @@ int tcp_connect(FAR struct tcp_conn_s *conn, FAR const struct sockaddr *addr);
* Description:
* Perform a TCP connection
*
* Parameters:
* Input Parameters:
* psock - A reference to the socket structure of the socket to be connected
* addr - The address of the remote server to connect to
*
@@ -626,7 +626,7 @@ void tcp_close_monitor(FAR struct socket *psock);
* (1) explicitly mark this socket and (2) disable further callbacks
* the event handler.
*
* Parameters:
* Input Parameters:
* psock - The TCP socket structure associated.
* cb - devif callback structure
* flags - Set of connection events events
@@ -739,7 +739,7 @@ void tcp_nextsequence(void);
* Description:
* Poll a TCP connection structure for availability of TX data
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
* conn - The TCP "connection" to poll for TX data
*
@@ -759,7 +759,7 @@ void tcp_poll(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn);
* Description:
* Handle a TCP timer expiration for the provided TCP connection
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
* conn - The TCP "connection" to poll for TX data
* hsec - The polling interval in halves of a second
@@ -869,7 +869,7 @@ int tcp_accept_connection(FAR struct net_driver_s *dev,
* Description:
* Setup to send a TCP packet
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
* conn - The TCP connection structure holding connection information
* flags - flags to apply to the TCP header
@@ -893,7 +893,7 @@ void tcp_send(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn,
* The tcp_sendfile() call may be used only when the INET socket is in a
* connected state (so that the intended recipient is known).
*
* Parameters:
* Input Parameters:
* psock An instance of the internal socket structure.
* buf Data to send
* len Length of data to send
@@ -917,7 +917,7 @@ ssize_t tcp_sendfile(FAR struct socket *psock, FAR struct file *infile,
* Description:
* Send a TCP reset (no-data) message
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
*
* Returned Value:
@@ -936,7 +936,7 @@ void tcp_reset(FAR struct net_driver_s *dev);
* Description:
* Send the SYN or SYNACK response.
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
* conn - The TCP connection structure holding connection information
* ack - The ACK response to send
@@ -960,7 +960,7 @@ void tcp_ack(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn,
* with dev->d_sndlen > 0, then this is an application attempting to send
* packet.
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
* conn - The TCP connection structure holding connection information
* result - App result event sent
@@ -982,7 +982,7 @@ void tcp_appsend(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn,
* Description:
* Handle application retransmission
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
* conn - The TCP connection structure holding connection information
* result - App result event sent
@@ -1004,7 +1004,7 @@ void tcp_rexmit(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn,
* Description:
* Handle incoming TCP input with IPv4 header
*
* Parameters:
* Input Parameters:
* dev - The device driver structure containing the received TCP packet.
*
* Returned Value:
@@ -1025,7 +1025,7 @@ void tcp_ipv4_input(FAR struct net_driver_s *dev);
* Description:
* Handle incoming TCP input with IPv4 header
*
* Parameters:
* Input Parameters:
* dev - The device driver structure containing the received TCP packet.
*
* Returned Value:
@@ -1207,7 +1207,7 @@ int tcp_backlogdelete(FAR struct tcp_conn_s *conn,
* This function implements accept() for TCP/IP sockets. See the
* description of accept() for further information.
*
* Parameters:
* Input Parameters:
* psock The listening TCP socket structure
* addr Receives the address of the connecting client
* addrlen Input: allocated size of 'addr', Return: returned size of 'addr'
@@ -1233,7 +1233,7 @@ int psock_tcp_accept(FAR struct socket *psock, FAR struct sockaddr *addr,
* The psock_tcp_send() call may be used only when the TCP socket is in a
* connected state (so that the intended recipient is known).
*
* Parameters:
* Input Parameters:
* psock An instance of the internal socket structure.
* buf Data to send
* len Length of data to send
@@ -1336,7 +1336,7 @@ int tcp_setsockopt(FAR struct socket *psock, int option,
* 'option' argument. Protocol-specific options are are protocol specific
* header files (such as netinet/tcp.h for the case of the TCP protocol).
*
* Parameters:
* Input Parameters:
* psock Socket structure of the socket to query
* level Protocol level to set the option
* option identifies the option to get
@@ -1364,7 +1364,7 @@ int tcp_getsockopt(FAR struct socket *psock, int option,
* possible that the write may still block if the buffer is filled by
* another means.
*
* Parameters:
* Input Parameters:
* psock An instance of the internal socket structure.
*
* Returned Value:
net/tcp/tcp_accept.c
+3 -3
View File
@@ -79,7 +79,7 @@ struct accept_s
* Description:
* Get the sender's address from the UDP packet
*
* Parameters:
* Input Parameters:
* psock - The state structure of the accepting socket
* conn - The newly accepted TCP connection
* pstate - the recvfrom state structure
@@ -150,7 +150,7 @@ static inline void accept_tcpsender(FAR struct socket *psock,
* Description:
* Receive event callbacks when connections occur
*
* Parameters:
* Input Parameters:
* listener The connection structure of the listener
* conn The connection structure that was just accepted
*
@@ -209,7 +209,7 @@ static int accept_eventhandler(FAR struct tcp_conn_s *listener,
* This function implements accept() for TCP/IP sockets. See the
* description of accept() for further information.
*
* Parameters:
* Input Parameters:
* psock The listening TCP socket structure
* addr Receives the address of the connecting client
* addrlen Input: allocated size of 'addr', Return: returned size of
net/tcp/tcp_appsend.c
+2 -2
View File
@@ -67,7 +67,7 @@
* with dev->d_sndlen > 0, then this is an application attempting to send
* packet.
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
* conn - The TCP connection structure holding connection information
* result - App result event sent
@@ -192,7 +192,7 @@ void tcp_appsend(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn,
* Description:
* Handle application retransmission
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
* conn - The TCP connection structure holding connection information
* result - App result event sent
net/tcp/tcp_connect.c
+2 -2
View File
@@ -163,7 +163,7 @@ static void psock_teardown_callbacks(FAR struct tcp_connect_s *pstate,
* This function is called to perform the actual connection operation via
* by the lower, device interfacing layer.
*
* Parameters:
* Input Parameters:
* dev The structure of the network driver that reported the event
* pvconn The connection structure associated with the socket
* flags Set of events describing why the callback was invoked
@@ -316,7 +316,7 @@ static uint16_t psock_connect_eventhandler(FAR struct net_driver_s *dev,
* Description:
* Perform a TCP connection
*
* Parameters:
* Input Parameters:
* psock - A reference to the socket structure of the socket to be connected
* addr - The address of the remote server to connect to
*
net/tcp/tcp_devpoll.c
+1 -1
View File
@@ -66,7 +66,7 @@
* Description:
* Poll a TCP connection structure for availability of TX data
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
* conn - The TCP "connection" to poll for TX data
*
net/tcp/tcp_getsockopt.c
+1 -1
View File
@@ -80,7 +80,7 @@
* 'option' argument. Protocol-specific options are are protocol specific
* header files (such as netinet/tcp.h for the case of the TCP protocol).
*
* Parameters:
* Input Parameters:
* psock Socket structure of the socket to query
* level Protocol level to set the option
* option identifies the option to get
net/tcp/tcp_input.c
+3 -3
View File
@@ -72,7 +72,7 @@
* Description:
* Handle incoming TCP input
*
* Parameters:
* Input Parameters:
* dev - The device driver structure containing the received TCP packet.
* domain - IP domain (PF_INET or PF_INET6)
* iplen - Lngth of the IP header (IPv4_HDRLEN or IPv6_HDRLEN).
@@ -1010,7 +1010,7 @@ drop:
* Description:
* Handle incoming TCP input with IPv4 header
*
* Parameters:
* Input Parameters:
* dev - The device driver structure containing the received TCP packet.
*
* Returned Value:
@@ -1040,7 +1040,7 @@ void tcp_ipv4_input(FAR struct net_driver_s *dev)
* Description:
* Handle incoming TCP input with IPv4 header
*
* Parameters:
* Input Parameters:
* dev - The device driver structure containing the received TCP packet.
*
* Returned Value:
net/tcp/tcp_monitor.c
+3 -3
View File
@@ -70,7 +70,7 @@ static uint16_t tcp_disconnect_event(FAR struct net_driver_s *dev,
* Description:
* Called when a loss-of-connection event has occurred.
*
* Parameters:
* Input Parameters:
* psock The TCP socket structure associated.
* flags Set of connection events events
*
@@ -125,7 +125,7 @@ static void tcp_close_connection(FAR struct socket *psock, uint16_t flags)
* Description:
* Some connection related event has occurred
*
* Parameters:
* Input Parameters:
* dev The device which as active when the event was detected.
* conn The connection structure associated with the socket
* flags Set of events describing why the callback was invoked
@@ -406,7 +406,7 @@ void tcp_close_monitor(FAR struct socket *psock)
* explicitly mark this socket and (2) disable further callbacks the to the
* event handler.
*
* Parameters:
* Input Parameters:
* psock - The TCP socket structure whose connection was lost.
* cb - devif callback structure
* flags - Set of connection events events
net/tcp/tcp_netpoll.c
+1 -1
View File
@@ -76,7 +76,7 @@ struct tcp_poll_s
* This function is called to perform the actual TCP receive operation via
* the device interface layer.
*
* Parameters:
* Input Parameters:
* dev The structure of the network driver that caused the event
* conn The connection structure associated with the socket
* flags Set of events describing why the callback was invoked
net/tcp/tcp_send.c
+8 -8
View File
@@ -83,7 +83,7 @@
* Description:
* Get the length of the IP header
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
*
* Returned Value:
@@ -119,7 +119,7 @@ static inline FAR struct tcp_hdr_s *tcp_header(FAR struct net_driver_s *dev)
* Complete the final portions of the send operation. This function sets
* up IP header and computes the TCP checksum
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
*
* Returned Value:
@@ -187,7 +187,7 @@ static inline void tcp_ipv4_sendcomplete(FAR struct net_driver_s *dev,
* Complete the final portions of the send operation. This function sets
* up IP header and computes the TCP checksum
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
*
* Returned Value:
@@ -250,7 +250,7 @@ static inline void tcp_ipv6_sendcomplete(FAR struct net_driver_s *dev,
* Complete the final portions of the send operation. This function sets
* up IP header and computes the TCP checksum
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
*
* Returned Value:
@@ -297,7 +297,7 @@ static void tcp_sendcomplete(FAR struct net_driver_s *dev,
* Our job is to fill in all the fields of the TCP and IP headers before
* calculating the checksum and finally send the packet.
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
* conn - The TCP connection structure holding connection information
*
@@ -396,7 +396,7 @@ static void tcp_sendcommon(FAR struct net_driver_s *dev,
* Description:
* Setup to send a TCP packet
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
* conn - The TCP connection structure holding connection information
* flags - flags to apply to the TCP header
@@ -428,7 +428,7 @@ void tcp_send(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn,
* Description:
* Send a TCP reset (no-data) message
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
*
* Returned Value:
@@ -543,7 +543,7 @@ void tcp_reset(FAR struct net_driver_s *dev)
* Description:
* Send the SYN or SYNACK response.
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
* conn - The TCP connection structure holding connection information
* ack - The ACK response to send
net/tcp/tcp_send_buffered.c
+8 -8
View File
@@ -114,7 +114,7 @@
* Insert a new segment in a write buffer queue, keep the segment queue in
* ascending order of sequence number.
*
* Parameters:
* Input Parameters:
* wrb The segment to be inserted
* q The write buffer queue in which to insert the segment
*
@@ -162,7 +162,7 @@ static void psock_insert_segment(FAR struct tcp_wrbuffer_s *wrb,
* Description:
* The TCP connection has been lost. Free all write buffers.
*
* Parameters:
* Input Parameters:
* psock The socket structure
* conn The connection structure associated with the socket
*
@@ -219,7 +219,7 @@ static inline void psock_lost_connection(FAR struct socket *psock,
* domain is selected, then the setup is already in place and we need do
* nothing.
*
* Parameters:
* Input Parameters:
* dev - The structure of the network driver that caused the event
* psock - Socket state structure
*
@@ -271,7 +271,7 @@ static inline void send_ipselect(FAR struct net_driver_s *dev,
* NOTE 3: If CONFIG_NET_ARP_SEND then we can be assured that the IP
* address mapping is already in the ARP table.
*
* Parameters:
* Input Parameters:
* conn - The TCP connection structure
*
* Returned Value:
@@ -392,7 +392,7 @@ static inline bool psock_send_addrchck(FAR struct tcp_conn_s *conn)
* This function is called to perform the actual send operation when
* polled by the lower, device interfacing layer.
*
* Parameters:
* Input Parameters:
* dev The structure of the network driver that caused the event
* conn The connection structure associated with the socket
* flags Set of events describing why the callback was invoked
@@ -912,7 +912,7 @@ static uint16_t psock_send_eventhandler(FAR struct net_driver_s *dev,
* Notify the appropriate device driver that we are have data ready to
* be send (TCP)
*
* Parameters:
* Input Parameters:
* psock - Socket state structure
* conn - The TCP connection structure
*
@@ -963,7 +963,7 @@ static inline void send_txnotify(FAR struct socket *psock,
* psock_tcp_send() call may be used only when the TCP socket is in a
* connected state (so that the intended recipient is known).
*
* Parameters:
* Input Parameters:
* psock An instance of the internal socket structure.
* buf Data to send
* len Length of data to send
@@ -1205,7 +1205,7 @@ errout:
* possible that the write may still block if the buffer is filled by
* another means.
*
* Parameters:
* Input Parameters:
* psock An instance of the internal socket structure.
*
* Returned Value:
net/tcp/tcp_send_unbuffered.c
+7 -7
View File
@@ -124,7 +124,7 @@ struct send_s
* Description:
* Check for send timeout.
*
* Parameters:
* Input Parameters:
* pstate send state structure
*
* Returned Value:
@@ -167,7 +167,7 @@ static inline int send_timeout(FAR struct send_s *pstate)
* domain is selected, then the setup is already in place and we need do
* nothing.
*
* Parameters:
* Input Parameters:
* dev - The structure of the network driver that caused the event
* pstate - sendto state structure
*
@@ -219,7 +219,7 @@ static inline void tcpsend_ipselect(FAR struct net_driver_s *dev,
* NOTE 3: If CONFIG_NET_ARP_SEND then we can be assured that the IP
* address mapping is already in the ARP table.
*
* Parameters:
* Input Parameters:
* conn - The TCP connection structure
*
* Returned Value:
@@ -342,7 +342,7 @@ static inline bool psock_send_addrchck(FAR struct tcp_conn_s *conn)
* This function is called to perform the actual send operation when
* polled by the lower, device interfacing layer.
*
* Parameters:
* Input Parameters:
* dev The structure of the network driver that caused the event
* conn The connection structure associated with the socket
* flags Set of events describing why the callback was invoked
@@ -686,7 +686,7 @@ end_wait:
* Notify the appropriate device driver that we are have data ready to
* be send (TCP)
*
* Parameters:
* Input Parameters:
* psock - Socket state structure
* conn - The TCP connection structure
*
@@ -737,7 +737,7 @@ static inline void send_txnotify(FAR struct socket *psock,
* psock_tcp_send() call may be used only when the TCP socket is in a
* connected state (so that the intended recipient is known).
*
* Parameters:
* Input Parameters:
* psock An instance of the internal socket structure.
* buf Data to send
* len Length of data to send
@@ -961,7 +961,7 @@ errout:
* would block. It is still possible that the write may block if another
* write occurs first.
*
* Parameters:
* Input Parameters:
* psock An instance of the internal socket structure.
*
* Returned Value:
net/tcp/tcp_sendfile.c
+5 -5
View File
@@ -120,7 +120,7 @@ struct sendfile_s
* Description:
* Check for send timeout.
*
* Parameters:
* Input Parameters:
* pstate - send state structure
*
* Returned Value:
@@ -276,7 +276,7 @@ static uint16_t ack_eventhandler(FAR struct net_driver_s *dev,
* NOTE 3: If CONFIG_NET_ARP_SEND then we can be assured that the IP
* address mapping is already in the ARP table.
*
* Parameters:
* Input Parameters:
* conn - The TCP connection structure
*
* Returned Value:
@@ -328,7 +328,7 @@ static inline bool sendfile_addrcheck(FAR struct tcp_conn_s *conn)
* This function is called to perform the actual send operation when
* polled by the lower, device interfacing layer.
*
* Parameters:
* Input Parameters:
* dev The structure of the network driver that caused the event
* conn The connection structure associated with the socket
* flags Set of events describing why the callback was invoked
@@ -516,7 +516,7 @@ wait:
* Notify the appropriate device driver that we are have data ready to
* be send (TCP)
*
* Parameters:
* Input Parameters:
* psock - Socket state structure
* conn - The TCP connection structure
*
@@ -567,7 +567,7 @@ static inline void sendfile_txnotify(FAR struct socket *psock,
* The tcp_sendfile() call may be used only when the INET socket is in a
* connected state (so that the intended recipient is known).
*
* Parameters:
* Input Parameters:
* psock An instance of the internal socket structure.
* buf Data to send
* len Length of data to send
net/tcp/tcp_timer.c
+1 -1
View File
@@ -70,7 +70,7 @@
* Description:
* Handle a TCP timer expiration for the provided TCP connection
*
* Parameters:
* Input Parameters:
* dev - The device driver structure to use in the send operation
* conn - The TCP "connection" to poll for TX data
* hsed - The polling interval in halves of a second