2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2014, by the GROMACS development team, led by
5 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 * and including many others, as listed in the AUTHORS file in the
7 * top-level source directory and at http://www.gromacs.org.
9 * GROMACS is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public License
11 * as published by the Free Software Foundation; either version 2.1
12 * of the License, or (at your option) any later version.
14 * GROMACS is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with GROMACS; if not, see
21 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * If you want to redistribute modifications to GROMACS, please
25 * consider that scientific software is very special. Version
26 * control is crucial - bugs must be traceable. We will be happy to
27 * consider code for inclusion in the official distribution, but
28 * derived work must not be called official GROMACS. Details are found
29 * in the README & COPYING files - if they are missing, get the
30 * official version at http://www.gromacs.org.
32 * To help us fund GROMACS development, we humbly ask that you cite
33 * the research papers on the package. Check out http://www.gromacs.org.
36 /*! \libinternal \file
39 * Implements the parts of the vmdsock.h interface needed for IMD communication.
41 * \author Martin Hoefling, Carsten Kutzner <ckutzne@gwdg.de>
43 * For more information, see https://www-s.ks.uiuc.edu/Research/vmd/imd/ for general
44 * IMD information and https://www-s.ks.uiuc.edu/Research/vmd/imd/code/imdapi.tar.gz
45 * for the IMD reference implementation and API.
51 #ifndef GMX_IMD_IMDSOCKET_H
52 #define GMX_IMD_IMDSOCKET_H
56 /* Check if we can/should use winsock or standard UNIX sockets. */
57 #ifdef GMX_NATIVE_WINDOWS
58 #ifdef GMX_HAVE_WINSOCK
63 #include <netinet/in.h>
64 #include <sys/socket.h>
78 * IMD (interactive molecular dynamics) socket structure
84 struct sockaddr_in address; /**< address of socket */
86 int sockfd; /**< socket file descriptor */
91 #if defined(GMX_NATIVE_WINDOWS) && defined(GMX_HAVE_WINSOCK)
94 * \brief Function to initialize winsock
96 * \returns 0 if successful.
98 extern int imdsock_winsockinit();
102 /*! \brief Create an IMD master socket.
104 * \returns The IMD socket if successful. Otherwise prints an error message and returns NULL.
106 extern IMDSocket *imdsock_create();
109 /*! \brief Bind the IMD socket to address and port.
111 * Prints out an error message if unsuccessful.
112 * If port == 0, bind() assigns a free port automatically.
115 * \param sock The IMD socket.
116 * \param port The port to bind to.
118 * \returns 0 if successful.
120 extern int imdsock_bind(IMDSocket *sock, int port);
123 /*! \brief Set socket to listening state.
125 * Prints out an error message if unsuccessful.
127 * \param sock The IMD socket.
129 * \returns 0 if successful.
132 extern int imd_sock_listen(IMDSocket *sock);
135 /*! \brief Accept incoming connection and redirect to client socket.
137 * Prints out an error message if unsuccessful.
139 * \param sock The IMD socket.
141 * \returns IMD socket if successful, NULL otherwise.
143 extern IMDSocket *imdsock_accept(IMDSocket *sock);
146 /*! \brief Get the port number used for IMD connection.
148 * Prints out an error message if unsuccessful.
150 * \param sock The IMD socket.
151 * \param port The assigned port number.
153 * \returns 0 if successful, an error code otherwise.
155 extern int imdsock_getport(IMDSocket *sock, int *port);
158 /*! \brief Write to socket.
161 * \param sock The IMD socket.
162 * \param buffer The data to write.
163 * \param length Number of bytes to write.
165 * \returns The number of bytes written, or -1.
167 extern int imdsock_write(IMDSocket *sock, const char *buffer, int length);
170 /*! \brief Read from socket.
172 * \param sock The IMD socket.
173 * \param buffer Buffer to put the read data.
174 * \param length Number of bytes to read.
176 * \returns The number of bytes read, or -1 for errors.
178 extern int imdsock_read(IMDSocket *sock, char *buffer, int length);
181 /*! \brief Shutdown the socket.
183 * \param sock The IMD socket.
186 extern void imdsock_shutdown(IMDSocket *sock);
189 /*! \brief Close the socket and free the sock struct memory.
191 * Writes an error message if unsuccessful.
193 * \param sock The IMD socket.
195 * \returns 1 on success, or 0 if unsuccessful.
197 extern int imdsock_destroy(IMDSocket *sock);
200 /*! \brief Try to read from the socket.
202 * Time out after waiting the interval specified.
203 * Print an error message if unsuccessful.
205 * \param sock The IMD socket.
206 * \param timeoutsec Time out seconds
207 * \param timeoutusec Time out microseconds
210 extern int imdsock_tryread(IMDSocket *sock, int timeoutsec, int timeoutusec);