sock.hpp

Go to the documentation of this file.

#ifndef COMPA_SOCK_HPP
#define COMPA_SOCK_HPP
/**************************************************************************
 *
 * Copyright (c) 2000-2003 Intel Corporation
 * All rights reserved.
 * Copyright (c) 2012 France Telecom All rights reserved.
 * Copyright (C) 2021+ GPL 3 and higher by Ingo Höft, <Ingo@Hoeft-online.de>
 * Redistribution only with this Copyright remark. Last modified: 2024-11-05
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * - Neither name of Intel Corporation nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 **************************************************************************/
// Last compare with ./pupnp source file on 2023-09-13, ver 1.14.18
//
// Unused interface header file deleted. It's available until commit
// a01e0186bc0dcb8dc243f6d313ca8527535648fd:compa/inc/compa/sock.hpp
#include <UPnPsdk/port_sock.hpp> /* for SOCKET, netinet/in */
#include <umock/unistd.hpp>
 
#ifdef UPnPsdk_HAVE_OPENSSL
#include <openssl/ssl.h>
#endif
 
/* The following are not defined under winsock.h */
#ifndef SD_RECEIVE
#define SD_RECEIVE 0x00
#define SD_SEND 0x01
#define SD_BOTH 0x02
#endif
 
struct SOCKINFO {
    SOCKET socket;
    sockaddr_storage foreign_sockaddr;
#ifdef UPnPsdk_HAVE_OPENSSL
    SSL* ssl;
#else
    void* ssl;
#endif
};
 
// Don't export function symbol; only used library intern.
inline int sock_close(
    SOCKET sock) {
    if (sock == INVALID_SOCKET)
        return -1;
    return umock::unistd_h.CLOSE_SOCKET_P(sock);
}
 
// Don't export function symbol; only used library intern.
int sock_init(
    SOCKINFO* info,
    SOCKET sockfd);
 
// Don't export function symbol; only used library intern.
int sock_init_with_ip(
    SOCKINFO* info,
    SOCKET sockfd,
    struct sockaddr* foreign_sockaddr);
 
// Don't export function symbol; only used library intern.
#ifdef UPnPsdk_HAVE_OPENSSL
int sock_ssl_connect(
    SOCKINFO* info);
#endif
 
// Don't export function symbol; only used library intern.
int sock_destroy(
    SOCKINFO* info,
    int ShutdownMethod);
 
// Don't export function symbol; only used library intern.
int sock_read(
    SOCKINFO* info,
    char* buffer,
    size_t bufsize,
    int* timeoutSecs);
 
// Don't export function symbol; only used library intern.
int sock_write(
    SOCKINFO* info,
    const char* buffer,
    size_t bufsize,
    int* timeoutSecs);
 
// Don't export function symbol; only used library intern.
int sock_make_blocking(
    /* [in] socket. */
    SOCKET sock);
 
// Don't export function symbol; only used library intern.
int sock_make_no_blocking(
    /* [in] socket. */
    SOCKET sock);
 
#endif /* COMPA_SOCK_HPP */