1 /*
2  * coreMQTT Agent v1.1.0
3  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
6  * this software and associated documentation files (the "Software"), to deal in
7  * the Software without restriction, including without limitation the rights to
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9  * the Software, and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in all
13  * copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  */
22 
23 /**
24  * @file network_interface_stubs.h
25  * @brief Stub definitions for the application defined transport interface send
26  * and receive callback.
27  */
28 #ifndef NETWORK_INTERFACE_STUBS_H_
29 #define NETWORK_INTERFACE_STUBS_H_
30 
31 /* transport_interface.h must precede including this header. */
32 
33 /**
34  * @brief Application defined network interface receive function.
35  *
36  * @param[in] pNetworkContext Application defined network interface context.
37  * @param[out] pBuffer MQTT network receive buffer.
38  * @param[in] bytesToRecv MQTT requested bytes.
39  *
40  * @return Any value from INT32_MIN to INT32_MAX.
41  */
42 int32_t NetworkInterfaceReceiveStub( NetworkContext_t * pNetworkContext,
43                                      void * pBuffer,
44                                      size_t bytesToRecv );
45 
46 /**
47  * @brief Application defined network interface send function.
48  *
49  * @param[in] pNetworkContext Application defined network interface context.
50  * @param[out] pBuffer MQTT network send buffer.
51  * @param[in] bytesToSend Number of bytes to send over the network.
52  *
53  * @return Any value from INT32_MIN to INT32_MAX.
54  */
55 int32_t NetworkInterfaceSendStub( NetworkContext_t * pNetworkContext,
56                                   const void * pBuffer,
57                                   size_t bytesToSend );
58 
59 #endif /* ifndef NETWORK_INTERFACE_STUBS_H_ */
60