| 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, <[email protected]>, 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 |
|
|---|
| 31 | struct Curl_addrinfo;
|
|---|
| 32 | struct Curl_cfilter;
|
|---|
| 33 | struct Curl_easy;
|
|---|
| 34 | struct connectdata;
|
|---|
| 35 | struct Curl_sockaddr_ex;
|
|---|
| 36 | struct ip_quadruple;
|
|---|
| 37 |
|
|---|
| 38 | /*
|
|---|
| 39 | * The Curl_sockaddr_ex structure is basically libcurl's external API
|
|---|
| 40 | * curl_sockaddr structure with enough space available to directly hold any
|
|---|
| 41 | * protocol-specific address structures. The variable declared here will be
|
|---|
| 42 | * used to pass / receive data to/from the fopensocket callback if this has
|
|---|
| 43 | * been set, before that, it is initialized from parameters.
|
|---|
| 44 | */
|
|---|
| 45 | struct Curl_sockaddr_ex {
|
|---|
| 46 | int family;
|
|---|
| 47 | int socktype;
|
|---|
| 48 | int protocol;
|
|---|
| 49 | unsigned int addrlen;
|
|---|
| 50 | union {
|
|---|
| 51 | struct sockaddr addr;
|
|---|
| 52 | struct Curl_sockaddr_storage buff;
|
|---|
| 53 | } _sa_ex_u;
|
|---|
| 54 | };
|
|---|
| 55 | #define curl_sa_addr _sa_ex_u.addr
|
|---|
| 56 |
|
|---|
| 57 | /*
|
|---|
| 58 | * Parse interface option, and return the interface name and the host part.
|
|---|
| 59 | */
|
|---|
| 60 | CURLcode Curl_parse_interface(const char *input,
|
|---|
| 61 | char **dev, char **iface, char **host);
|
|---|
| 62 |
|
|---|
| 63 | /*
|
|---|
| 64 | * Create a socket based on info from 'conn' and 'ai'.
|
|---|
| 65 | *
|
|---|
| 66 | * Fill in 'addr' and 'sockfd' accordingly if OK is returned. If the open
|
|---|
| 67 | * socket callback is set, used that!
|
|---|
| 68 | *
|
|---|
| 69 | */
|
|---|
| 70 | CURLcode Curl_socket_open(struct Curl_easy *data,
|
|---|
| 71 | const struct Curl_addrinfo *ai,
|
|---|
| 72 | struct Curl_sockaddr_ex *addr,
|
|---|
| 73 | int transport,
|
|---|
| 74 | curl_socket_t *sockfd);
|
|---|
| 75 |
|
|---|
| 76 | int Curl_socket_close(struct Curl_easy *data, struct connectdata *conn,
|
|---|
| 77 | curl_socket_t sock);
|
|---|
| 78 |
|
|---|
| 79 | #ifdef USE_WINSOCK
|
|---|
| 80 | /* When you run a program that uses the Windows Sockets API, you may
|
|---|
| 81 | experience slow performance when you copy data to a TCP server.
|
|---|
| 82 |
|
|---|
| 83 | https://support.microsoft.com/kb/823764
|
|---|
| 84 |
|
|---|
| 85 | Work-around: Make the Socket Send Buffer Size Larger Than the Program Send
|
|---|
| 86 | Buffer Size
|
|---|
| 87 |
|
|---|
| 88 | */
|
|---|
| 89 | void Curl_sndbuf_init(curl_socket_t sockfd);
|
|---|
| 90 | #else
|
|---|
| 91 | #define Curl_sndbuf_init(y) Curl_nop_stmt
|
|---|
| 92 | #endif
|
|---|
| 93 |
|
|---|
| 94 | /**
|
|---|
| 95 | * Assign the address `ai` to the Curl_sockaddr_ex `dest` and
|
|---|
| 96 | * set the transport used.
|
|---|
| 97 | */
|
|---|
| 98 | void Curl_sock_assign_addr(struct Curl_sockaddr_ex *dest,
|
|---|
| 99 | const struct Curl_addrinfo *ai,
|
|---|
| 100 | int transport);
|
|---|
| 101 |
|
|---|
| 102 | /**
|
|---|
| 103 | * Creates a cfilter that opens a TCP socket to the given address
|
|---|
| 104 | * when calling its `connect` implementation.
|
|---|
| 105 | * The filter will not touch any connection/data flags and can be
|
|---|
| 106 | * used in happy eyeballing. Once selected for use, its `_active()`
|
|---|
| 107 | * method needs to be called.
|
|---|
| 108 | */
|
|---|
| 109 | CURLcode Curl_cf_tcp_create(struct Curl_cfilter **pcf,
|
|---|
| 110 | struct Curl_easy *data,
|
|---|
| 111 | struct connectdata *conn,
|
|---|
| 112 | const struct Curl_addrinfo *ai,
|
|---|
| 113 | int transport);
|
|---|
| 114 |
|
|---|
| 115 | /**
|
|---|
| 116 | * Creates a cfilter that opens a UDP socket to the given address
|
|---|
| 117 | * when calling its `connect` implementation.
|
|---|
| 118 | * The filter will not touch any connection/data flags and can be
|
|---|
| 119 | * used in happy eyeballing. Once selected for use, its `_active()`
|
|---|
| 120 | * method needs to be called.
|
|---|
| 121 | */
|
|---|
| 122 | CURLcode Curl_cf_udp_create(struct Curl_cfilter **pcf,
|
|---|
| 123 | struct Curl_easy *data,
|
|---|
| 124 | struct connectdata *conn,
|
|---|
| 125 | const struct Curl_addrinfo *ai,
|
|---|
| 126 | int transport);
|
|---|
| 127 |
|
|---|
| 128 | /**
|
|---|
| 129 | * Creates a cfilter that opens a UNIX socket to the given address
|
|---|
| 130 | * when calling its `connect` implementation.
|
|---|
| 131 | * The filter will not touch any connection/data flags and can be
|
|---|
| 132 | * used in happy eyeballing. Once selected for use, its `_active()`
|
|---|
| 133 | * method needs to be called.
|
|---|
| 134 | */
|
|---|
| 135 | CURLcode Curl_cf_unix_create(struct Curl_cfilter **pcf,
|
|---|
| 136 | struct Curl_easy *data,
|
|---|
| 137 | struct connectdata *conn,
|
|---|
| 138 | const struct Curl_addrinfo *ai,
|
|---|
| 139 | int transport);
|
|---|
| 140 |
|
|---|
| 141 | /**
|
|---|
| 142 | * Creates a cfilter that keeps a listening socket.
|
|---|
| 143 | */
|
|---|
| 144 | CURLcode Curl_conn_tcp_listen_set(struct Curl_easy *data,
|
|---|
| 145 | struct connectdata *conn,
|
|---|
| 146 | int sockindex,
|
|---|
| 147 | curl_socket_t *s);
|
|---|
| 148 |
|
|---|
| 149 | /**
|
|---|
| 150 | * Return TRUE iff the last filter at `sockindex` was set via
|
|---|
| 151 | * Curl_conn_tcp_listen_set().
|
|---|
| 152 | */
|
|---|
| 153 | bool Curl_conn_is_tcp_listen(struct Curl_easy *data,
|
|---|
| 154 | int sockindex);
|
|---|
| 155 |
|
|---|
| 156 | /**
|
|---|
| 157 | * Peek at the socket and remote ip/port the socket filter is using.
|
|---|
| 158 | * The filter owns all returned values.
|
|---|
| 159 | * @param psock pointer to hold socket descriptor or NULL
|
|---|
| 160 | * @param paddr pointer to hold addr reference or NULL
|
|---|
| 161 | * @param pip pointer to get IP quadruple or NULL
|
|---|
| 162 | * Returns error if the filter is of invalid type.
|
|---|
| 163 | */
|
|---|
| 164 | CURLcode Curl_cf_socket_peek(struct Curl_cfilter *cf,
|
|---|
| 165 | struct Curl_easy *data,
|
|---|
| 166 | curl_socket_t *psock,
|
|---|
| 167 | const struct Curl_sockaddr_ex **paddr,
|
|---|
| 168 | struct ip_quadruple *pip);
|
|---|
| 169 |
|
|---|
| 170 | extern struct Curl_cftype Curl_cft_tcp;
|
|---|
| 171 | extern struct Curl_cftype Curl_cft_udp;
|
|---|
| 172 | extern struct Curl_cftype Curl_cft_unix;
|
|---|
| 173 | extern struct Curl_cftype Curl_cft_tcp_accept;
|
|---|
| 174 |
|
|---|
| 175 | #endif /* HEADER_CURL_CF_SOCKET_H */
|
|---|
