git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/shadow/shadow_device_operations/WinPCap/netif.h

   1 /*\r
   2  * FreeRTOS Kernel V10.2.1\r
   3  * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 #ifndef NET_IF_H\r
  29 #define NET_IF_H\r
  30 \r
  31 /*\r
  32  * Send uip_len bytes from uip_buf to the network interface selected by the \r
  33  * configNETWORK_INTERFACE_TO_USE constant (defined in FreeRTOSConfig.h). \r
  34  */\r
  35 void vNetifTx( void );\r
  36 \r
  37 /*\r
  38  * Receive bytes from the network interface selected by the \r
  39  * configNETWORK_INTERFACE_TO_USE constant (defined in FreeRTOSConfig.h).  The\r
  40  * bytes are placed in uip_buf.  The number of bytes copied into uip_buf is\r
  41  * returned.\r
  42  */\r
  43 UBaseType_t uxNetifRx( void );\r
  44 \r
  45 /*\r
  46  * Prepare a packet capture session.  This will print out all the network \r
  47  * interfaces available, and the one actually used is set by the \r
  48  * configNETWORK_INTERFACE_TO_USE constant that is defined in \r
  49  * FreeRTOSConfig.h. */\r
  50 BaseType_t xNetifInit( void );\r
  51 \r
  52 #endif /* NET_IF_H */\r