├── .gitignore ├── LICENSE ├── README.md ├── include └── socket.h ├── src └── socket.c └── tests ├── client.c └── server.c /.gitignore: -------------------------------------------------------------------------------- 1 | # Object files 2 | *.o 3 | *.ko 4 | *.obj 5 | *.elf 6 | 7 | # Libraries 8 | *.lib 9 | *.a 10 | 11 | # Shared objects (inc. Windows DLLs) 12 | *.dll 13 | *.so 14 | *.so.* 15 | *.dylib 16 | 17 | # Executables 18 | *.exe 19 | *.out 20 | *.app 21 | *.i*86 22 | *.x86_64 23 | *.hex 24 | 25 | # Directories 26 | bin/ 27 | 28 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | c-socket-lib 2 | ============ 3 | 4 | A socket library for C that makes writing socket programs a cinch. The library models the simplicity of Python's socket library API. If you can create a socket in Python, you can just as easily create one using this class! Currently the library will only work on Linux. 5 | 6 | TODO 7 | ------------- 8 | 9 | * Support Windows 10 | * Implement raw sockets 11 | 12 | How to use this library 13 | ------------- 14 | 15 | This library depends on class.c from my [c-functions](https://github.com/hongmeister/c-functions) library. 16 | 17 | Instantiate the socket object: 18 | 19 | Socket *s = init_socket(AF_INET, SOCK_STREAM); 20 | 21 | Where AF_INET is the address family, and SOCK_STREAM is the socket type. 22 | 23 | Then either connect to act as a client, or bind, listen, and accept to act as a server. 24 | 25 | Use send and recv to send and receive data to/from the client/server. 26 | 27 | When you're done, destroy the object: 28 | 29 | socket_close(s); 30 | 31 | Sample echo server 32 | ------------- 33 | 34 | These examples are also in the tests/ directory. 35 | 36 | The server: 37 | 38 | #include 39 | #include 40 | #include 41 | #include "socket.h" 42 | 43 | int main() 44 | { 45 | char buff[100]; 46 | int bytes; 47 | 48 | Socket *s = init_socket(AF_INET, SOCK_STREAM); 49 | s->bind(s, NULL, 12345); 50 | s->listen(s, 5); 51 | 52 | ClientAddr client_addr; 53 | Socket *c = s->accept(s, &client_addr); 54 | 55 | printf("Client connected at %s:%d\n", client_addr.ip_addr, client_addr.port); 56 | 57 | while (1) { 58 | c->recv(c, buff, sizeof(buff)); 59 | printf("Got: %s\n", buff); 60 | c->send(c, buff); 61 | printf("Sending: %s\n", buff); 62 | } 63 | 64 | socket_close(c); 65 | socket_close(s); 66 | } 67 | 68 | The client: 69 | 70 | #include 71 | #include 72 | #include 73 | #include "socket.h" 74 | 75 | int main() 76 | { 77 | int bytes; 78 | char buff[100]; 79 | Socket *s = init_socket(AF_INET, SOCK_STREAM); 80 | s->connect(s, "127.0.0.1", 12345); 81 | 82 | while (1) { 83 | memset(buff, 0, sizeof(buff)); 84 | 85 | printf(">> "); 86 | 87 | if (fgets(buff, sizeof(buff), stdin) == NULL) { 88 | perror("fgets error"); 89 | break; 90 | } 91 | 92 | s->send(s, buff); 93 | s->recv(s, buff, sizeof(buff)); 94 | 95 | printf("Received: %s\n", buff); 96 | } 97 | 98 | socket_close(s); 99 | } 100 | -------------------------------------------------------------------------------- /include/socket.h: -------------------------------------------------------------------------------- 1 | /** 2 | * Socket pseudo-class 3 | * 4 | * This class models the Python socket API. If you can create a socket in Python, 5 | * you can just as easily create one using this class! 6 | * 7 | * @author Daniel Hong 8 | * 9 | * This program is licensed under the GNU GENERAL PUBLIC LICENSE Version 2. 10 | * A LICENSE file should have accompanied this program. 11 | */ 12 | 13 | #ifndef _DH_SOCKET_H_ 14 | #define _DH_SOCKET_H_ 15 | 16 | #include 17 | #include 18 | #include 19 | #include "../../c-functions/include/class.h" 20 | 21 | #define SOCKET_SERVER 1 22 | #define SOCKET_CLIENT 2 23 | 24 | /** 25 | * Structure to hold info on a connected client's IP and port 26 | */ 27 | typedef struct { 28 | const char *ip_addr; 29 | int port; 30 | } ClientAddr; 31 | 32 | /** 33 | * Defining the socket class 34 | */ 35 | CLASS(Socket, 36 | /** 37 | * Connect to a server 38 | * 39 | * @param Socket * IN Pointer to the socket object created by init_socket(int, int) 40 | * @param const char * IN IP address of the server to connect to 41 | * @param int IN Port of the remote server 42 | */ 43 | FUNC(void, connect, (struct Socket *, const char *, int)); 44 | 45 | /** 46 | * Bind a socket to the given IP address and port 47 | * 48 | * @param Socket * IN Pointer to the socket object created by init_socket(int, int) 49 | * @param const char * IN IP address of the server to connect to 50 | * @param int IN Port of the remote server 51 | */ 52 | FUNC(void, bind, (struct Socket *, const char *, int)); 53 | 54 | /** 55 | * Listen for incoming connections 56 | * 57 | * @param Socket * IN Pointer to the socket object created by init_socket(int, int) 58 | * @param int IN Max number of queued connection allowed 59 | */ 60 | FUNC(void, listen, (struct Socket *, int)); 61 | 62 | /** 63 | * Accept a connection. The socket must be bound to an address and listening for connections 64 | * 65 | * @param Socket * IN Pointer to the socket object created by init_socket(int, int) 66 | * @param ClientAddr * OUT/OPT Pointer to a ClientAddr structure. 67 | * If used, this will populate the structure with 68 | * the connected client's IP and port 69 | * @return Socket * Returns a pointer to a Socket object where it 70 | * is used to send and receive data on the connection 71 | */ 72 | FUNC(struct Socket *, accept, (struct Socket *, ClientAddr *)); 73 | 74 | /** 75 | * Send data to the connected remote socket 76 | * 77 | * @param Socket * IN Pointer to the socket object created by init_socket(int, int) 78 | * @param const char * IN The data to send 79 | * @return int If successful, returns the number of bytes sent. 80 | * Returns -1 on error. 81 | * Applications are responsible for checking that all data has been 82 | * sent. If only some of the data was transmitted, the application 83 | * needs to attempt delivery of the remaining data. 84 | */ 85 | FUNC(int, send, (struct Socket *, const char *)); 86 | 87 | /** 88 | * Receive data from the connected remote socket 89 | * 90 | * @param Socket * IN Pointer to the socket object created by init_socket(int, int) 91 | * @param char * OUT Pointer to a character buffer. This buffer will be 92 | * populated with the received data. 93 | * @return int If successful, returns the number of bytes sent. 94 | * Returns -1 on error, zero (0) if the peer performed a shutdown 95 | */ 96 | FUNC(int, recv, (struct Socket *, char *, int)); 97 | 98 | // Below are private members 99 | // These members should generally not be used by the end-user 100 | // and as such will not be documented 101 | 102 | int _sockfd; 103 | int _family; 104 | int _type; 105 | int _proto; 106 | struct addrinfo _addrinfo_hints; 107 | struct addrinfo *_addrinfo; 108 | 109 | FUNC(void, _create, (struct Socket *, int, const char *, int)); 110 | FUNC(void, _exit_error, (struct Socket *, const char *)); 111 | FUNC(char *, _inet_ntop, (struct Socket *, struct sockaddr *)); 112 | ); 113 | 114 | /** 115 | * Instantiate a socket object and return a pointer to said object 116 | * Think of this as the "new" keyword in OOP languages like C++ and JAVA where 117 | * the object is created in the heap. Since it's in the heap, you must call the 118 | * socket_close(obj) function on every object instantiation. 119 | * 120 | * @param int Address family. Can be AF_INET, AF_INET6, or AF_UNIX 121 | * @param int The socket type. Can be SOCK_STREAM or SOCK_DGRAM 122 | * @return Socket * A pointer to a Socket object 123 | * 124 | * Example: 125 | * 126 | * Socket *sock = init_socket(AF_INET, SOCK_STREAM); 127 | * 128 | * // Do stuff with sock 129 | * // ... 130 | * 131 | * // Close the socket 132 | * socket_close(sock); 133 | */ 134 | Socket *init_socket(int, int); 135 | 136 | /** 137 | * Closes an open socket. This function also releases the object from memory. 138 | * 139 | * @param Socket * Pointer to a socket to close 140 | */ 141 | void socket_close(Socket *); 142 | 143 | // ----------------------------------------------------------------------------- 144 | // Function pointers. These are private members and cannot be called directly 145 | // ----------------------------------------------------------------------------- 146 | 147 | static void _connect_(Socket *, const char *, int); 148 | static void _bind_(Socket *, const char *, int); 149 | static void _listen_(Socket *, int); 150 | static Socket *_accept_(Socket *, ClientAddr *); 151 | static int _send_(Socket *, const char *); 152 | static int _recv_(Socket *, char *, int); 153 | static void _create_(Socket *, int, const char *, int); 154 | static void _exit_error_(Socket *, const char *); 155 | static char *_inet_ntop_(Socket *, struct sockaddr *); 156 | 157 | #endif /* _DH_SOCKET_H_ */ 158 | 159 | -------------------------------------------------------------------------------- /src/socket.c: -------------------------------------------------------------------------------- 1 | /** 2 | * Socket pseudo-class 3 | * 4 | * @author Daniel Hong 5 | * 6 | * This program is licensed under the GNU GENERAL PUBLIC LICENSE Version 2. 7 | * A LICENSE file should have accompanied this program. 8 | */ 9 | #include 10 | #include 11 | #include 12 | #include 13 | #include 14 | #include 15 | #include 16 | #include 17 | #include 18 | #include "../include/socket.h" 19 | 20 | Socket *init_socket(int family, int type) 21 | { 22 | Socket *s; 23 | 24 | if ((s = malloc(sizeof(Socket))) == NULL) { 25 | return NULL; 26 | } 27 | 28 | // Map the the function pointers 29 | s->connect = _connect_; 30 | s->bind = _bind_; 31 | s->listen = _listen_; 32 | s->accept = _accept_; 33 | s->send = _send_; 34 | s->recv = _recv_; 35 | s->_create = _create_; 36 | s->_inet_ntop = _inet_ntop_; 37 | s->_exit_error = _exit_error_; 38 | 39 | // Give initial values to our members 40 | s->_sockfd = -1; 41 | s->_family = family; 42 | s->_type = type; 43 | s->_proto = 0; // Unused right now, for future 44 | 45 | // Zero out our addrinfo hints structure 46 | memset(&(s->_addrinfo_hints), 0, sizeof(s->_addrinfo_hints)); 47 | 48 | // Set initial values for our hints 49 | s->_addrinfo_hints.ai_family = family; 50 | s->_addrinfo_hints.ai_socktype = type; 51 | 52 | return s; 53 | } 54 | 55 | void socket_close(Socket *s) 56 | { 57 | // Make sure it hadn't been freed already 58 | if (s) { 59 | // Close the socket 60 | close(s->_sockfd); 61 | 62 | // Release the structure from memory 63 | release(s); 64 | } 65 | } 66 | 67 | static void _connect_(Socket *this, const char *ip_addr, int port) 68 | { 69 | // Setup and create the socket 70 | this->_create(this, SOCKET_CLIENT, ip_addr, port); 71 | 72 | if (connect(this->_sockfd, this->_addrinfo->ai_addr, 73 | this->_addrinfo->ai_addrlen) == -1) { 74 | this->_exit_error(this, "Error connecting to the remote server."); 75 | } 76 | 77 | // We don't need our addrinfo structure anymore 78 | freeaddrinfo(this->_addrinfo); 79 | } 80 | 81 | static void _bind_(Socket *this, const char *ip_addr, int port) 82 | { 83 | // Setup and create the socket 84 | this->_create(this, SOCKET_SERVER, ip_addr, port); 85 | 86 | if (bind(this->_sockfd, this->_addrinfo->ai_addr, 87 | this->_addrinfo->ai_addrlen) == -1) { 88 | this->_exit_error(this, "Error binding the socket."); 89 | } 90 | 91 | // We don't need our addrinfo structure anymore 92 | freeaddrinfo(this->_addrinfo); 93 | } 94 | 95 | static void _listen_(Socket *this, int max_queue) 96 | { 97 | if (listen(this->_sockfd, max_queue) == -1) { 98 | this->_exit_error(this, "Error listening for connections."); 99 | } 100 | } 101 | 102 | static Socket *_accept_(Socket *this, ClientAddr *c) 103 | { 104 | struct sockaddr_in client_addr; 105 | unsigned addr_size = sizeof(client_addr); 106 | int client_fd; 107 | 108 | if ((client_fd = accept(this->_sockfd, (struct sockaddr *)&client_addr, &addr_size)) == -1) { 109 | this->_exit_error(this, "Error accepting a remote connection."); 110 | } 111 | 112 | if (c) { 113 | // Return client struct with client ip and port 114 | c->ip_addr = this->_inet_ntop(this, (struct sockaddr *)&client_addr); 115 | c->port = client_addr.sin_port; 116 | } 117 | 118 | // Return a socket object initialized with our client socket 119 | Socket *sock = init_socket(this->_family, this->_type); 120 | sock->_sockfd = client_fd; 121 | return sock; 122 | } 123 | 124 | static int _send_(Socket *this, const char *str) 125 | { 126 | return send(this->_sockfd, str, strlen(str), 0); 127 | } 128 | 129 | static int _recv_(Socket *this, char *buff, int max_len) 130 | { 131 | int bytes_recv; 132 | char tmp[max_len]; 133 | 134 | // Clear buffer 135 | memset(tmp, 0, max_len); 136 | memset(buff, 0, max_len); 137 | 138 | bytes_recv = recv(this->_sockfd, tmp, max_len, 0); 139 | snprintf(buff, max_len, "%s", tmp); 140 | 141 | return bytes_recv; 142 | } 143 | 144 | // Create a socket 145 | // This will handle both client and server socket creation 146 | static void _create_(Socket *this, int type, const char *ip_addr, int port) 147 | { 148 | char sport[6]; 149 | 150 | // We need to convert the port number to a string 151 | if (snprintf(sport, 6, "%d", port) < 0) { 152 | this->_exit_error(this, "Error converting port number to string."); 153 | } 154 | 155 | // If the type of socket we are creating is for binding/listening, we need 156 | // to make a few changes 157 | if (type == SOCKET_SERVER) { 158 | this->_addrinfo_hints.ai_flags = AI_PASSIVE; 159 | } 160 | 161 | // Get our addrinfo structure to use to create the socket 162 | // We use getaddrinfo() because it correctly populates our structure 163 | // regardless of IPv4 or IPv6 164 | if (getaddrinfo(ip_addr, sport, &(this->_addrinfo_hints), &(this->_addrinfo)) != 0) { 165 | this->_exit_error(this, "Error getting address info."); 166 | } 167 | 168 | // Finally we can create the socket 169 | if ((this->_sockfd = socket(this->_addrinfo->ai_family, 170 | this->_addrinfo->ai_socktype, 171 | this->_addrinfo->ai_protocol)) == -1) { 172 | this->_exit_error(this, "Error creating a socket."); 173 | } 174 | } 175 | 176 | static void _exit_error_(Socket *this, const char *msg) 177 | { 178 | socket_close(this); 179 | 180 | // Print with error code message 181 | if (errno != 0) { 182 | printf ("(%s) %s\n", strerror(errno), msg); 183 | exit(1); 184 | } 185 | 186 | // Just print our message 187 | printf("%s\n", msg); 188 | exit(1); 189 | } 190 | 191 | // Get human friendly IP address 192 | // This function uses inet_ntop() as it supports IPv4 & IPv6 193 | static char *_inet_ntop_(Socket *this, struct sockaddr *sa) 194 | { 195 | static char str[INET6_ADDRSTRLEN]; 196 | 197 | switch (sa->sa_family) { 198 | case AF_INET: 199 | inet_ntop(AF_INET, &(((struct sockaddr_in *)sa)->sin_addr), str, INET_ADDRSTRLEN); 200 | break; 201 | 202 | case AF_INET6: 203 | inet_ntop(AF_INET6, &(((struct sockaddr_in6 *)sa)->sin6_addr), str, INET6_ADDRSTRLEN); 204 | break; 205 | 206 | default: 207 | strncpy(str, "Unknown", INET_ADDRSTRLEN); 208 | return NULL; 209 | } 210 | 211 | return str; 212 | } 213 | 214 | -------------------------------------------------------------------------------- /tests/client.c: -------------------------------------------------------------------------------- 1 | /** 2 | * Example echo server 3 | * 4 | * This is the client script 5 | */ 6 | 7 | #include 8 | #include 9 | #include 10 | #include "../include/socket.h" 11 | 12 | int main() 13 | { 14 | char buff[100]; 15 | 16 | // Instantiate a socket object 17 | Socket *s = init_socket(AF_INET, SOCK_STREAM); 18 | 19 | // Connect to the server 20 | s->connect(s, "127.0.0.1", 12345); 21 | 22 | while (1) { 23 | memset(buff, 0, sizeof(buff)); 24 | 25 | printf(">> "); 26 | 27 | // Get user input 28 | if (fgets(buff, sizeof(buff), stdin) == NULL) { 29 | perror("fgets error"); 30 | break; 31 | } 32 | 33 | // Send the user to the server 34 | s->send(s, buff); 35 | 36 | // Get response from the server 37 | s->recv(s, buff, sizeof(buff)); 38 | 39 | printf("Received: %s\n", buff); 40 | } 41 | 42 | // Destroy the socket object 43 | socket_close(s); 44 | } 45 | -------------------------------------------------------------------------------- /tests/server.c: -------------------------------------------------------------------------------- 1 | /** 2 | * Example echo server 3 | * 4 | * This is the server script 5 | */ 6 | 7 | #include 8 | #include 9 | #include 10 | #include "../include/socket.h" 11 | 12 | int main() 13 | { 14 | char buff[100]; 15 | int bytes; 16 | 17 | // Instantiate a socket object 18 | Socket *s = init_socket(AF_INET, SOCK_STREAM); 19 | 20 | // Bind the socket to localhost on port 12345 21 | // To bind to a specific IP, replace NULL with the IP address, 22 | // for example: "192.168.1.123" 23 | s->bind(s, NULL, 12345); 24 | 25 | // Listen and allow up to five queued clients 26 | s->listen(s, 5); 27 | 28 | // Define a client address structure to get info about the connected client 29 | ClientAddr client_addr; 30 | 31 | // Accept clients 32 | Socket *c = s->accept(s, &client_addr); 33 | 34 | printf("Client connected at %s:%d\n", client_addr.ip_addr, client_addr.port); 35 | 36 | while (1) { 37 | memset(buff, 0, sizeof(buff)); 38 | c->recv(c, buff, sizeof(buff)); 39 | 40 | if (strlen(buff) == 0) { 41 | break; 42 | } 43 | 44 | printf("Got: %s\n", buff); 45 | c->send(c, buff); 46 | printf("Sending: %s\n", buff); 47 | } 48 | 49 | // Destroy the client socket object 50 | socket_close(c); 51 | 52 | // Destory the main socket object 53 | socket_close(s); 54 | } 55 | --------------------------------------------------------------------------------