annotate stream/url.h @ 36928:6738386f30da

Add doxygen comment. Additionally, rename a variable.
author ib
date Wed, 19 Mar 2014 14:16:30 +0000
parents 06847bdbe4bc
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 26029
diff changeset
1 /*
902
ede5785faa53 Bugs fix, improvements...
bertrand
parents: 840
diff changeset
2 * URL Helper
30426
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
3 *
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
4 * Copyright (C) 2001 Bertrand Baudet <bertrand_baudet@yahoo.com>
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
5 *
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
6 * This file is part of MPlayer.
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
7 *
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
8 * MPlayer is free software; you can redistribute it and/or modify
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
9 * it under the terms of the GNU General Public License as published by
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
10 * the Free Software Foundation; either version 2 of the License, or
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
11 * (at your option) any later version.
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
12 *
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
13 * MPlayer is distributed in the hope that it will be useful,
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
16 * GNU General Public License for more details.
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
17 *
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
18 * You should have received a copy of the GNU General Public License along
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
19 * with MPlayer; if not, write to the Free Software Foundation, Inc.,
ce0122361a39 Add license header to all files missing it in the stream subdirectory.
diego
parents: 29263
diff changeset
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
902
ede5785faa53 Bugs fix, improvements...
bertrand
parents: 840
diff changeset
21 */
ede5785faa53 Bugs fix, improvements...
bertrand
parents: 840
diff changeset
22
26029
4129c8cfa742 Add MPLAYER_ prefix to multiple inclusion guards.
diego
parents: 23689
diff changeset
23 #ifndef MPLAYER_URL_H
4129c8cfa742 Add MPLAYER_ prefix to multiple inclusion guards.
diego
parents: 23689
diff changeset
24 #define MPLAYER_URL_H
833
b8cecdc0c67f Starting implementation of ASF network streaming.
bertrand
parents:
diff changeset
25
23689
3f0d00abc073 Do not use leading underscores in multiple inclusion guards, they are reserved.
diego
parents: 20784
diff changeset
26 //#define URL_DEBUG
4119
639b3b47b138 Added a debug function to print the struct's variables.
bertrand
parents: 3496
diff changeset
27
833
b8cecdc0c67f Starting implementation of ASF network streaming.
bertrand
parents:
diff changeset
28 typedef struct {
b8cecdc0c67f Starting implementation of ASF network streaming.
bertrand
parents:
diff changeset
29 char *url;
32553
c44141d4e443 Do not keep authentication in URL on connection through a proxy
cboesch
parents: 30426
diff changeset
30 char *noauth_url;
833
b8cecdc0c67f Starting implementation of ASF network streaming.
bertrand
parents:
diff changeset
31 char *protocol;
b8cecdc0c67f Starting implementation of ASF network streaming.
bertrand
parents:
diff changeset
32 char *hostname;
840
9141234715a2 Added initialisation of URL pointers.
bertrand
parents: 833
diff changeset
33 char *file;
833
b8cecdc0c67f Starting implementation of ASF network streaming.
bertrand
parents:
diff changeset
34 unsigned int port;
902
ede5785faa53 Bugs fix, improvements...
bertrand
parents: 840
diff changeset
35 char *username;
ede5785faa53 Bugs fix, improvements...
bertrand
parents: 840
diff changeset
36 char *password;
833
b8cecdc0c67f Starting implementation of ASF network streaming.
bertrand
parents:
diff changeset
37 } URL_t;
b8cecdc0c67f Starting implementation of ASF network streaming.
bertrand
parents:
diff changeset
38
35113
06847bdbe4bc Fix redirection for proxy URLs.
reimar
parents: 32885
diff changeset
39 int url_is_protocol(const URL_t *url, const char *proto);
06847bdbe4bc Fix redirection for proxy URLs.
reimar
parents: 32885
diff changeset
40 void url_set_protocol(URL_t *url, const char *proto);
20784
720206eef78b Support URL redirections that do not specify full URL.
reimar
parents: 19271
diff changeset
41 URL_t *url_redirect(URL_t **url, const char *redir);
32586
31a65f4ca3bb Add support for login/password in http_proxy env variable.
cboesch
parents: 32553
diff changeset
42
32885
34fb7af52b82 Make proxy and url parameter const in get_noauth_url and get_http_proxy_url.
cboesch
parents: 32884
diff changeset
43 char *get_http_proxy_url(const URL_t *proxy, const char *host_url);
32586
31a65f4ca3bb Add support for login/password in http_proxy env variable.
cboesch
parents: 32553
diff changeset
44
9690
a9b7b6055563 Added support for IPv6 numeric url like: http://[3ffe:400:100::1]:80/file
bertrand
parents: 7279
diff changeset
45 URL_t* url_new(const char* url);
902
ede5785faa53 Bugs fix, improvements...
bertrand
parents: 840
diff changeset
46 void url_free(URL_t* url);
833
b8cecdc0c67f Starting implementation of ASF network streaming.
bertrand
parents:
diff changeset
47
9690
a9b7b6055563 Added support for IPv6 numeric url like: http://[3ffe:400:100::1]:80/file
bertrand
parents: 7279
diff changeset
48 void url_unescape_string(char *outbuf, const char *inbuf);
a9b7b6055563 Added support for IPv6 numeric url like: http://[3ffe:400:100::1]:80/file
bertrand
parents: 7279
diff changeset
49 void url_escape_string(char *outbuf, const char *inbuf);
3496
5c8a533dfa09 Added 2 functions to escape/unescape the url as described in the RFC 2396.
bertrand
parents: 3040
diff changeset
50
23689
3f0d00abc073 Do not use leading underscores in multiple inclusion guards, they are reserved.
diego
parents: 20784
diff changeset
51 #ifdef URL_DEBUG
9690
a9b7b6055563 Added support for IPv6 numeric url like: http://[3ffe:400:100::1]:80/file
bertrand
parents: 7279
diff changeset
52 void url_debug(const URL_t* url);
23689
3f0d00abc073 Do not use leading underscores in multiple inclusion guards, they are reserved.
diego
parents: 20784
diff changeset
53 #endif /* URL_DEBUG */
4119
639b3b47b138 Added a debug function to print the struct's variables.
bertrand
parents: 3496
diff changeset
54
26029
4129c8cfa742 Add MPLAYER_ prefix to multiple inclusion guards.
diego
parents: 23689
diff changeset
55 #endif /* MPLAYER_URL_H */