SimpleLink API Reference Manual  1.11.1
 All Data Structures Files Functions Variables Typedefs Macros Groups
socket.h
Go to the documentation of this file.
1 /*****************************************************************************
2 *
3 * socket.h - CC3000 Host Driver Implementation.
4 * Copyright (C) 2011 Texas Instruments Incorporated - https://www.ti.com/
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 *
13 * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the
16 * distribution.
17 *
18 * Neither the name of Texas Instruments Incorporated nor the names of
19 * its contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 *
34 *****************************************************************************/
35 #ifndef __SOCKET_H__
36 #define __SOCKET_H__
37 
38 
39 //*****************************************************************************
40 //
43 //
44 //*****************************************************************************
45 
46 
47 //*****************************************************************************
48 //
49 // If building with a C++ compiler, make all of the definitions in this header
50 // have a C binding.
51 //
52 //*****************************************************************************
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56 
57 #define HOSTNAME_MAX_LENGTH (230) // 230 bytes + header shouldn't exceed 8 bit value
58 
59 //--------- Address Families --------
60 
61 #define AF_INET 2
62 #define AF_INET6 23
63 
64 //------------ Socket Types ------------
65 
66 #define SOCK_STREAM 1
67 #define SOCK_DGRAM 2
68 #define SOCK_RAW 3 // Raw sockets allow new IPv4 protocols to be implemented in user space. A raw socket receives or sends the raw datagram not including link level headers
69 #define SOCK_RDM 4
70 #define SOCK_SEQPACKET 5
71 
72 //----------- Socket Protocol ----------
73 
74 #define IPPROTO_IP 0 // dummy for IP
75 #define IPPROTO_ICMP 1 // control message protocol
76 #define IPPROTO_IPV4 IPPROTO_IP // IP inside IP
77 #define IPPROTO_TCP 6 // tcp
78 #define IPPROTO_UDP 17 // user datagram protocol
79 #define IPPROTO_IPV6 41 // IPv6 in IPv6
80 #define IPPROTO_NONE 59 // No next header
81 #define IPPROTO_RAW 255 // raw IP packet
82 #define IPPROTO_MAX 256
83 
84 //----------- Socket retunr codes -----------
85 
86 #define SOC_ERROR (-1) // error
87 #define SOC_IN_PROGRESS (-2) // socket in progress
88 
89 //----------- Socket Options -----------
90 #define SOL_SOCKET 0xffff // socket level
91 #define SOCKOPT_RECV_NONBLOCK 0 // recv non block mode, set SOCK_ON or SOCK_OFF (default block mode)
92 #define SOCKOPT_RECV_TIMEOUT 1 // optname to configure recv and recvfromtimeout
93 #define SOCKOPT_ACCEPT_NONBLOCK 2 // accept non block mode, set SOCK_ON or SOCK_OFF (default block mode)
94 #define SOCK_ON 0 // socket non-blocking mode is enabled
95 #define SOCK_OFF 1 // socket blocking mode is enabled
96 
97 #define MAX_PACKET_SIZE 1500
98 #define MAX_LISTEN_QUEUE 4
99 
100 #define IOCTL_SOCKET_EVENTMASK
101 
102 #define ENOBUFS 55 // No buffer space available
103 
104 #define __FD_SETSIZE 32
105 
106 #define ASIC_ADDR_LEN 8
107 
108 #define NO_QUERY_RECIVED -3
109 
110 
111 typedef struct _in_addr_t
112 {
113  unsigned long s_addr; // load with inet_aton()
114 } in_addr;
115 
116 typedef struct _sockaddr_t
117 {
118  unsigned short int sa_family;
119  unsigned char sa_data[14];
120 } sockaddr;
121 
122 typedef struct _sockaddr_in_t
123 {
124  short sin_family; // e.g. AF_INET
125  unsigned short sin_port; // e.g. htons(3490)
126  in_addr sin_addr; // see struct in_addr, below
127  char sin_zero[8]; // zero this if you want to
128 } sockaddr_in;
129 
130 typedef unsigned long socklen_t;
131 
132 // The fd_set member is required to be an array of longs.
133 typedef long int __fd_mask;
134 
135 // It's easier to assume 8-bit bytes than to get CHAR_BIT.
136 #define __NFDBITS (8 * sizeof (__fd_mask))
137 #define __FDELT(d) ((d) / __NFDBITS)
138 #define __FDMASK(d) ((__fd_mask) 1 << ((d) % __NFDBITS))
139 
140 // fd_set for select and pselect.
141 typedef struct
142 {
143  __fd_mask fds_bits[__FD_SETSIZE / __NFDBITS];
144 #define __FDS_BITS(set) ((set)->fds_bits)
145 } fd_set;
146 
147 // We don't use `memset' because this would require a prototype and
148 // the array isn't too big.
149 #define __FD_ZERO(set) \
150  do { \
151  unsigned int __i; \
152  fd_set *__arr = (set); \
153  for (__i = 0; __i < sizeof (fd_set) / sizeof (__fd_mask); ++__i) \
154  __FDS_BITS (__arr)[__i] = 0; \
155  } while (0)
156 #define __FD_SET(d, set) (__FDS_BITS (set)[__FDELT (d)] |= __FDMASK (d))
157 #define __FD_CLR(d, set) (__FDS_BITS (set)[__FDELT (d)] &= ~__FDMASK (d))
158 #define __FD_ISSET(d, set) (__FDS_BITS (set)[__FDELT (d)] & __FDMASK (d))
159 
160 // Access macros for 'fd_set'.
161 #define FD_SET(fd, fdsetp) __FD_SET (fd, fdsetp)
162 #define FD_CLR(fd, fdsetp) __FD_CLR (fd, fdsetp)
163 #define FD_ISSET(fd, fdsetp) __FD_ISSET (fd, fdsetp)
164 #define FD_ZERO(fdsetp) __FD_ZERO (fdsetp)
165 
166 //Use in case of Big Endian only
167 
168 #define htonl(A) ((((unsigned long)(A) & 0xff000000) >> 24) | \
169  (((unsigned long)(A) & 0x00ff0000) >> 8) | \
170  (((unsigned long)(A) & 0x0000ff00) << 8) | \
171  (((unsigned long)(A) & 0x000000ff) << 24))
172 
173 #define ntohl htonl
174 
175 //Use in case of Big Endian only
176 #define htons(A) ((((unsigned long)(A) & 0xff00) >> 8) | \
177  (((unsigned long)(A) & 0x00ff) << 8))
178 
179 
180 #define ntohs htons
181 
182 // mDNS port - 5353 mDNS multicast address - 224.0.0.251
183 #define SET_mDNS_ADD(sockaddr) sockaddr.sa_data[0] = 0x14; \
184  sockaddr.sa_data[1] = 0xe9; \
185  sockaddr.sa_data[2] = 0xe0; \
186  sockaddr.sa_data[3] = 0x0; \
187  sockaddr.sa_data[4] = 0x0; \
188  sockaddr.sa_data[5] = 0xfb;
189 
190 
191 //*****************************************************************************
192 //
193 // Prototypes for the APIs.
194 //
195 //*****************************************************************************
196 
197 //*****************************************************************************
198 //
216 //
217 //*****************************************************************************
218 extern int socket(long domain, long type, long protocol);
219 
220 //*****************************************************************************
221 //
229 //
230 //*****************************************************************************
231 extern long closesocket(long sd);
232 
233 //*****************************************************************************
234 //
275 //
276 //*****************************************************************************
277 extern long accept(long sd, sockaddr *addr, socklen_t *addrlen);
278 
279 //*****************************************************************************
280 //
299 //
300 //*****************************************************************************
301 extern long bind(long sd, const sockaddr *addr, long addrlen);
302 
303 //*****************************************************************************
304 //
323 //
324 //*****************************************************************************
325 extern long listen(long sd, long backlog);
326 
327 //*****************************************************************************
328 //
343 //
344 //*****************************************************************************
345 #ifndef CC3000_TINY_DRIVER
346 extern int gethostbyname(char * hostname, unsigned short usNameLen, unsigned long* out_ip_addr);
347 #endif
348 
349 
350 //*****************************************************************************
351 //
376 //
377 //*****************************************************************************
378 extern long connect(long sd, const sockaddr *addr, long addrlen);
379 
380 //*****************************************************************************
381 //
415 //
416 //*****************************************************************************
417 extern int select(long nfds, fd_set *readsds, fd_set *writesds,
418  fd_set *exceptsds, struct timeval *timeout);
419 
420 //*****************************************************************************
421 //
464 //
465 //*****************************************************************************
466 #ifndef CC3000_TINY_DRIVER
467 extern int setsockopt(long sd, long level, long optname, const void *optval,
468  socklen_t optlen);
469 #endif
470 //*****************************************************************************
471 //
514 //
515 //*****************************************************************************
516 extern int getsockopt(long sd, long level, long optname, void *optval,
517  socklen_t *optlen);
518 
519 //*****************************************************************************
520 //
538 //
539 //*****************************************************************************
540 extern int recv(long sd, void *buf, long len, long flags);
541 
542 //*****************************************************************************
543 //
568 //
569 //*****************************************************************************
570 extern int recvfrom(long sd, void *buf, long len, long flags, sockaddr *from,
571  socklen_t *fromlen);
572 
573 //*****************************************************************************
574 //
592 //
593 //*****************************************************************************
594 
595 extern int send(long sd, const void *buf, long len, long flags);
596 
597 //*****************************************************************************
598 //
620 //
621 //*****************************************************************************
622 
623 extern int sendto(long sd, const void *buf, long len, long flags,
624  const sockaddr *to, socklen_t tolen);
625 
626 //*****************************************************************************
627 //
640 //
641 //*****************************************************************************
642 extern int mdnsAdvertiser(unsigned short mdnsEnabled, char * deviceServiceName, unsigned short deviceServiceNameLength);
643 
644 //*****************************************************************************
645 //
646 // Close the Doxygen group.
648 //
649 //*****************************************************************************
650 
651 
652 //*****************************************************************************
653 //
654 // Mark the end of the C bindings section for C++ compilers.
655 //
656 //*****************************************************************************
657 #ifdef __cplusplus
658 }
659 #endif // __cplusplus
660 
661 #endif // __SOCKET_H__