conn.h

Go to the documentation of this file.

/*****************************************************************************
 * conn.h: HTTP connections
 *****************************************************************************
 * Copyright (C) 2015 Rémi Denis-Courmont
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/
 
/**
 * \defgroup http_conn Connections
 * HTTP connections
 * \ingroup http_connmgr
 * @{
 */
 
struct vlc_tls;
struct vlc_http_conn;
struct vlc_http_msg;
struct vlc_http_stream;
 
struct vlc_http_conn_cbs
{
    struct vlc_http_stream *(*stream_open)(struct vlc_http_conn *,
                                           const struct vlc_http_msg *,
                                           bool has_data);
    void (*release)(struct vlc_http_conn *);
};
 
struct vlc_http_conn
{
    const struct vlc_http_conn_cbs *cbs;
    struct vlc_tls *tls;
};
 
static inline struct vlc_http_stream *
vlc_http_stream_open(struct vlc_http_conn *conn, const struct vlc_http_msg *m,
                     bool has_data)
{
    return conn->cbs->stream_open(conn, m, has_data);
}
 
static inline void vlc_http_conn_release(struct vlc_http_conn *conn)
{
    conn->cbs->release(conn);
}
 
void vlc_http_err(void *, const char *msg, ...) VLC_FORMAT(2, 3);
void vlc_http_dbg(void *, const char *msg, ...) VLC_FORMAT(2, 3);
 
/**
 * \defgroup http1 HTTP/1.x
 * @{
 */
struct vlc_http_conn *vlc_h1_conn_create(void *ctx, struct vlc_tls *,
                                         bool proxy);
struct vlc_http_stream *vlc_chunked_open(struct vlc_http_stream *,
                                         struct vlc_tls *);
ssize_t vlc_https_chunked_write(struct vlc_tls *, const void *base, size_t len,
                                bool eos);
 
/**
 * Sends an HTTP/1.x request through a new connection.
 *
 * This function resolves a the specified HTTP server hostname, establishes a
 * connection to specified TCP port of the server, then sends an HTTP request.
 * The connection is not protected with TLS.
 *
 * All those operations are combined in a single function call in order to
 * support TCP Fast Open. That can save one round-trip when establishing a new
 * HTTP connection.
 
 * \note In the case of TLS, TCP Fast Open would convey the TLS Client Hello
 * message rather than the HTTP request header. The HTTP request header can
 * however be sent with the TLS False Start. This is handled by the TLS stack
 * and does not require a combined function call.
 *
 * \param ctx opaque context pointer for the HTTP connection
 * \param hostname HTTP server or proxy hostname to connect to
 * \param port TCP port number to connect to
 * \param proxy true of the hostname and port correspond to an HTTP proxy,
 *              or false if they correspond to an HTTP origin server
 * \param req HTTP request message
 * \param idempotent whether the HTTP request is idempotent (e.g. GET),
 *                   or not (e.g. POST)
 * \param has_data whether the HTTP request will have a request payload
 * \param connp pointer to storage space for the established HTTP connection
 *              (or NULL if the connection is not to be reused) [OUT]
 *              can be NULL if the connection is not meant to be reused
 * \return an HTTP stream on success, NULL on error
 * \note *connp is undefined on error.
 */
struct vlc_http_stream *vlc_h1_request(void *ctx, const char *hostname,
                                       unsigned port, bool proxy,
                                       const struct vlc_http_msg *req,
                                       bool idempotent, bool has_data,
                                       struct vlc_http_conn **restrict connp);
 
/** @} */
 
/**
 * \defgroup h2 HTTP/2.0
 * @{
 */
struct vlc_http_conn *vlc_h2_conn_create(void *ctx, struct vlc_tls *);
 
/** @} */
 
/** @} */