sock.h
Go to the documentation of this file.
#ifndef GENLIB_NET_SOCK_H
#define GENLIB_NET_SOCK_H
/**************************************************************************
*
* Copyright (c) 2000-2003 Intel Corporation
* All rights reserved.
* Copyright (c) 2012 France Telecom All rights reserved.
*
* 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.
*
**************************************************************************/
#include "UpnpGlobal.h" /* for UPNP_INLINE */
#include "UpnpInet.h" /* for SOCKET, netinet/in */
#include "autoconfig.h"
#ifdef UPNP_ENABLE_OPEN_SSL
#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
typedef struct
{
SOCKET socket;
struct sockaddr_storage foreign_sockaddr;
#ifdef UPNP_ENABLE_OPEN_SSL
SSL *ssl;
#endif
} SOCKINFO;
#ifdef __cplusplus
extern "C" {
#endif
static UPNP_INLINE int sock_close(
SOCKET sock)
{
int ret = -1;
if (sock != INVALID_SOCKET)
ret = UpnpCloseSocket(sock);
return ret;
}
int sock_init(
SOCKINFO *info,
SOCKET sockfd);
int sock_init_with_ip(
SOCKINFO *info,
SOCKET sockfd,
struct sockaddr *foreign_sockaddr);
#ifdef UPNP_ENABLE_OPEN_SSL
int sock_ssl_connect(
SOCKINFO *info);
#endif
int sock_destroy(
SOCKINFO *info,
int ShutdownMethod);
int sock_read(
SOCKINFO *info,
char *buffer,
size_t bufsize,
int *timeoutSecs);
int sock_write(
SOCKINFO *info,
const char *buffer,
size_t bufsize,
int *timeoutSecs);
int sock_make_blocking(
/* [in] socket. */
SOCKET sock);
int sock_make_no_blocking(
/* [in] socket. */
SOCKET sock);
#ifdef __cplusplus
} /* #extern "C" */
#endif
/* @} Sock Network Socket Library */
#endif /* GENLIB_NET_SOCK_H */
UpnpGlobal.h
Defines constants that for some reason are not defined on some systems.
UPNP_INLINE
#define UPNP_INLINE
Declares an inline function.
Definition UpnpGlobal.h:119
UpnpInet.h
Provides a platform independent way to include TCP/IP types and functions.
UpnpCloseSocket
#define UpnpCloseSocket
Definition UpnpInet.h:59
SOCKINFO::socket
SOCKET socket
Definition sock.h:62
SOCKINFO::foreign_sockaddr
struct sockaddr_storage foreign_sockaddr
Definition sock.h:64
sock_write
int sock_write(SOCKINFO *info, const char *buffer, size_t bufsize, int *timeoutSecs)
Writes data on the socket in sockinfo.
Definition sock.c:286
INVALID_SOCKET
#define INVALID_SOCKET
Definition UpnpInet.h:53
sock_init
int sock_init(SOCKINFO *info, SOCKET sockfd)
Assign the passed in socket descriptor to socket descriptor in the SOCKINFO structure.
Definition sock.c:73
sock_destroy
int sock_destroy(SOCKINFO *info, int ShutdownMethod)
Associates an SSL object with the socket and begins the client-side SSL/TLS handshake.
Definition sock.c:119
sock_close
static UPNP_INLINE int sock_close(SOCKET sock)
Closes the socket if it is different from -1.
Definition sock.h:79
sock_read
int sock_read(SOCKINFO *info, char *buffer, size_t bufsize, int *timeoutSecs)
Reads data on socket in sockinfo.
Definition sock.c:281
SOCKET
int SOCKET
Definition UpnpInet.h:50
sock_init_with_ip
int sock_init_with_ip(SOCKINFO *info, SOCKET sockfd, struct sockaddr *foreign_sockaddr)
Calls the sock_init function and assigns the passed in IP address and port to the IP address and port...
Definition sock.c:83
sock_make_blocking
int sock_make_blocking(SOCKET sock)
Make socket blocking.
Definition sock.c:293
sock_make_no_blocking
int sock_make_no_blocking(SOCKET sock)
Make socket non-blocking.
Definition sock.c:309
SOCKINFO
Definition sock.h:60