An example of curl_multi

curl-sys/lib.rs

@@ -8,8 +8,11 @@ use libc::{c_void, c_int, c_char, c_uint, c_long};
 
 pub type CURLINFO = c_int;
 pub type CURL = c_void;
+pub type CURLM = c_void;
 pub type curl_slist = c_void;
 pub type CURLoption = c_int;
+pub type CURLMoption = c_int;
+pub type C = c_int;
 
 #[repr(C)]
 #[derive(Clone, Copy)]
@@ -465,13 +468,103 @@ ALIAS!(CURLOPT_WRITEDATA, CURLOPT_FILE);
 ALIAS!(CURLOPT_HEADERDATA, CURLOPT_WRITEHEADER);
 ALIAS!(CURLOPT_XFERINFODATA, CURLOPT_PROGRESSDATA);
 
+macro_rules! DEFOPTM {
+    ($name:ident, $ty:ident, $num:expr) => (
+        #[allow(dead_code)]
+        pub const $name: CURLMoption = $ty + $num;
+    )
+}
+
+macro_rules! ALIASM {
+    ($name:ident, $to:ident) => (
+        #[allow(dead_code)]
+        pub const $name: CURLMoption = $to;
+    )
+}
+
+#[repr(C)]
+#[derive(Copy, Clone, Debug)]
+pub enum CURLMcode {
+    CURLM_CALL_MULTI_PERFORM = -1, /* please call curl_multi_perform() or
+                                    curl_multi_socket*() soon */
+    CURLM_OK,
+    CURLM_BAD_HANDLE, /* the passed-in handle is not a valid CURLM handle */
+    CURLM_BAD_EASY_HANDLE, /* an easy handle was not good/valid */
+    CURLM_OUT_OF_MEMORY, /* if you ever get this, you're in deep sh*t */
+    CURLM_INTERNAL_ERROR, /* this is a libcurl bug */
+    CURLM_BAD_SOCKET, /* the passed in socket argument did not match */
+    CURLM_UNKNOWN_OPTION, /* curl_multi_setopt() with unsupported option */
+    CURLM_ADDED_ALREADY, /* an easy handle already added to a multi handle was
+                            attempted to get added - again */
+    CURLM_LAST
+}
+
+/* This is the socket callback function pointer */
+DEFOPTM!(CURLMOPT_SOCKETFUNCTION, FUNCTIONPOINT, 1);
+/* This is the argument passed to the socket callback */
+DEFOPTM!(CURLMOPT_SOCKETDATA, OBJECTPOINT, 2);
+
+/* set to 1 to enable pipelining for this multi handle */
+DEFOPTM!(PIPELINING, LONG, 3);
+
+/* This is the timer callback function pointer */
+DEFOPTM!(TIMERFUNCTION, FUNCTIONPOINT, 4);
+
+/* This is the argument passed to the timer callback */
+DEFOPTM!(TIMERDATA, OBJECTPOINT, 5);
+
+/* maximum number of entries in the connection cache */
+DEFOPTM!(MAXCONNECTS, LONG, 6);
+
+/* maximum number of (pipelining) connections to one host */
+DEFOPTM!(MAX_HOST_CONNECTIONS, LONG, 7);
+
+/* maximum number of requests in a pipeline */
+DEFOPTM!(MAX_PIPELINE_LENGTH, LONG, 8);
+
+/* a connection with a content-length longer than this
+      will not be considered for pipelining */
+DEFOPTM!(CONTENT_LENGTH_PENALTY_SIZE, OFF_T, 9);
+
+/* a connection with a chunk length longer than this
+      will not be considered for pipelining */
+DEFOPTM!(CHUNK_LENGTH_PENALTY_SIZE, OFF_T, 10);
+
+/* a list of site names(+port) that are blacklisted from
+      pipelining */
+DEFOPTM!(PIPELINING_SITE_BL, OBJECTPOINT, 11);
+
+/* a list of server types that are blacklisted from
+      pipelining */
+DEFOPTM!(PIPELINING_SERVER_BL, OBJECTPOINT, 12);
+
+/* maximum number of open connections in total */
+DEFOPTM!(MAX_TOTAL_CONNECTIONS, LONG, 13);
+
+//CURLMOPT_LASTENTRY /* the last unused */
+
+ALIASM!(LONG, CURLOPTTYPE_LONG);
+ALIASM!(OBJECTPOINT, CURLOPTTYPE_OBJECTPOINT);
+ALIASM!(FUNCTIONPOINT, CURLOPTTYPE_FUNCTIONPOINT);
+ALIASM!(OFF_T, CURLOPTTYPE_OFF_T);
+
 extern {
+
+    // Easy curl mode (one thread per connection)
     pub fn curl_easy_strerror(code: CURLcode) -> *const c_char;
     pub fn curl_easy_init() -> *mut CURL;
     pub fn curl_easy_setopt(curl: *mut CURL, option: CURLoption, ...) -> CURLcode;
     pub fn curl_easy_perform(curl: *mut CURL) -> CURLcode;
     pub fn curl_easy_cleanup(curl: *mut CURL);
     pub fn curl_easy_getinfo(curl: *const CURL, info: CURLINFO, ...) -> CURLcode;
+
+    // Multi curl mode
+    pub fn curl_multi_cleanup(curl: *mut CURLM);
+    pub fn curl_multi_add_handle(curl: *mut CURLM, easy: *mut CURL) ->CURLMcode;
+    pub fn curl_multi_init() -> *mut CURLM;
+    pub fn curl_multi_setopt(curl: *mut CURLM, option: CURLMoption, ...) -> CURLMcode;
+    pub fn curl_multi_strerror(code: CURLMcode) -> *const c_char;
+
     pub fn curl_global_cleanup();
 
     pub fn curl_slist_append(list: *mut curl_slist,

curl-sys/multi.rs

@@ -0,0 +1,110 @@
+#![allow(non_camel_case_types, raw_pointer_derive)]
+
+extern crate libc;
+#[cfg(not(target_env = "msvc"))]
+extern crate libz_sys;
+#[cfg(unix)]
+extern crate openssl_sys;
+
+use libc::{c_void, c_int, c_char, c_uint, c_long};
+
+pub type CURL = c_void;
+pub type CURLM = c_void;
+pub type CURLMoption = c_int;
+pub type C = c_int;
+
+
+pub const CURLOPTTYPE_LONG: c_int = 0;
+pub const CURLOPTTYPE_OBJECTPOINT: c_int = 10_000;
+pub const CURLOPTTYPE_FUNCTIONPOINT: c_int = 20_000;
+pub const CURLOPTTYPE_OFF_T: c_int = 30_000;
+
+
+macro_rules! DEFOPTM {
+    ($name:ident, $ty:ident, $num:expr) => (
+        #[allow(dead_code)]
+        pub const $name: CURLMoption = $ty + $num;
+    )
+}
+
+macro_rules! ALIASM {
+    ($name:ident, $to:ident) => (
+        #[allow(dead_code)]
+        pub const $name: CURLMoption = $to;
+    )
+}
+
+#[repr(C)]
+#[derive(Copy, Clone, Debug)]
+pub enum CURLMcode {
+    CURLM_CALL_MULTI_PERFORM = -1, /* please call curl_multi_perform() or
+                                    curl_multi_socket*() soon */
+    CURLM_OK,
+    CURLM_BAD_HANDLE, /* the passed-in handle is not a valid CURLM handle */
+    CURLM_BAD_EASY_HANDLE, /* an easy handle was not good/valid */
+    CURLM_OUT_OF_MEMORY, /* if you ever get this, you're in deep sh*t */
+    CURLM_INTERNAL_ERROR, /* this is a libcurl bug */
+    CURLM_BAD_SOCKET, /* the passed in socket argument did not match */
+    CURLM_UNKNOWN_OPTION, /* curl_multi_setopt() with unsupported option */
+    CURLM_ADDED_ALREADY, /* an easy handle already added to a multi handle was
+                            attempted to get added - again */
+    CURLM_LAST
+}
+
+/* This is the socket callback function pointer */
+DEFOPTM!(CURLMOPT_SOCKETFUNCTION, FUNCTIONPOINT, 1);
+/* This is the argument passed to the socket callback */
+DEFOPTM!(CURLMOPT_SOCKETDATA, OBJECTPOINT, 2);
+
+/* set to 1 to enable pipelining for this multi handle */
+DEFOPTM!(PIPELINING, LONG, 3);
+
+/* This is the timer callback function pointer */
+DEFOPTM!(TIMERFUNCTION, FUNCTIONPOINT, 4);
+
+/* This is the argument passed to the timer callback */
+DEFOPTM!(TIMERDATA, OBJECTPOINT, 5);
+
+/* maximum number of entries in the connection cache */
+DEFOPTM!(MAXCONNECTS, LONG, 6);
+
+/* maximum number of (pipelining) connections to one host */
+DEFOPTM!(MAX_HOST_CONNECTIONS, LONG, 7);
+
+/* maximum number of requests in a pipeline */
+DEFOPTM!(MAX_PIPELINE_LENGTH, LONG, 8);
+
+/* a connection with a content-length longer than this
+      will not be considered for pipelining */
+DEFOPTM!(CONTENT_LENGTH_PENALTY_SIZE, OFF_T, 9);
+
+/* a connection with a chunk length longer than this
+      will not be considered for pipelining */
+DEFOPTM!(CHUNK_LENGTH_PENALTY_SIZE, OFF_T, 10);
+
+/* a list of site names(+port) that are blacklisted from
+      pipelining */
+DEFOPTM!(PIPELINING_SITE_BL, OBJECTPOINT, 11);
+
+/* a list of server types that are blacklisted from
+      pipelining */
+DEFOPTM!(PIPELINING_SERVER_BL, OBJECTPOINT, 12);
+
+/* maximum number of open connections in total */
+DEFOPTM!(MAX_TOTAL_CONNECTIONS, LONG, 13);
+
+//CURLMOPT_LASTENTRY /* the last unused */
+
+ALIASM!(LONG, CURLOPTTYPE_LONG);
+ALIASM!(OBJECTPOINT, CURLOPTTYPE_OBJECTPOINT);
+ALIASM!(FUNCTIONPOINT, CURLOPTTYPE_FUNCTIONPOINT);
+ALIASM!(OFF_T, CURLOPTTYPE_OFF_T);
+
+extern {
+    // Multi curl mode
+    pub fn curl_multi_cleanup(curl: *mut CURLM);
+    pub fn curl_multi_add_handle(curl: *mut CURLM, easy: *mut CURL) ->CURLMcode;
+    pub fn curl_multi_init() -> *mut CURLM;
+    pub fn curl_multi_setopt(curl: *mut CURLM, option: CURLMoption, ...) -> CURLMcode;
+    pub fn curl_multi_strerror(code: CURLMcode) -> *const c_char;
+}

src/ffi/easy.rs

@@ -15,7 +15,7 @@ use curl_ffi as ffi;
 pub type ProgressCb<'a> = FnMut(usize, usize, usize, usize) + 'a;
 
 pub struct Easy {
-    curl: *mut ffi::CURL
+    pub curl: *mut ffi::CURL
 }
 
 impl Easy {

src/ffi/mod.rs

@@ -6,5 +6,8 @@ pub mod easy;
 pub mod err;
 pub mod info;
 pub mod list;
+pub mod multi;
+pub mod multi_err;
+pub mod multi_opt;
 pub mod opt;
 pub mod version;