Commit 8c490ccf authored by Rémi Denis-Courmont's avatar Rémi Denis-Courmont

https: move some documentation to header file

parent bb931e14
...@@ -36,13 +36,6 @@ ...@@ -36,13 +36,6 @@
#include "transport.h" #include "transport.h"
/**
* Receives TLS data.
*
* Receives bytes from the peer through a TLS session.
* @note This may be a cancellation point.
* The caller is responsible for serializing reads on a given connection.
*/
ssize_t vlc_https_recv(vlc_tls_t *tls, void *buf, size_t len) ssize_t vlc_https_recv(vlc_tls_t *tls, void *buf, size_t len)
{ {
struct pollfd ufd; struct pollfd ufd;
...@@ -99,11 +92,6 @@ ssize_t vlc_http_recv(int fd, void *buf, size_t len) ...@@ -99,11 +92,6 @@ ssize_t vlc_http_recv(int fd, void *buf, size_t len)
return count; return count;
} }
/**
* Sends bytes to a connection.
* @note This may be a cancellation point.
* The caller is responsible for serializing writes on a given connection.
*/
ssize_t vlc_https_send(vlc_tls_t *tls, const void *buf, size_t len) ssize_t vlc_https_send(vlc_tls_t *tls, const void *buf, size_t len)
{ {
struct pollfd ufd; struct pollfd ufd;
......
...@@ -28,8 +28,23 @@ struct vlc_tls; ...@@ -28,8 +28,23 @@ struct vlc_tls;
struct vlc_tls_creds; struct vlc_tls_creds;
ssize_t vlc_http_recv(int fd, void *buf, size_t len); ssize_t vlc_http_recv(int fd, void *buf, size_t len);
/**
* Receives TLS data.
*
* Receives bytes from the peer through a TLS session.
* @note This may be a cancellation point.
* The caller is responsible for serializing reads on a given connection.
*/
ssize_t vlc_https_recv(struct vlc_tls *tls, void *buf, size_t len); ssize_t vlc_https_recv(struct vlc_tls *tls, void *buf, size_t len);
ssize_t vlc_http_send(int fd, const void *buf, size_t len); ssize_t vlc_http_send(int fd, const void *buf, size_t len);
/**
* Sends bytes to a connection.
* @note This may be a cancellation point.
* The caller is responsible for serializing writes on a given connection.
*/
ssize_t vlc_https_send(struct vlc_tls *tls, const void *buf, size_t len); ssize_t vlc_https_send(struct vlc_tls *tls, const void *buf, size_t len);
struct vlc_tls *vlc_https_connect(struct vlc_tls_creds *creds, struct vlc_tls *vlc_https_connect(struct vlc_tls_creds *creds,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment