Changes between Version 158 and Version 159 of library_stdio

Timestamp:

Dec 31, 2016, 2:37:45 PM (8 years ago)

Author:

alain

Comment:

--

library_stdio

@@ -430 +430 @@
 
  === 5) int '''giet_nic_sendto'''( int socket , void * buffer , int length , int flags , sockaddr_t * dest_addr , int addr_len ) ===
-This blocking function moves one ''raw'' packet from an user buffer defined by the <buffer> argument to a kernel buffer. The packet length (in bytes) is defned by the <length> arguments. It uses the the <socket> and <dest_addr> arguments to build the ETH/IP/UDP header. It returns only when the user buffer can be re-used. The user thread blocking uses a descheduling policy.
+This blocking function moves one ''raw'' packet from an user buffer defined by the <buffer> argument to a kernel buffer. The packet length (in bytes) is defned by the <length> arguments. The destination socket is defined by the <remote_addr> argument. It uses the <socket> and <remote_addr> arguments to build the ETH/IP/UDP header. It returns only when the user buffer can be re-used, and uses a descheduling policy for blocking.
  * '''socket''' : socket identifier.
  * '''buffer''' : pointer on user buffer.
  * '''length''' : raw packet length (bytes).
  * '''flags''' : unsupported / must be 0.
- * '''dest_addr''' : remote socket address.
+ * '''remote_addr''' : pointer on remote socket address.
  * '''addr_len''' : unused.
  * return 0 if success / returns -1 if error.
 
- === 6) int '''giet_nic_recvfrom'''( int socket , void * buffer , int length , int flags , sockaddr_t * dest_addr , int * addr_len ) ===
-This blocking function moves one ''raw'' packet from a kernel buffer to an user buffer defined by the <buffer> argument. The <length> argument define the user buffer size (in bytes). Packets exceeding this size are discarded. Only packets matching the local IP address and local port number, defined by the <socket> argument will be delivered (2 matching conditions). If the socket is in ''connected'' mode, the matching must also be on remote IP address an remote port number (4 matching conditions). The remote socket address is returned in the <dest_addr> argument. It returns only when the user buffer has been written. The user thread blocking uses a descheduling policy.
+ === 6) int '''giet_nic_recvfrom'''( int socket , void * buffer , int length , int flags , sockaddr_t * dest_addr , int * pkt_len ) ===
+This blocking function moves one ''raw'' packet from a kernel buffer to an user buffer defined by the <buffer> argument. The <size> argument define the user buffer size and must be larger than 2 Kbytes. Only packets matching the local IP address and local port number, defined by the <socket> argument will be delivered (2 matching conditions). If the socket is in ''connected'' mode, the matching must also be on remote IP address an remote port number (4 matching conditions). The remote socket address is returned in the <src_addr> argument. The actual received packet length
+is returned in the <length> argument. It returns only when the user buffer has been written, and uses a descheduling policy for blocking.
  * '''socket''' : socket identifier.
  * '''buffer''' : pointer on user buffer.
- * '''length''' : raw packet length (bytes).
+ * '''size''' : buffer size (bytes).
  * '''flags''' : unsupported / must be 0.
- * '''dest_addr''' : pointer on remote socket address.
- * '''addr_len''' : unused.
+ * '''src_addr''' : pointer on remote socket address.
+ * '''length''' : pointer on received packet length (bytes).
  * return 0 if success / returns -1 if error.
 
- === 7) int '''giet_nic_write'''( int socket , void * buffer , int length void* buffer ) ===
-This blocking function makes the same as the giet_nic_sendto() function, with only one difference: the remote socket address must have been previously registered in the local socket descriptor using the giet_nic_connect() function.
- * '''socket''' : socket identifier.
- * '''buffer''' : pointer on user buffer.
- * '''length''' : raw packet length (bytes).
- * returns 0 if success / returns -1 if error.
-
- === 8) void '''giet_nic_read'''( int socket , void * buffer , int length void* buffer ) ===
-This blocking function makes the same as the giet_nic_recvfrom() function, with two differences: (i) the remote socket address must have been previously registered in the local socket descriptor using the giet_nic_connect() function, (ii) the matching condition is computed on 4 conditions: local IP address, local port number, remote IP addresses, remote port number.
- * '''socket''' : socket identifier.
- * '''buffer''' : pointer on user buffer.
- * '''length''' : raw packet length (bytes).
- * returns 0 if success / returns -1 if error.
-
- === 9) void '''giet_nic_print_stats'''( ) ===
+ === 7) void '''giet_nic_print_stats'''( ) ===
 This function  print on the calling thread terminal the current values of the hardware NIC instrumentation counters.
 
- === 10) void '''giet_nic_clear_stats'''( ) ===
+ === 8) void '''giet_nic_clear_stats'''( ) ===
 This function reset all Hardware NIC instrumentation counters.