TI J721E Imaging User Guide
network_api.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (c) 2020 Texas Instruments Incorporated
4  *
5  * All rights reserved not granted herein.
6  *
7  * Limited License.
8  *
9  * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
10  * license under copyrights and patents it now or hereafter owns or controls to make,
11  * have made, use, import, offer to sell and sell ("Utilize") this software subject to the
12  * terms herein. With respect to the foregoing patent license, such license is granted
13  * solely to the extent that any such patent is necessary to Utilize the software alone.
14  * The patent license shall not apply to any combinations which include this software,
15  * other than combinations with devices manufactured by or for TI ("TI Devices").
16  * No hardware patent is licensed hereunder.
17  *
18  * Redistributions must preserve existing copyright notices and reproduce this license
19  * (including the above copyright notice and the disclaimer and (if applicable) source
20  * code license limitations below) in the documentation and/or other materials provided
21  * with the distribution
22  *
23  * Redistribution and use in binary form, without modification, are permitted provided
24  * that the following conditions are met:
25  *
26  * * No reverse engineering, decompilation, or disassembly of this software is
27  * permitted with respect to any software provided in binary form.
28  *
29  * * any redistribution and use are licensed by TI for use only with TI Devices.
30  *
31  * * Nothing shall obligate TI to provide you with source code for the software
32  * licensed and provided to you in object code.
33  *
34  * If software source code is provided to you, modification and redistribution of the
35  * source code are permitted provided that the following conditions are met:
36  *
37  * * any redistribution and use of the source code, including any resulting derivative
38  * works, are licensed by TI for use only with TI Devices.
39  *
40  * * any redistribution and use of any object code compiled from the source code
41  * and any resulting derivative works, are licensed by TI for use only with TI Devices.
42  *
43  * Neither the name of Texas Instruments Incorporated nor the names of its suppliers
44  *
45  * may be used to endorse or promote products derived from this software without
46  * specific prior written permission.
47  *
48  * DISCLAIMER.
49  *
50  * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS
51  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53  * IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT,
54  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
55  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
57  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
58  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
59  * OF THE POSSIBILITY OF SUCH DAMAGE.
60  *
61  */
70 #ifndef NETWORK_API_H_
71 #define NETWORK_API_H_
72 
73 #ifdef __cplusplus
74 extern "C" {
75 #endif
76 
77 
78 /*******************************************************************************
79  * Include files
80  *******************************************************************************
81  */
82 #include <sys/types.h>
83 #include <sys/socket.h>
84 #include <poll.h>
85 #include <netinet/in.h>
86 #include <sys/time.h>
87 #include <sys/select.h>
88 #include <sys/time.h>
89 #include <sys/types.h>
90 #include <unistd.h>
91 #include <stdio.h>
92 #include <string.h>
93 #include <net/if.h>
94 #include <sys/ioctl.h>
95 /*******************************************************************************
96  * Defines
97  *******************************************************************************
98  */
99 
100 
101 /*******************************************************************************
102  * Data structure's
103  *******************************************************************************
104  */
105 typedef int Bool;
106 /*******************************************************************************
107  * \brief Information related to network socket
108  *******************************************************************************
109  */
110 typedef struct {
111 
112  int sockFd;
115  unsigned int port;
122 
123 /*******************************************************************************
124  * Function's
125  *******************************************************************************
126  */
127 
128 int32_t Network_open(Network_SockObj *pObj, uint32_t port);
129 int32_t Network_close(Network_SockObj *pObj, Bool closeServerSock);
130 int32_t Network_waitConnect(Network_SockObj *pObj, uint32_t timeout);
131 int32_t Network_read(Network_SockObj *pObj, uint8_t *dataBuf, uint32_t *dataSize);
132 int32_t Network_write(Network_SockObj *pObj, uint8_t *dataBuf, uint32_t dataSize);
133 
134 #ifdef __cplusplus
135 }
136 #endif /* __cplusplus */
137 
138 #endif
139 
140 /* @} */
141 
142 
Definition: network_api.h:110
int32_t Network_waitConnect(Network_SockObj *pObj, uint32_t timeout)
Definition: network_api.c:201
int sockFd
Definition: network_api.h:112
unsigned int port
Definition: network_api.h:115
int32_t Network_close(Network_SockObj *pObj, Bool closeServerSock)
Definition: network_api.c:181
int32_t Network_open(Network_SockObj *pObj, uint32_t port)
Definition: network_api.c:126
int Bool
Definition: network_api.h:105
int connectedSockFd
Definition: network_api.h:118
int32_t Network_read(Network_SockObj *pObj, uint8_t *dataBuf, uint32_t *dataSize)
Definition: network_api.c:70
int32_t Network_write(Network_SockObj *pObj, uint8_t *dataBuf, uint32_t dataSize)
Definition: network_api.c:99