1#ifndef HEADER_CURL_CF_SOCKET_H 2#define HEADER_CURL_CF_SOCKET_H 3/*************************************************************************** 4 * _ _ ____ _ 5 * Project ___| | | | _ \| | 6 * / __| | | | |_) | | 7 * | (__| |_| | _ <| |___ 8 * \___|\___/|_| \_\_____| 9 * 10 * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 11 * 12 * This software is licensed as described in the file COPYING, which 13 * you should have received as part of this distribution. The terms 14 * are also available at https://curl.se/docs/copyright.html. 15 * 16 * You may opt to use, copy, modify, merge, publish, distribute and/or sell 17 * copies of the Software, and permit persons to whom the Software is 18 * furnished to do so, under the terms of the COPYING file. 19 * 20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY 21 * KIND, either express or implied. 22 * 23 * SPDX-License-Identifier: curl 24 * 25 ***************************************************************************/ 26#include "curl_setup.h" 27 28#include "nonblock.h" /* for curlx_nonblock(), formerly Curl_nonblock() */ 29#include "sockaddr.h" 30 31struct Curl_addrinfo; 32struct Curl_cfilter; 33struct Curl_easy; 34struct connectdata; 35struct Curl_sockaddr_ex; 36 37/* 38 * The Curl_sockaddr_ex structure is basically libcurl's external API 39 * curl_sockaddr structure with enough space available to directly hold any 40 * protocol-specific address structures. The variable declared here will be 41 * used to pass / receive data to/from the fopensocket callback if this has 42 * been set, before that, it is initialized from parameters. 43 */ 44struct Curl_sockaddr_ex { 45 int family; 46 int socktype; 47 int protocol; 48 unsigned int addrlen; 49 union { 50 struct sockaddr addr; 51 struct Curl_sockaddr_storage buff; 52 } _sa_ex_u; 53}; 54#define sa_addr _sa_ex_u.addr 55 56 57/* 58 * Create a socket based on info from 'conn' and 'ai'. 59 * 60 * Fill in 'addr' and 'sockfd' accordingly if OK is returned. If the open 61 * socket callback is set, used that! 62 * 63 */ 64CURLcode Curl_socket_open(struct Curl_easy *data, 65 const struct Curl_addrinfo *ai, 66 struct Curl_sockaddr_ex *addr, 67 int transport, 68 curl_socket_t *sockfd); 69 70int Curl_socket_close(struct Curl_easy *data, struct connectdata *conn, 71 curl_socket_t sock); 72 73#ifdef USE_WINSOCK 74/* When you run a program that uses the Windows Sockets API, you may 75 experience slow performance when you copy data to a TCP server. 76 77 https://support.microsoft.com/kb/823764 78 79 Work-around: Make the Socket Send Buffer Size Larger Than the Program Send 80 Buffer Size 81 82*/ 83void Curl_sndbufset(curl_socket_t sockfd); 84#else 85#define Curl_sndbufset(y) Curl_nop_stmt 86#endif 87 88/** 89 * Assign the address `ai` to the Curl_sockaddr_ex `dest` and 90 * set the transport used. 91 */ 92void Curl_sock_assign_addr(struct Curl_sockaddr_ex *dest, 93 const struct Curl_addrinfo *ai, 94 int transport); 95 96/** 97 * Creates a cfilter that opens a TCP socket to the given address 98 * when calling its `connect` implementation. 99 * The filter will not touch any connection/data flags and can be 100 * used in happy eyeballing. Once selected for use, its `_active()` 101 * method needs to be called. 102 */ 103CURLcode Curl_cf_tcp_create(struct Curl_cfilter **pcf, 104 struct Curl_easy *data, 105 struct connectdata *conn, 106 const struct Curl_addrinfo *ai, 107 int transport); 108 109/** 110 * Creates a cfilter that opens a UDP socket to the given address 111 * when calling its `connect` implementation. 112 * The filter will not touch any connection/data flags and can be 113 * used in happy eyeballing. Once selected for use, its `_active()` 114 * method needs to be called. 115 */ 116CURLcode Curl_cf_udp_create(struct Curl_cfilter **pcf, 117 struct Curl_easy *data, 118 struct connectdata *conn, 119 const struct Curl_addrinfo *ai, 120 int transport); 121 122/** 123 * Creates a cfilter that opens a UNIX socket to the given address 124 * when calling its `connect` implementation. 125 * The filter will not touch any connection/data flags and can be 126 * used in happy eyeballing. Once selected for use, its `_active()` 127 * method needs to be called. 128 */ 129CURLcode Curl_cf_unix_create(struct Curl_cfilter **pcf, 130 struct Curl_easy *data, 131 struct connectdata *conn, 132 const struct Curl_addrinfo *ai, 133 int transport); 134 135/** 136 * Creates a cfilter that keeps a listening socket. 137 */ 138CURLcode Curl_conn_tcp_listen_set(struct Curl_easy *data, 139 struct connectdata *conn, 140 int sockindex, 141 curl_socket_t *s); 142 143/** 144 * Replace the listen socket with the accept()ed one. 145 */ 146CURLcode Curl_conn_tcp_accepted_set(struct Curl_easy *data, 147 struct connectdata *conn, 148 int sockindex, 149 curl_socket_t *s); 150 151/** 152 * Peek at the socket and remote ip/port the socket filter is using. 153 * The filter owns all returned values. 154 * @param psock pointer to hold socket descriptor or NULL 155 * @param paddr pointer to hold addr reference or NULL 156 * @param pr_ip_str pointer to hold remote addr as string or NULL 157 * @param pr_port pointer to hold remote port number or NULL 158 * @param pl_ip_str pointer to hold local addr as string or NULL 159 * @param pl_port pointer to hold local port number or NULL 160 * Returns error if the filter is of invalid type. 161 */ 162CURLcode Curl_cf_socket_peek(struct Curl_cfilter *cf, 163 struct Curl_easy *data, 164 curl_socket_t *psock, 165 const struct Curl_sockaddr_ex **paddr, 166 const char **pr_ip_str, int *pr_port, 167 const char **pl_ip_str, int *pl_port); 168 169extern struct Curl_cftype Curl_cft_tcp; 170extern struct Curl_cftype Curl_cft_udp; 171extern struct Curl_cftype Curl_cft_unix; 172extern struct Curl_cftype Curl_cft_tcp_accept; 173 174#endif /* HEADER_CURL_CF_SOCKET_H */ 175