//////////////////////////////////////////////////////////////////////////////// /// @brief collection of socket functions /// /// @file /// /// DISCLAIMER /// /// Copyright 2014 ArangoDB GmbH, Cologne, Germany /// Copyright 2004-2014 triAGENS GmbH, Cologne, Germany /// /// Licensed under the Apache License, Version 2.0 (the "License"); /// you may not use this file except in compliance with the License. /// You may obtain a copy of the License at /// /// http://www.apache.org/licenses/LICENSE-2.0 /// /// Unless required by applicable law or agreed to in writing, software /// distributed under the License is distributed on an "AS IS" BASIS, /// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. /// See the License for the specific language governing permissions and /// limitations under the License. /// /// Copyright holder is ArangoDB GmbH, Cologne, Germany /// /// @author Dr. Frank Celler /// @author Copyright 2014, ArangoDB GmbH, Cologne, Germany /// @author Copyright 2008-2013, triAGENS GmbH, Cologne, Germany //////////////////////////////////////////////////////////////////////////////// #include "socket-utils.h" #ifdef TRI_HAVE_LINUX_SOCKETS #include #include #include #include #include #include #include #include #endif #include "BasicsC/logging.h" #include "BasicsC/locks.h" // ----------------------------------------------------------------------------- // --SECTION-- public functions // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @brief closes a socket //////////////////////////////////////////////////////////////////////////////// int TRI_closesocket (TRI_socket_t s) { int res = 0; #ifdef _WIN32 if (s.fileHandle != TRI_INVALID_SOCKET) { res = shutdown(s.fileHandle, SD_SEND); if (res != 0) { // Windows complains about shutting down a socket that was not bound // so we will not print out the error here // LOG_WARNING("socket shutdown error: %d", WSAGetLastError()); } else { char buf[256]; int len; do { len = TRI_readsocket(s, buf, sizeof(buf), 0); } while (len > 0); } res = closesocket(s.fileHandle); if (res != 0) { LOG_WARNING("socket close error: %d", WSAGetLastError()); } // We patch libev on Windows lightly to not really distinguish between // socket handles and file descriptors, therefore, we do not have to do the // following any more: // if (s.fileDescriptor != -1) { // res = _close(s.fileDescriptor); // "To close a file opened with _open_osfhandle, call _close." // The underlying handle is also closed by a call to _close, // so it is not necessary to call the Win32 function CloseHandle // on the original handle. // However, we do want to do the special shutdown/recv magic above // because only then we can reuse the port quickly, which we want // to do directly after a port test. // } } #else if (s.fileDescriptor != TRI_INVALID_SOCKET) { res = close(s.fileDescriptor); } #endif return res; } int TRI_readsocket (TRI_socket_t s, void* buffer, size_t numBytesToRead, int flags) { int res; #ifdef _WIN32 res = recv(s.fileHandle, (char*)(buffer), (int)(numBytesToRead), flags); #else res = read(s.fileDescriptor, buffer, numBytesToRead); #endif return res; } int TRI_writesocket (TRI_socket_t s, const void* buffer, size_t numBytesToWrite, int flags) { int res; #ifdef _WIN32 res = send(s.fileHandle, (const char*)(buffer), (int)(numBytesToWrite), flags); #else res = (int) write(s.fileDescriptor, buffer, numBytesToWrite); #endif return res; } //////////////////////////////////////////////////////////////////////////////// /// @brief sets close-on-exit for a socket //////////////////////////////////////////////////////////////////////////////// #ifdef TRI_HAVE_WIN32_CLOSE_ON_EXEC bool TRI_SetCloseOnExecSocket (TRI_socket_t s) { return true; } #else bool TRI_SetCloseOnExecSocket (TRI_socket_t s) { long flags = fcntl(s.fileDescriptor, F_GETFD, 0); if (flags < 0) { return false; } flags = fcntl(s.fileDescriptor, F_SETFD, flags | FD_CLOEXEC); if (flags < 0) { return false; } return true; } #endif //////////////////////////////////////////////////////////////////////////////// /// @brief sets non-blocking mode for a socket //////////////////////////////////////////////////////////////////////////////// #ifdef TRI_HAVE_WIN32_NON_BLOCKING bool TRI_SetNonBlockingSocket (TRI_socket_t s) { int res; DWORD ul = 1; res = ioctlsocket(s.fileHandle, FIONBIO, &ul); return (res == 0); } #else bool TRI_SetNonBlockingSocket (TRI_socket_t s) { long flags = fcntl(s.fileDescriptor, F_GETFL, 0); if (flags < 0) { return false; } flags = fcntl(s.fileDescriptor, F_SETFL, flags | O_NONBLOCK); if (flags < 0) { return false; } return true; } #endif // ----------------------------------------------------------------------------- // --SECTION-- MODULE // ----------------------------------------------------------------------------- // ----------------------------------------------------------------------------- // --SECTION-- modules initialisation // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @brief initialises the sockets components //////////////////////////////////////////////////////////////////////////////// void TRI_InitialiseSockets (void) { } //////////////////////////////////////////////////////////////////////////////// /// @brief shut downs the sockets components //////////////////////////////////////////////////////////////////////////////// void TRI_ShutdownSockets (void) { } // ----------------------------------------------------------------------------- // --SECTION-- END-OF-FILE // ----------------------------------------------------------------------------- // Local Variables: // mode: outline-minor // outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @page\\|// --SECTION--\\|/// @\\}" // End: