mirror of https://gitee.com/bigwinds/arangodb
351 lines
12 KiB
C
351 lines
12 KiB
C
////////////////////////////////////////////////////////////////////////////////
|
|
/// @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
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef ARANGODB_BASICS_C_SOCKET__UTILS_H
|
|
#define ARANGODB_BASICS_C_SOCKET__UTILS_H 1
|
|
|
|
#include "Basics/Common.h"
|
|
|
|
#ifdef TRI_HAVE_LINUX_SOCKETS
|
|
#include <arpa/inet.h>
|
|
#include <netinet/in.h>
|
|
#include <netinet/tcp.h>
|
|
#include <sys/un.h>
|
|
#include <sys/socket.h>
|
|
#include <netdb.h>
|
|
#include <sys/file.h>
|
|
#endif
|
|
|
|
#ifdef TRI_HAVE_WINSOCK2_H
|
|
#include <WinSock2.h>
|
|
#include <WS2tcpip.h>
|
|
#endif
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- public constants
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief socket types
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifdef _WIN32
|
|
typedef struct TRI_socket_s {
|
|
int fileDescriptor;
|
|
SOCKET fileHandle;
|
|
} TRI_socket_t;
|
|
#else
|
|
typedef struct TRI_socket_s {
|
|
int fileDescriptor;
|
|
} TRI_socket_t;
|
|
#endif
|
|
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- public functions
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief socket abstraction for different OSes
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static inline TRI_socket_t TRI_socket (int domain, int type, int protocol) {
|
|
TRI_socket_t res;
|
|
#ifdef _WIN32
|
|
res.fileHandle = socket(domain, type, protocol);
|
|
res.fileDescriptor = -1;
|
|
#else
|
|
res.fileDescriptor = socket(domain, type, protocol);
|
|
#endif
|
|
return res;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief listen abstraction for different OSes
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static inline int TRI_listen (TRI_socket_t s, int backlog) {
|
|
#ifdef _WIN32
|
|
return listen(s.fileHandle, backlog);
|
|
#else
|
|
return listen(s.fileDescriptor, backlog);
|
|
#endif
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief accept abstraction for different OSes
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static inline TRI_socket_t TRI_accept (TRI_socket_t s, struct sockaddr* address,
|
|
socklen_t* address_len) {
|
|
TRI_socket_t res;
|
|
#ifdef _WIN32
|
|
res.fileHandle = accept(s.fileHandle, address, address_len);
|
|
res.fileDescriptor = -1;
|
|
#else
|
|
res.fileDescriptor = accept(s.fileDescriptor, address, address_len);
|
|
#endif
|
|
return res;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief bind abstraction for different OSes
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static inline int TRI_bind (TRI_socket_t s, const struct sockaddr* address,
|
|
int addr_len) {
|
|
#ifdef _WIN32
|
|
return bind(s.fileHandle, address, addr_len);
|
|
#else
|
|
return bind(s.fileDescriptor, address, addr_len);
|
|
#endif
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief connect abstraction for different OSes
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static inline int TRI_connect (TRI_socket_t s, const struct sockaddr *address, int addr_len) {
|
|
#ifdef _WIN32
|
|
return connect(s.fileHandle, address, addr_len);
|
|
#else
|
|
return connect(s.fileDescriptor, address, addr_len);
|
|
#endif
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief send abstraction for different OSes
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static inline int TRI_send (TRI_socket_t s, const void* buffer, size_t length,
|
|
int flags) {
|
|
#ifdef _WIN32
|
|
return send(s.fileHandle, (char*) buffer, (int) length, flags);
|
|
#else
|
|
return send(s.fileDescriptor, buffer, length, flags);
|
|
#endif
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief getsockname abstraction for different OSes
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifdef _WIN32
|
|
static inline int TRI_getsockname (TRI_socket_t s, struct sockaddr* addr,
|
|
int* len) {
|
|
return getsockname(s.fileHandle, addr, len);
|
|
}
|
|
#else
|
|
static inline int TRI_getsockname (TRI_socket_t s, struct sockaddr* addr,
|
|
socklen_t* len) {
|
|
return getsockname(s.fileDescriptor, addr, len);
|
|
}
|
|
#endif
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief getsockopt abstraction for different OSes
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifdef _WIN32
|
|
static inline int TRI_getsockopt (TRI_socket_t s, int level, int optname,
|
|
void* optval, socklen_t* optlen) {
|
|
return getsockopt(s.fileHandle, level, optname, (char*) optval, optlen);
|
|
}
|
|
#else
|
|
static inline int TRI_getsockopt (TRI_socket_t s, int level, int optname,
|
|
void* optval, socklen_t* optlen) {
|
|
return getsockopt(s.fileDescriptor, level, optname, optval, optlen);
|
|
}
|
|
#endif
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief setsockopt abstraction for different OSes
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifdef _WIN32
|
|
static inline int TRI_setsockopt (TRI_socket_t s, int level, int optname,
|
|
const void* optval, int optlen) {
|
|
return setsockopt(s.fileHandle, level, optname, (const char*) optval, optlen);
|
|
}
|
|
#else
|
|
static inline int TRI_setsockopt (TRI_socket_t s, int level, int optname,
|
|
const void* optval, socklen_t optlen) {
|
|
return setsockopt(s.fileDescriptor, level, optname, optval, optlen);
|
|
}
|
|
#endif
|
|
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief setsockopt abstraction for different OSes
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifdef _WIN32
|
|
static inline bool TRI_setsockopttimeout (TRI_socket_t s, double timeout) {
|
|
DWORD to = (DWORD) timeout * 1000;
|
|
|
|
if (TRI_setsockopt(s, SOL_SOCKET, SO_RCVTIMEO, (const char*)&to, sizeof(to)) != 0) {
|
|
return false;
|
|
}
|
|
|
|
if (TRI_setsockopt(s, SOL_SOCKET, SO_SNDTIMEO, (const char*)&to, sizeof(to)) != 0) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
#else
|
|
static inline bool TRI_setsockopttimeout (TRI_socket_t s, double timeout) {
|
|
struct timeval tv;
|
|
|
|
// shut up Valgrind
|
|
memset(&tv, 0, sizeof(tv));
|
|
tv.tv_sec = (long) timeout;
|
|
tv.tv_usec = (long) ((timeout - (double) tv.tv_sec) * 1000000.0);
|
|
|
|
if (TRI_setsockopt(s, SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(tv)) != 0) {
|
|
return false;
|
|
}
|
|
|
|
if (TRI_setsockopt(s, SOL_SOCKET, SO_SNDTIMEO, &tv, sizeof(tv)) != 0) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
#endif
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief checks whether or not a socket is valid
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static inline bool TRI_isvalidsocket (TRI_socket_t s) {
|
|
#ifdef _WIN32
|
|
return s.fileHandle != TRI_INVALID_SOCKET;
|
|
#else
|
|
return s.fileDescriptor != TRI_INVALID_SOCKET;
|
|
#endif
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief invalidates a socket
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
static inline void TRI_invalidatesocket (TRI_socket_t* s) {
|
|
#ifdef _WIN32
|
|
s->fileHandle = TRI_INVALID_SOCKET;
|
|
s->fileDescriptor = -1;
|
|
#else
|
|
s->fileDescriptor = TRI_INVALID_SOCKET;
|
|
#endif
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief get file descriptor or handle, depending on OS
|
|
///
|
|
/// Note that this returns the fileHandle under Windows which is exactly
|
|
/// the right thing we need in all but one places.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifdef _WIN32
|
|
static inline SOCKET TRI_get_fd_or_handle_of_socket (TRI_socket_t s) {
|
|
return s.fileHandle;
|
|
}
|
|
#else
|
|
static inline int TRI_get_fd_or_handle_of_socket (TRI_socket_t s) {
|
|
return s.fileDescriptor;
|
|
}
|
|
#endif
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief closes an open socket
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int TRI_closesocket (TRI_socket_t);
|
|
|
|
int TRI_readsocket (TRI_socket_t, void* buffer, size_t numBytesToRead, int flags);
|
|
|
|
int TRI_writesocket (TRI_socket_t, const void* buffer, size_t numBytesToWrite, int flags);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief sets non-blocking mode for a socket
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool TRI_SetNonBlockingSocket (TRI_socket_t);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief sets close-on-exec for a socket
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool TRI_SetCloseOnExecSocket (TRI_socket_t);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief translates for IPv4 address
|
|
///
|
|
/// This code is copyright Internet Systems Consortium, Inc. ("ISC")
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int TRI_InetPton4 (const char *src, unsigned char *dst);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief translates for IPv6 address
|
|
///
|
|
/// This code is copyright Internet Systems Consortium, Inc. ("ISC")
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int TRI_InetPton6 (const char *src, unsigned char *dst);
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- MODULE
|
|
// -----------------------------------------------------------------------------
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- public functions
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief initialises the sockets components
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void TRI_InitialiseSockets (void);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief shut downs the sockets components
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void TRI_ShutdownSockets (void);
|
|
|
|
#endif
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- END-OF-FILE
|
|
// -----------------------------------------------------------------------------
|
|
|
|
// Local Variables:
|
|
// mode: outline-minor
|
|
// outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @page\\|// --SECTION--\\|/// @\\}"
|
|
// End:
|