uv.h 61 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717
  1. /* Copyright Joyent, Inc. and other Node contributors. All rights reserved.
  2. *
  3. * Permission is hereby granted, free of charge, to any person obtaining a copy
  4. * of this software and associated documentation files (the "Software"), to
  5. * deal in the Software without restriction, including without limitation the
  6. * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  7. * sell copies of the Software, and to permit persons to whom the Software is
  8. * furnished to do so, subject to the following conditions:
  9. *
  10. * The above copyright notice and this permission notice shall be included in
  11. * all copies or substantial portions of the Software.
  12. *
  13. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  18. * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  19. * IN THE SOFTWARE.
  20. */
  21. /* See https://github.com/libuv/libuv#documentation for documentation. */
  22. #ifndef UV_H
  23. #define UV_H
  24. /* Include KWSys Large File Support configuration. */
  25. #include <cmsys/Configure.h>
  26. #ifdef __cplusplus
  27. extern "C" {
  28. #endif
  29. #ifdef _WIN32
  30. /* Windows - set up dll import/export decorators. */
  31. # if defined(BUILDING_UV_SHARED)
  32. /* Building shared library. */
  33. # define UV_EXTERN __declspec(dllexport)
  34. # elif defined(USING_UV_SHARED)
  35. /* Using shared library. */
  36. # define UV_EXTERN __declspec(dllimport)
  37. # else
  38. /* Building static library. */
  39. # define UV_EXTERN /* nothing */
  40. # endif
  41. #elif __GNUC__ >= 4
  42. # define UV_EXTERN __attribute__((visibility("default")))
  43. #else
  44. # define UV_EXTERN /* nothing */
  45. #endif
  46. #include "uv/errno.h"
  47. #include "uv/version.h"
  48. #include <stddef.h>
  49. #include <stdio.h>
  50. #if defined(_MSC_VER) && _MSC_VER < 1600
  51. # include "uv/stdint-msvc2008.h"
  52. #else
  53. # include <stdint.h>
  54. #endif
  55. #if defined(_WIN32)
  56. # include "uv/win.h"
  57. #else
  58. # include "uv/unix.h"
  59. #endif
  60. /* Expand this list if necessary. */
  61. #define UV_ERRNO_MAP(XX) \
  62. XX(E2BIG, "argument list too long") \
  63. XX(EACCES, "permission denied") \
  64. XX(EADDRINUSE, "address already in use") \
  65. XX(EADDRNOTAVAIL, "address not available") \
  66. XX(EAFNOSUPPORT, "address family not supported") \
  67. XX(EAGAIN, "resource temporarily unavailable") \
  68. XX(EAI_ADDRFAMILY, "address family not supported") \
  69. XX(EAI_AGAIN, "temporary failure") \
  70. XX(EAI_BADFLAGS, "bad ai_flags value") \
  71. XX(EAI_BADHINTS, "invalid value for hints") \
  72. XX(EAI_CANCELED, "request canceled") \
  73. XX(EAI_FAIL, "permanent failure") \
  74. XX(EAI_FAMILY, "ai_family not supported") \
  75. XX(EAI_MEMORY, "out of memory") \
  76. XX(EAI_NODATA, "no address") \
  77. XX(EAI_NONAME, "unknown node or service") \
  78. XX(EAI_OVERFLOW, "argument buffer overflow") \
  79. XX(EAI_PROTOCOL, "resolved protocol is unknown") \
  80. XX(EAI_SERVICE, "service not available for socket type") \
  81. XX(EAI_SOCKTYPE, "socket type not supported") \
  82. XX(EALREADY, "connection already in progress") \
  83. XX(EBADF, "bad file descriptor") \
  84. XX(EBUSY, "resource busy or locked") \
  85. XX(ECANCELED, "operation canceled") \
  86. XX(ECHARSET, "invalid Unicode character") \
  87. XX(ECONNABORTED, "software caused connection abort") \
  88. XX(ECONNREFUSED, "connection refused") \
  89. XX(ECONNRESET, "connection reset by peer") \
  90. XX(EDESTADDRREQ, "destination address required") \
  91. XX(EEXIST, "file already exists") \
  92. XX(EFAULT, "bad address in system call argument") \
  93. XX(EFBIG, "file too large") \
  94. XX(EHOSTUNREACH, "host is unreachable") \
  95. XX(EINTR, "interrupted system call") \
  96. XX(EINVAL, "invalid argument") \
  97. XX(EIO, "i/o error") \
  98. XX(EISCONN, "socket is already connected") \
  99. XX(EISDIR, "illegal operation on a directory") \
  100. XX(ELOOP, "too many symbolic links encountered") \
  101. XX(EMFILE, "too many open files") \
  102. XX(EMSGSIZE, "message too long") \
  103. XX(ENAMETOOLONG, "name too long") \
  104. XX(ENETDOWN, "network is down") \
  105. XX(ENETUNREACH, "network is unreachable") \
  106. XX(ENFILE, "file table overflow") \
  107. XX(ENOBUFS, "no buffer space available") \
  108. XX(ENODEV, "no such device") \
  109. XX(ENOENT, "no such file or directory") \
  110. XX(ENOMEM, "not enough memory") \
  111. XX(ENONET, "machine is not on the network") \
  112. XX(ENOPROTOOPT, "protocol not available") \
  113. XX(ENOSPC, "no space left on device") \
  114. XX(ENOSYS, "function not implemented") \
  115. XX(ENOTCONN, "socket is not connected") \
  116. XX(ENOTDIR, "not a directory") \
  117. XX(ENOTEMPTY, "directory not empty") \
  118. XX(ENOTSOCK, "socket operation on non-socket") \
  119. XX(ENOTSUP, "operation not supported on socket") \
  120. XX(EPERM, "operation not permitted") \
  121. XX(EPIPE, "broken pipe") \
  122. XX(EPROTO, "protocol error") \
  123. XX(EPROTONOSUPPORT, "protocol not supported") \
  124. XX(EPROTOTYPE, "protocol wrong type for socket") \
  125. XX(ERANGE, "result too large") \
  126. XX(EROFS, "read-only file system") \
  127. XX(ESHUTDOWN, "cannot send after transport endpoint shutdown") \
  128. XX(ESPIPE, "invalid seek") \
  129. XX(ESRCH, "no such process") \
  130. XX(ETIMEDOUT, "connection timed out") \
  131. XX(ETXTBSY, "text file is busy") \
  132. XX(EXDEV, "cross-device link not permitted") \
  133. XX(UNKNOWN, "unknown error") \
  134. XX(EOF, "end of file") \
  135. XX(ENXIO, "no such device or address") \
  136. XX(EMLINK, "too many links") \
  137. XX(EHOSTDOWN, "host is down") \
  138. XX(EREMOTEIO, "remote I/O error") \
  139. XX(ENOTTY, "inappropriate ioctl for device") \
  140. XX(EFTYPE, "inappropriate file type or format") \
  141. #define UV_HANDLE_TYPE_MAP(XX) \
  142. XX(ASYNC, async) \
  143. XX(CHECK, check) \
  144. XX(FS_EVENT, fs_event) \
  145. XX(FS_POLL, fs_poll) \
  146. XX(HANDLE, handle) \
  147. XX(IDLE, idle) \
  148. XX(NAMED_PIPE, pipe) \
  149. XX(POLL, poll) \
  150. XX(PREPARE, prepare) \
  151. XX(PROCESS, process) \
  152. XX(STREAM, stream) \
  153. XX(TCP, tcp) \
  154. XX(TIMER, timer) \
  155. XX(TTY, tty) \
  156. XX(UDP, udp) \
  157. XX(SIGNAL, signal) \
  158. #define UV_REQ_TYPE_MAP(XX) \
  159. XX(REQ, req) \
  160. XX(CONNECT, connect) \
  161. XX(WRITE, write) \
  162. XX(SHUTDOWN, shutdown) \
  163. XX(UDP_SEND, udp_send) \
  164. XX(FS, fs) \
  165. XX(WORK, work) \
  166. XX(GETADDRINFO, getaddrinfo) \
  167. XX(GETNAMEINFO, getnameinfo) \
  168. typedef enum {
  169. #define XX(code, _) UV_ ## code = UV__ ## code,
  170. UV_ERRNO_MAP(XX)
  171. #undef XX
  172. UV_ERRNO_MAX = UV__EOF - 1
  173. } uv_errno_t;
  174. typedef enum {
  175. UV_UNKNOWN_HANDLE = 0,
  176. #define XX(uc, lc) UV_##uc,
  177. UV_HANDLE_TYPE_MAP(XX)
  178. #undef XX
  179. UV_FILE,
  180. UV_HANDLE_TYPE_MAX
  181. } uv_handle_type;
  182. typedef enum {
  183. UV_UNKNOWN_REQ = 0,
  184. #define XX(uc, lc) UV_##uc,
  185. UV_REQ_TYPE_MAP(XX)
  186. #undef XX
  187. UV_REQ_TYPE_PRIVATE
  188. UV_REQ_TYPE_MAX
  189. } uv_req_type;
  190. /* Handle types. */
  191. typedef struct uv_loop_s uv_loop_t;
  192. typedef struct uv_handle_s uv_handle_t;
  193. typedef struct uv_dir_s uv_dir_t;
  194. typedef struct uv_stream_s uv_stream_t;
  195. typedef struct uv_tcp_s uv_tcp_t;
  196. typedef struct uv_udp_s uv_udp_t;
  197. typedef struct uv_pipe_s uv_pipe_t;
  198. typedef struct uv_tty_s uv_tty_t;
  199. typedef struct uv_poll_s uv_poll_t;
  200. typedef struct uv_timer_s uv_timer_t;
  201. typedef struct uv_prepare_s uv_prepare_t;
  202. typedef struct uv_check_s uv_check_t;
  203. typedef struct uv_idle_s uv_idle_t;
  204. typedef struct uv_async_s uv_async_t;
  205. typedef struct uv_process_s uv_process_t;
  206. typedef struct uv_fs_event_s uv_fs_event_t;
  207. typedef struct uv_fs_poll_s uv_fs_poll_t;
  208. typedef struct uv_signal_s uv_signal_t;
  209. /* Request types. */
  210. typedef struct uv_req_s uv_req_t;
  211. typedef struct uv_getaddrinfo_s uv_getaddrinfo_t;
  212. typedef struct uv_getnameinfo_s uv_getnameinfo_t;
  213. typedef struct uv_shutdown_s uv_shutdown_t;
  214. typedef struct uv_write_s uv_write_t;
  215. typedef struct uv_connect_s uv_connect_t;
  216. typedef struct uv_udp_send_s uv_udp_send_t;
  217. typedef struct uv_fs_s uv_fs_t;
  218. typedef struct uv_work_s uv_work_t;
  219. /* None of the above. */
  220. typedef struct uv_cpu_info_s uv_cpu_info_t;
  221. typedef struct uv_interface_address_s uv_interface_address_t;
  222. typedef struct uv_dirent_s uv_dirent_t;
  223. typedef struct uv_passwd_s uv_passwd_t;
  224. typedef struct uv_utsname_s uv_utsname_t;
  225. typedef enum {
  226. UV_LOOP_BLOCK_SIGNAL
  227. } uv_loop_option;
  228. typedef enum {
  229. UV_RUN_DEFAULT = 0,
  230. UV_RUN_ONCE,
  231. UV_RUN_NOWAIT
  232. } uv_run_mode;
  233. UV_EXTERN unsigned int uv_version(void);
  234. UV_EXTERN const char* uv_version_string(void);
  235. typedef void* (*uv_malloc_func)(size_t size);
  236. typedef void* (*uv_realloc_func)(void* ptr, size_t size);
  237. typedef void* (*uv_calloc_func)(size_t count, size_t size);
  238. typedef void (*uv_free_func)(void* ptr);
  239. UV_EXTERN int uv_replace_allocator(uv_malloc_func malloc_func,
  240. uv_realloc_func realloc_func,
  241. uv_calloc_func calloc_func,
  242. uv_free_func free_func);
  243. UV_EXTERN uv_loop_t* uv_default_loop(void);
  244. UV_EXTERN int uv_loop_init(uv_loop_t* loop);
  245. UV_EXTERN int uv_loop_close(uv_loop_t* loop);
  246. /*
  247. * NOTE:
  248. * This function is DEPRECATED (to be removed after 0.12), users should
  249. * allocate the loop manually and use uv_loop_init instead.
  250. */
  251. UV_EXTERN uv_loop_t* uv_loop_new(void);
  252. /*
  253. * NOTE:
  254. * This function is DEPRECATED (to be removed after 0.12). Users should use
  255. * uv_loop_close and free the memory manually instead.
  256. */
  257. UV_EXTERN void uv_loop_delete(uv_loop_t*);
  258. UV_EXTERN size_t uv_loop_size(void);
  259. UV_EXTERN int uv_loop_alive(const uv_loop_t* loop);
  260. UV_EXTERN int uv_loop_configure(uv_loop_t* loop, uv_loop_option option, ...);
  261. UV_EXTERN int uv_loop_fork(uv_loop_t* loop);
  262. UV_EXTERN int uv_run(uv_loop_t*, uv_run_mode mode);
  263. UV_EXTERN void uv_stop(uv_loop_t*);
  264. UV_EXTERN void uv_ref(uv_handle_t*);
  265. UV_EXTERN void uv_unref(uv_handle_t*);
  266. UV_EXTERN int uv_has_ref(const uv_handle_t*);
  267. UV_EXTERN void uv_update_time(uv_loop_t*);
  268. UV_EXTERN uint64_t uv_now(const uv_loop_t*);
  269. UV_EXTERN int uv_backend_fd(const uv_loop_t*);
  270. UV_EXTERN int uv_backend_timeout(const uv_loop_t*);
  271. typedef void (*uv_alloc_cb)(uv_handle_t* handle,
  272. size_t suggested_size,
  273. uv_buf_t* buf);
  274. typedef void (*uv_read_cb)(uv_stream_t* stream,
  275. ssize_t nread,
  276. const uv_buf_t* buf);
  277. typedef void (*uv_write_cb)(uv_write_t* req, int status);
  278. typedef void (*uv_connect_cb)(uv_connect_t* req, int status);
  279. typedef void (*uv_shutdown_cb)(uv_shutdown_t* req, int status);
  280. typedef void (*uv_connection_cb)(uv_stream_t* server, int status);
  281. typedef void (*uv_close_cb)(uv_handle_t* handle);
  282. typedef void (*uv_poll_cb)(uv_poll_t* handle, int status, int events);
  283. typedef void (*uv_timer_cb)(uv_timer_t* handle);
  284. typedef void (*uv_async_cb)(uv_async_t* handle);
  285. typedef void (*uv_prepare_cb)(uv_prepare_t* handle);
  286. typedef void (*uv_check_cb)(uv_check_t* handle);
  287. typedef void (*uv_idle_cb)(uv_idle_t* handle);
  288. typedef void (*uv_exit_cb)(uv_process_t*, int64_t exit_status, int term_signal);
  289. typedef void (*uv_walk_cb)(uv_handle_t* handle, void* arg);
  290. typedef void (*uv_fs_cb)(uv_fs_t* req);
  291. typedef void (*uv_work_cb)(uv_work_t* req);
  292. typedef void (*uv_after_work_cb)(uv_work_t* req, int status);
  293. typedef void (*uv_getaddrinfo_cb)(uv_getaddrinfo_t* req,
  294. int status,
  295. struct addrinfo* res);
  296. typedef void (*uv_getnameinfo_cb)(uv_getnameinfo_t* req,
  297. int status,
  298. const char* hostname,
  299. const char* service);
  300. typedef struct {
  301. long tv_sec;
  302. long tv_nsec;
  303. } uv_timespec_t;
  304. typedef struct {
  305. uint64_t st_dev;
  306. uint64_t st_mode;
  307. uint64_t st_nlink;
  308. uint64_t st_uid;
  309. uint64_t st_gid;
  310. uint64_t st_rdev;
  311. uint64_t st_ino;
  312. uint64_t st_size;
  313. uint64_t st_blksize;
  314. uint64_t st_blocks;
  315. uint64_t st_flags;
  316. uint64_t st_gen;
  317. uv_timespec_t st_atim;
  318. uv_timespec_t st_mtim;
  319. uv_timespec_t st_ctim;
  320. uv_timespec_t st_birthtim;
  321. } uv_stat_t;
  322. typedef void (*uv_fs_event_cb)(uv_fs_event_t* handle,
  323. const char* filename,
  324. int events,
  325. int status);
  326. typedef void (*uv_fs_poll_cb)(uv_fs_poll_t* handle,
  327. int status,
  328. const uv_stat_t* prev,
  329. const uv_stat_t* curr);
  330. typedef void (*uv_signal_cb)(uv_signal_t* handle, int signum);
  331. typedef enum {
  332. UV_LEAVE_GROUP = 0,
  333. UV_JOIN_GROUP
  334. } uv_membership;
  335. UV_EXTERN int uv_translate_sys_error(int sys_errno);
  336. UV_EXTERN const char* uv_strerror(int err);
  337. UV_EXTERN char* uv_strerror_r(int err, char* buf, size_t buflen);
  338. UV_EXTERN const char* uv_err_name(int err);
  339. UV_EXTERN char* uv_err_name_r(int err, char* buf, size_t buflen);
  340. #define UV_REQ_FIELDS \
  341. /* public */ \
  342. void* data; \
  343. /* read-only */ \
  344. uv_req_type type; \
  345. /* private */ \
  346. void* reserved[6]; \
  347. UV_REQ_PRIVATE_FIELDS \
  348. /* Abstract base class of all requests. */
  349. struct uv_req_s {
  350. UV_REQ_FIELDS
  351. };
  352. /* Platform-specific request types. */
  353. UV_PRIVATE_REQ_TYPES
  354. UV_EXTERN int uv_shutdown(uv_shutdown_t* req,
  355. uv_stream_t* handle,
  356. uv_shutdown_cb cb);
  357. struct uv_shutdown_s {
  358. UV_REQ_FIELDS
  359. uv_stream_t* handle;
  360. uv_shutdown_cb cb;
  361. UV_SHUTDOWN_PRIVATE_FIELDS
  362. };
  363. #define UV_HANDLE_FIELDS \
  364. /* public */ \
  365. void* data; \
  366. /* read-only */ \
  367. uv_loop_t* loop; \
  368. uv_handle_type type; \
  369. /* private */ \
  370. uv_close_cb close_cb; \
  371. void* handle_queue[2]; \
  372. union { \
  373. int fd; \
  374. void* reserved[4]; \
  375. } u; \
  376. UV_HANDLE_PRIVATE_FIELDS \
  377. /* The abstract base class of all handles. */
  378. struct uv_handle_s {
  379. UV_HANDLE_FIELDS
  380. };
  381. UV_EXTERN size_t uv_handle_size(uv_handle_type type);
  382. UV_EXTERN uv_handle_type uv_handle_get_type(const uv_handle_t* handle);
  383. UV_EXTERN const char* uv_handle_type_name(uv_handle_type type);
  384. UV_EXTERN void* uv_handle_get_data(const uv_handle_t* handle);
  385. UV_EXTERN uv_loop_t* uv_handle_get_loop(const uv_handle_t* handle);
  386. UV_EXTERN void uv_handle_set_data(uv_handle_t* handle, void* data);
  387. UV_EXTERN size_t uv_req_size(uv_req_type type);
  388. UV_EXTERN void* uv_req_get_data(const uv_req_t* req);
  389. UV_EXTERN void uv_req_set_data(uv_req_t* req, void* data);
  390. UV_EXTERN uv_req_type uv_req_get_type(const uv_req_t* req);
  391. UV_EXTERN const char* uv_req_type_name(uv_req_type type);
  392. UV_EXTERN int uv_is_active(const uv_handle_t* handle);
  393. UV_EXTERN void uv_walk(uv_loop_t* loop, uv_walk_cb walk_cb, void* arg);
  394. /* Helpers for ad hoc debugging, no API/ABI stability guaranteed. */
  395. UV_EXTERN void uv_print_all_handles(uv_loop_t* loop, FILE* stream);
  396. UV_EXTERN void uv_print_active_handles(uv_loop_t* loop, FILE* stream);
  397. UV_EXTERN void uv_close(uv_handle_t* handle, uv_close_cb close_cb);
  398. UV_EXTERN int uv_send_buffer_size(uv_handle_t* handle, int* value);
  399. UV_EXTERN int uv_recv_buffer_size(uv_handle_t* handle, int* value);
  400. UV_EXTERN int uv_fileno(const uv_handle_t* handle, uv_os_fd_t* fd);
  401. UV_EXTERN uv_buf_t uv_buf_init(char* base, unsigned int len);
  402. #define UV_STREAM_FIELDS \
  403. /* number of bytes queued for writing */ \
  404. size_t write_queue_size; \
  405. uv_alloc_cb alloc_cb; \
  406. uv_read_cb read_cb; \
  407. /* private */ \
  408. UV_STREAM_PRIVATE_FIELDS
  409. /*
  410. * uv_stream_t is a subclass of uv_handle_t.
  411. *
  412. * uv_stream is an abstract class.
  413. *
  414. * uv_stream_t is the parent class of uv_tcp_t, uv_pipe_t and uv_tty_t.
  415. */
  416. struct uv_stream_s {
  417. UV_HANDLE_FIELDS
  418. UV_STREAM_FIELDS
  419. };
  420. UV_EXTERN size_t uv_stream_get_write_queue_size(const uv_stream_t* stream);
  421. UV_EXTERN int uv_listen(uv_stream_t* stream, int backlog, uv_connection_cb cb);
  422. UV_EXTERN int uv_accept(uv_stream_t* server, uv_stream_t* client);
  423. UV_EXTERN int uv_read_start(uv_stream_t*,
  424. uv_alloc_cb alloc_cb,
  425. uv_read_cb read_cb);
  426. UV_EXTERN int uv_read_stop(uv_stream_t*);
  427. UV_EXTERN int uv_write(uv_write_t* req,
  428. uv_stream_t* handle,
  429. const uv_buf_t bufs[],
  430. unsigned int nbufs,
  431. uv_write_cb cb);
  432. UV_EXTERN int uv_write2(uv_write_t* req,
  433. uv_stream_t* handle,
  434. const uv_buf_t bufs[],
  435. unsigned int nbufs,
  436. uv_stream_t* send_handle,
  437. uv_write_cb cb);
  438. UV_EXTERN int uv_try_write(uv_stream_t* handle,
  439. const uv_buf_t bufs[],
  440. unsigned int nbufs);
  441. /* uv_write_t is a subclass of uv_req_t. */
  442. struct uv_write_s {
  443. UV_REQ_FIELDS
  444. uv_write_cb cb;
  445. uv_stream_t* send_handle; /* TODO: make private and unix-only in v2.x. */
  446. uv_stream_t* handle;
  447. UV_WRITE_PRIVATE_FIELDS
  448. };
  449. UV_EXTERN int uv_is_readable(const uv_stream_t* handle);
  450. UV_EXTERN int uv_is_writable(const uv_stream_t* handle);
  451. UV_EXTERN int uv_stream_set_blocking(uv_stream_t* handle, int blocking);
  452. UV_EXTERN int uv_is_closing(const uv_handle_t* handle);
  453. /*
  454. * uv_tcp_t is a subclass of uv_stream_t.
  455. *
  456. * Represents a TCP stream or TCP server.
  457. */
  458. struct uv_tcp_s {
  459. UV_HANDLE_FIELDS
  460. UV_STREAM_FIELDS
  461. UV_TCP_PRIVATE_FIELDS
  462. };
  463. UV_EXTERN int uv_tcp_init(uv_loop_t*, uv_tcp_t* handle);
  464. UV_EXTERN int uv_tcp_init_ex(uv_loop_t*, uv_tcp_t* handle, unsigned int flags);
  465. UV_EXTERN int uv_tcp_open(uv_tcp_t* handle, uv_os_sock_t sock);
  466. UV_EXTERN int uv_tcp_nodelay(uv_tcp_t* handle, int enable);
  467. UV_EXTERN int uv_tcp_keepalive(uv_tcp_t* handle,
  468. int enable,
  469. unsigned int delay);
  470. UV_EXTERN int uv_tcp_simultaneous_accepts(uv_tcp_t* handle, int enable);
  471. enum uv_tcp_flags {
  472. /* Used with uv_tcp_bind, when an IPv6 address is used. */
  473. UV_TCP_IPV6ONLY = 1
  474. };
  475. UV_EXTERN int uv_tcp_bind(uv_tcp_t* handle,
  476. const struct sockaddr* addr,
  477. unsigned int flags);
  478. UV_EXTERN int uv_tcp_getsockname(const uv_tcp_t* handle,
  479. struct sockaddr* name,
  480. int* namelen);
  481. UV_EXTERN int uv_tcp_getpeername(const uv_tcp_t* handle,
  482. struct sockaddr* name,
  483. int* namelen);
  484. UV_EXTERN int uv_tcp_connect(uv_connect_t* req,
  485. uv_tcp_t* handle,
  486. const struct sockaddr* addr,
  487. uv_connect_cb cb);
  488. /* uv_connect_t is a subclass of uv_req_t. */
  489. struct uv_connect_s {
  490. UV_REQ_FIELDS
  491. uv_connect_cb cb;
  492. uv_stream_t* handle;
  493. UV_CONNECT_PRIVATE_FIELDS
  494. };
  495. /*
  496. * UDP support.
  497. */
  498. enum uv_udp_flags {
  499. /* Disables dual stack mode. */
  500. UV_UDP_IPV6ONLY = 1,
  501. /*
  502. * Indicates message was truncated because read buffer was too small. The
  503. * remainder was discarded by the OS. Used in uv_udp_recv_cb.
  504. */
  505. UV_UDP_PARTIAL = 2,
  506. /*
  507. * Indicates if SO_REUSEADDR will be set when binding the handle.
  508. * This sets the SO_REUSEPORT socket flag on the BSDs and OS X. On other
  509. * Unix platforms, it sets the SO_REUSEADDR flag. What that means is that
  510. * multiple threads or processes can bind to the same address without error
  511. * (provided they all set the flag) but only the last one to bind will receive
  512. * any traffic, in effect "stealing" the port from the previous listener.
  513. */
  514. UV_UDP_REUSEADDR = 4
  515. };
  516. typedef void (*uv_udp_send_cb)(uv_udp_send_t* req, int status);
  517. typedef void (*uv_udp_recv_cb)(uv_udp_t* handle,
  518. ssize_t nread,
  519. const uv_buf_t* buf,
  520. const struct sockaddr* addr,
  521. unsigned flags);
  522. /* uv_udp_t is a subclass of uv_handle_t. */
  523. struct uv_udp_s {
  524. UV_HANDLE_FIELDS
  525. /* read-only */
  526. /*
  527. * Number of bytes queued for sending. This field strictly shows how much
  528. * information is currently queued.
  529. */
  530. size_t send_queue_size;
  531. /*
  532. * Number of send requests currently in the queue awaiting to be processed.
  533. */
  534. size_t send_queue_count;
  535. UV_UDP_PRIVATE_FIELDS
  536. };
  537. /* uv_udp_send_t is a subclass of uv_req_t. */
  538. struct uv_udp_send_s {
  539. UV_REQ_FIELDS
  540. uv_udp_t* handle;
  541. uv_udp_send_cb cb;
  542. UV_UDP_SEND_PRIVATE_FIELDS
  543. };
  544. UV_EXTERN int uv_udp_init(uv_loop_t*, uv_udp_t* handle);
  545. UV_EXTERN int uv_udp_init_ex(uv_loop_t*, uv_udp_t* handle, unsigned int flags);
  546. UV_EXTERN int uv_udp_open(uv_udp_t* handle, uv_os_sock_t sock);
  547. UV_EXTERN int uv_udp_bind(uv_udp_t* handle,
  548. const struct sockaddr* addr,
  549. unsigned int flags);
  550. UV_EXTERN int uv_udp_connect(uv_udp_t* handle, const struct sockaddr* addr);
  551. UV_EXTERN int uv_udp_getpeername(const uv_udp_t* handle,
  552. struct sockaddr* name,
  553. int* namelen);
  554. UV_EXTERN int uv_udp_getsockname(const uv_udp_t* handle,
  555. struct sockaddr* name,
  556. int* namelen);
  557. UV_EXTERN int uv_udp_set_membership(uv_udp_t* handle,
  558. const char* multicast_addr,
  559. const char* interface_addr,
  560. uv_membership membership);
  561. UV_EXTERN int uv_udp_set_multicast_loop(uv_udp_t* handle, int on);
  562. UV_EXTERN int uv_udp_set_multicast_ttl(uv_udp_t* handle, int ttl);
  563. UV_EXTERN int uv_udp_set_multicast_interface(uv_udp_t* handle,
  564. const char* interface_addr);
  565. UV_EXTERN int uv_udp_set_broadcast(uv_udp_t* handle, int on);
  566. UV_EXTERN int uv_udp_set_ttl(uv_udp_t* handle, int ttl);
  567. UV_EXTERN int uv_udp_send(uv_udp_send_t* req,
  568. uv_udp_t* handle,
  569. const uv_buf_t bufs[],
  570. unsigned int nbufs,
  571. const struct sockaddr* addr,
  572. uv_udp_send_cb send_cb);
  573. UV_EXTERN int uv_udp_try_send(uv_udp_t* handle,
  574. const uv_buf_t bufs[],
  575. unsigned int nbufs,
  576. const struct sockaddr* addr);
  577. UV_EXTERN int uv_udp_recv_start(uv_udp_t* handle,
  578. uv_alloc_cb alloc_cb,
  579. uv_udp_recv_cb recv_cb);
  580. UV_EXTERN int uv_udp_recv_stop(uv_udp_t* handle);
  581. UV_EXTERN size_t uv_udp_get_send_queue_size(const uv_udp_t* handle);
  582. UV_EXTERN size_t uv_udp_get_send_queue_count(const uv_udp_t* handle);
  583. /*
  584. * uv_tty_t is a subclass of uv_stream_t.
  585. *
  586. * Representing a stream for the console.
  587. */
  588. struct uv_tty_s {
  589. UV_HANDLE_FIELDS
  590. UV_STREAM_FIELDS
  591. UV_TTY_PRIVATE_FIELDS
  592. };
  593. typedef enum {
  594. /* Initial/normal terminal mode */
  595. UV_TTY_MODE_NORMAL,
  596. /* Raw input mode (On Windows, ENABLE_WINDOW_INPUT is also enabled) */
  597. UV_TTY_MODE_RAW,
  598. /* Binary-safe I/O mode for IPC (Unix-only) */
  599. UV_TTY_MODE_IO
  600. } uv_tty_mode_t;
  601. UV_EXTERN int uv_tty_init(uv_loop_t*, uv_tty_t*, uv_file fd, int readable);
  602. UV_EXTERN int uv_tty_set_mode(uv_tty_t*, uv_tty_mode_t mode);
  603. UV_EXTERN int uv_tty_reset_mode(void);
  604. UV_EXTERN int uv_tty_get_winsize(uv_tty_t*, int* width, int* height);
  605. #ifdef __cplusplus
  606. extern "C++" {
  607. inline int uv_tty_set_mode(uv_tty_t* handle, int mode) {
  608. return uv_tty_set_mode(handle, static_cast<uv_tty_mode_t>(mode));
  609. }
  610. }
  611. #endif
  612. UV_EXTERN uv_handle_type uv_guess_handle(uv_file file);
  613. /*
  614. * uv_pipe_t is a subclass of uv_stream_t.
  615. *
  616. * Representing a pipe stream or pipe server. On Windows this is a Named
  617. * Pipe. On Unix this is a Unix domain socket.
  618. */
  619. struct uv_pipe_s {
  620. UV_HANDLE_FIELDS
  621. UV_STREAM_FIELDS
  622. int ipc; /* non-zero if this pipe is used for passing handles */
  623. UV_PIPE_PRIVATE_FIELDS
  624. };
  625. UV_EXTERN int uv_pipe_init(uv_loop_t*, uv_pipe_t* handle, int ipc);
  626. UV_EXTERN int uv_pipe_open(uv_pipe_t*, uv_file file);
  627. UV_EXTERN int uv_pipe_bind(uv_pipe_t* handle, const char* name);
  628. UV_EXTERN void uv_pipe_connect(uv_connect_t* req,
  629. uv_pipe_t* handle,
  630. const char* name,
  631. uv_connect_cb cb);
  632. UV_EXTERN int uv_pipe_getsockname(const uv_pipe_t* handle,
  633. char* buffer,
  634. size_t* size);
  635. UV_EXTERN int uv_pipe_getpeername(const uv_pipe_t* handle,
  636. char* buffer,
  637. size_t* size);
  638. UV_EXTERN void uv_pipe_pending_instances(uv_pipe_t* handle, int count);
  639. UV_EXTERN int uv_pipe_pending_count(uv_pipe_t* handle);
  640. UV_EXTERN uv_handle_type uv_pipe_pending_type(uv_pipe_t* handle);
  641. UV_EXTERN int uv_pipe_chmod(uv_pipe_t* handle, int flags);
  642. struct uv_poll_s {
  643. UV_HANDLE_FIELDS
  644. uv_poll_cb poll_cb;
  645. UV_POLL_PRIVATE_FIELDS
  646. };
  647. enum uv_poll_event {
  648. UV_READABLE = 1,
  649. UV_WRITABLE = 2,
  650. UV_DISCONNECT = 4,
  651. UV_PRIORITIZED = 8
  652. };
  653. UV_EXTERN int uv_poll_init(uv_loop_t* loop, uv_poll_t* handle, int fd);
  654. UV_EXTERN int uv_poll_init_socket(uv_loop_t* loop,
  655. uv_poll_t* handle,
  656. uv_os_sock_t socket);
  657. UV_EXTERN int uv_poll_start(uv_poll_t* handle, int events, uv_poll_cb cb);
  658. UV_EXTERN int uv_poll_stop(uv_poll_t* handle);
  659. struct uv_prepare_s {
  660. UV_HANDLE_FIELDS
  661. UV_PREPARE_PRIVATE_FIELDS
  662. };
  663. UV_EXTERN int uv_prepare_init(uv_loop_t*, uv_prepare_t* prepare);
  664. UV_EXTERN int uv_prepare_start(uv_prepare_t* prepare, uv_prepare_cb cb);
  665. UV_EXTERN int uv_prepare_stop(uv_prepare_t* prepare);
  666. struct uv_check_s {
  667. UV_HANDLE_FIELDS
  668. UV_CHECK_PRIVATE_FIELDS
  669. };
  670. UV_EXTERN int uv_check_init(uv_loop_t*, uv_check_t* check);
  671. UV_EXTERN int uv_check_start(uv_check_t* check, uv_check_cb cb);
  672. UV_EXTERN int uv_check_stop(uv_check_t* check);
  673. struct uv_idle_s {
  674. UV_HANDLE_FIELDS
  675. UV_IDLE_PRIVATE_FIELDS
  676. };
  677. UV_EXTERN int uv_idle_init(uv_loop_t*, uv_idle_t* idle);
  678. UV_EXTERN int uv_idle_start(uv_idle_t* idle, uv_idle_cb cb);
  679. UV_EXTERN int uv_idle_stop(uv_idle_t* idle);
  680. struct uv_async_s {
  681. UV_HANDLE_FIELDS
  682. UV_ASYNC_PRIVATE_FIELDS
  683. };
  684. UV_EXTERN int uv_async_init(uv_loop_t*,
  685. uv_async_t* async,
  686. uv_async_cb async_cb);
  687. UV_EXTERN int uv_async_send(uv_async_t* async);
  688. /*
  689. * uv_timer_t is a subclass of uv_handle_t.
  690. *
  691. * Used to get woken up at a specified time in the future.
  692. */
  693. struct uv_timer_s {
  694. UV_HANDLE_FIELDS
  695. UV_TIMER_PRIVATE_FIELDS
  696. };
  697. UV_EXTERN int uv_timer_init(uv_loop_t*, uv_timer_t* handle);
  698. UV_EXTERN int uv_timer_start(uv_timer_t* handle,
  699. uv_timer_cb cb,
  700. uint64_t timeout,
  701. uint64_t repeat);
  702. UV_EXTERN int uv_timer_stop(uv_timer_t* handle);
  703. UV_EXTERN int uv_timer_again(uv_timer_t* handle);
  704. UV_EXTERN void uv_timer_set_repeat(uv_timer_t* handle, uint64_t repeat);
  705. UV_EXTERN uint64_t uv_timer_get_repeat(const uv_timer_t* handle);
  706. /*
  707. * uv_getaddrinfo_t is a subclass of uv_req_t.
  708. *
  709. * Request object for uv_getaddrinfo.
  710. */
  711. struct uv_getaddrinfo_s {
  712. UV_REQ_FIELDS
  713. /* read-only */
  714. uv_loop_t* loop;
  715. /* struct addrinfo* addrinfo is marked as private, but it really isn't. */
  716. UV_GETADDRINFO_PRIVATE_FIELDS
  717. };
  718. UV_EXTERN int uv_getaddrinfo(uv_loop_t* loop,
  719. uv_getaddrinfo_t* req,
  720. uv_getaddrinfo_cb getaddrinfo_cb,
  721. const char* node,
  722. const char* service,
  723. const struct addrinfo* hints);
  724. UV_EXTERN void uv_freeaddrinfo(struct addrinfo* ai);
  725. /*
  726. * uv_getnameinfo_t is a subclass of uv_req_t.
  727. *
  728. * Request object for uv_getnameinfo.
  729. */
  730. struct uv_getnameinfo_s {
  731. UV_REQ_FIELDS
  732. /* read-only */
  733. uv_loop_t* loop;
  734. /* host and service are marked as private, but they really aren't. */
  735. UV_GETNAMEINFO_PRIVATE_FIELDS
  736. };
  737. UV_EXTERN int uv_getnameinfo(uv_loop_t* loop,
  738. uv_getnameinfo_t* req,
  739. uv_getnameinfo_cb getnameinfo_cb,
  740. const struct sockaddr* addr,
  741. int flags);
  742. /* uv_spawn() options. */
  743. typedef enum {
  744. UV_IGNORE = 0x00,
  745. UV_CREATE_PIPE = 0x01,
  746. UV_INHERIT_FD = 0x02,
  747. UV_INHERIT_STREAM = 0x04,
  748. /*
  749. * When UV_CREATE_PIPE is specified, UV_READABLE_PIPE and UV_WRITABLE_PIPE
  750. * determine the direction of flow, from the child process' perspective. Both
  751. * flags may be specified to create a duplex data stream.
  752. */
  753. UV_READABLE_PIPE = 0x10,
  754. UV_WRITABLE_PIPE = 0x20,
  755. /*
  756. * Open the child pipe handle in overlapped mode on Windows.
  757. * On Unix it is silently ignored.
  758. */
  759. UV_OVERLAPPED_PIPE = 0x40
  760. } uv_stdio_flags;
  761. typedef struct uv_stdio_container_s {
  762. uv_stdio_flags flags;
  763. union {
  764. uv_stream_t* stream;
  765. int fd;
  766. } data;
  767. } uv_stdio_container_t;
  768. typedef struct uv_process_options_s {
  769. uv_exit_cb exit_cb; /* Called after the process exits. */
  770. const char* file; /* Path to program to execute. */
  771. /*
  772. * Command line arguments. args[0] should be the path to the program. On
  773. * Windows this uses CreateProcess which concatenates the arguments into a
  774. * string this can cause some strange errors. See the note at
  775. * windows_verbatim_arguments.
  776. */
  777. char** args;
  778. /*
  779. * This will be set as the environ variable in the subprocess. If this is
  780. * NULL then the parents environ will be used.
  781. */
  782. char** env;
  783. /*
  784. * If non-null this represents a directory the subprocess should execute
  785. * in. Stands for current working directory.
  786. */
  787. const char* cwd;
  788. /*
  789. * Various flags that control how uv_spawn() behaves. See the definition of
  790. * `enum uv_process_flags` below.
  791. */
  792. unsigned int flags;
  793. /*
  794. * The `stdio` field points to an array of uv_stdio_container_t structs that
  795. * describe the file descriptors that will be made available to the child
  796. * process. The convention is that stdio[0] points to stdin, fd 1 is used for
  797. * stdout, and fd 2 is stderr.
  798. *
  799. * Note that on windows file descriptors greater than 2 are available to the
  800. * child process only if the child processes uses the MSVCRT runtime.
  801. */
  802. int stdio_count;
  803. uv_stdio_container_t* stdio;
  804. /*
  805. * Libuv can change the child process' user/group id. This happens only when
  806. * the appropriate bits are set in the flags fields. This is not supported on
  807. * windows; uv_spawn() will fail and set the error to UV_ENOTSUP.
  808. */
  809. uv_uid_t uid;
  810. uv_gid_t gid;
  811. /*
  812. Libuv can set the child process' CPU affinity mask. This happens when
  813. `cpumask` is non-NULL. It must point to an array of char values
  814. of length `cpumask_size`, whose value must be at least that returned by
  815. uv_cpumask_size(). Each byte in the mask can be either zero (false)
  816. or non-zero (true) to indicate whether the corresponding processor at
  817. that index is included.
  818. If enabled on an unsupported platform, uv_spawn() will fail with
  819. UV_ENOTSUP.
  820. */
  821. char* cpumask;
  822. size_t cpumask_size;
  823. } uv_process_options_t;
  824. /*
  825. * These are the flags that can be used for the uv_process_options.flags field.
  826. */
  827. enum uv_process_flags {
  828. /*
  829. * Set the child process' user id. The user id is supplied in the `uid` field
  830. * of the options struct. This does not work on windows; setting this flag
  831. * will cause uv_spawn() to fail.
  832. */
  833. UV_PROCESS_SETUID = (1 << 0),
  834. /*
  835. * Set the child process' group id. The user id is supplied in the `gid`
  836. * field of the options struct. This does not work on windows; setting this
  837. * flag will cause uv_spawn() to fail.
  838. */
  839. UV_PROCESS_SETGID = (1 << 1),
  840. /*
  841. * Do not wrap any arguments in quotes, or perform any other escaping, when
  842. * converting the argument list into a command line string. This option is
  843. * only meaningful on Windows systems. On Unix it is silently ignored.
  844. */
  845. UV_PROCESS_WINDOWS_VERBATIM_ARGUMENTS = (1 << 2),
  846. /*
  847. * Spawn the child process in a detached state - this will make it a process
  848. * group leader, and will effectively enable the child to keep running after
  849. * the parent exits. Note that the child process will still keep the
  850. * parent's event loop alive unless the parent process calls uv_unref() on
  851. * the child's process handle.
  852. */
  853. UV_PROCESS_DETACHED = (1 << 3),
  854. /*
  855. * Hide the subprocess window that would normally be created. This option is
  856. * only meaningful on Windows systems. On Unix it is silently ignored.
  857. */
  858. UV_PROCESS_WINDOWS_HIDE = (1 << 4),
  859. /*
  860. * Hide the subprocess console window that would normally be created. This
  861. * option is only meaningful on Windows systems. On Unix it is silently
  862. * ignored.
  863. */
  864. UV_PROCESS_WINDOWS_HIDE_CONSOLE = (1 << 5),
  865. /*
  866. * Hide the subprocess GUI window that would normally be created. This
  867. * option is only meaningful on Windows systems. On Unix it is silently
  868. * ignored.
  869. */
  870. UV_PROCESS_WINDOWS_HIDE_GUI = (1 << 6)
  871. };
  872. /*
  873. * uv_process_t is a subclass of uv_handle_t.
  874. */
  875. struct uv_process_s {
  876. UV_HANDLE_FIELDS
  877. uv_exit_cb exit_cb;
  878. int pid;
  879. UV_PROCESS_PRIVATE_FIELDS
  880. };
  881. UV_EXTERN int uv_spawn(uv_loop_t* loop,
  882. uv_process_t* handle,
  883. const uv_process_options_t* options);
  884. UV_EXTERN int uv_process_kill(uv_process_t*, int signum);
  885. UV_EXTERN int uv_kill(int pid, int signum);
  886. UV_EXTERN uv_pid_t uv_process_get_pid(const uv_process_t*);
  887. /*
  888. * uv_work_t is a subclass of uv_req_t.
  889. */
  890. struct uv_work_s {
  891. UV_REQ_FIELDS
  892. uv_loop_t* loop;
  893. uv_work_cb work_cb;
  894. uv_after_work_cb after_work_cb;
  895. UV_WORK_PRIVATE_FIELDS
  896. };
  897. UV_EXTERN int uv_queue_work(uv_loop_t* loop,
  898. uv_work_t* req,
  899. uv_work_cb work_cb,
  900. uv_after_work_cb after_work_cb);
  901. UV_EXTERN int uv_cancel(uv_req_t* req);
  902. struct uv_cpu_times_s {
  903. uint64_t user;
  904. uint64_t nice;
  905. uint64_t sys;
  906. uint64_t idle;
  907. uint64_t irq;
  908. };
  909. struct uv_cpu_info_s {
  910. char* model;
  911. int speed;
  912. struct uv_cpu_times_s cpu_times;
  913. };
  914. struct uv_interface_address_s {
  915. char* name;
  916. char phys_addr[6];
  917. int is_internal;
  918. union {
  919. struct sockaddr_in address4;
  920. struct sockaddr_in6 address6;
  921. } address;
  922. union {
  923. struct sockaddr_in netmask4;
  924. struct sockaddr_in6 netmask6;
  925. } netmask;
  926. };
  927. struct uv_passwd_s {
  928. char* username;
  929. long uid;
  930. long gid;
  931. char* shell;
  932. char* homedir;
  933. };
  934. struct uv_utsname_s {
  935. char sysname[256];
  936. char release[256];
  937. char version[256];
  938. char machine[256];
  939. /* This struct does not contain the nodename and domainname fields present in
  940. the utsname type. domainname is a GNU extension. Both fields are referred
  941. to as meaningless in the docs. */
  942. };
  943. typedef enum {
  944. UV_DIRENT_UNKNOWN,
  945. UV_DIRENT_FILE,
  946. UV_DIRENT_DIR,
  947. UV_DIRENT_LINK,
  948. UV_DIRENT_FIFO,
  949. UV_DIRENT_SOCKET,
  950. UV_DIRENT_CHAR,
  951. UV_DIRENT_BLOCK
  952. } uv_dirent_type_t;
  953. struct uv_dirent_s {
  954. const char* name;
  955. uv_dirent_type_t type;
  956. };
  957. UV_EXTERN char** uv_setup_args(int argc, char** argv);
  958. UV_EXTERN int uv_get_process_title(char* buffer, size_t size);
  959. UV_EXTERN int uv_set_process_title(const char* title);
  960. UV_EXTERN int uv_resident_set_memory(size_t* rss);
  961. UV_EXTERN int uv_uptime(double* uptime);
  962. UV_EXTERN uv_os_fd_t uv_get_osfhandle(int fd);
  963. UV_EXTERN int uv_open_osfhandle(uv_os_fd_t os_fd);
  964. typedef struct {
  965. long tv_sec;
  966. long tv_usec;
  967. } uv_timeval_t;
  968. typedef struct {
  969. int64_t tv_sec;
  970. int32_t tv_usec;
  971. } uv_timeval64_t;
  972. typedef struct {
  973. uv_timeval_t ru_utime; /* user CPU time used */
  974. uv_timeval_t ru_stime; /* system CPU time used */
  975. uint64_t ru_maxrss; /* maximum resident set size */
  976. uint64_t ru_ixrss; /* integral shared memory size */
  977. uint64_t ru_idrss; /* integral unshared data size */
  978. uint64_t ru_isrss; /* integral unshared stack size */
  979. uint64_t ru_minflt; /* page reclaims (soft page faults) */
  980. uint64_t ru_majflt; /* page faults (hard page faults) */
  981. uint64_t ru_nswap; /* swaps */
  982. uint64_t ru_inblock; /* block input operations */
  983. uint64_t ru_oublock; /* block output operations */
  984. uint64_t ru_msgsnd; /* IPC messages sent */
  985. uint64_t ru_msgrcv; /* IPC messages received */
  986. uint64_t ru_nsignals; /* signals received */
  987. uint64_t ru_nvcsw; /* voluntary context switches */
  988. uint64_t ru_nivcsw; /* involuntary context switches */
  989. } uv_rusage_t;
  990. UV_EXTERN int uv_getrusage(uv_rusage_t* rusage);
  991. UV_EXTERN int uv_os_homedir(char* buffer, size_t* size);
  992. UV_EXTERN int uv_os_tmpdir(char* buffer, size_t* size);
  993. UV_EXTERN int uv_os_get_passwd(uv_passwd_t* pwd);
  994. UV_EXTERN void uv_os_free_passwd(uv_passwd_t* pwd);
  995. UV_EXTERN uv_pid_t uv_os_getpid(void);
  996. UV_EXTERN uv_pid_t uv_os_getppid(void);
  997. #define UV_PRIORITY_LOW 19
  998. #define UV_PRIORITY_BELOW_NORMAL 10
  999. #define UV_PRIORITY_NORMAL 0
  1000. #define UV_PRIORITY_ABOVE_NORMAL -7
  1001. #define UV_PRIORITY_HIGH -14
  1002. #define UV_PRIORITY_HIGHEST -20
  1003. UV_EXTERN int uv_os_getpriority(uv_pid_t pid, int* priority);
  1004. UV_EXTERN int uv_os_setpriority(uv_pid_t pid, int priority);
  1005. UV_EXTERN int uv_cpu_info(uv_cpu_info_t** cpu_infos, int* count);
  1006. UV_EXTERN void uv_free_cpu_info(uv_cpu_info_t* cpu_infos, int count);
  1007. UV_EXTERN int uv_cpumask_size(void);
  1008. UV_EXTERN int uv_interface_addresses(uv_interface_address_t** addresses,
  1009. int* count);
  1010. UV_EXTERN void uv_free_interface_addresses(uv_interface_address_t* addresses,
  1011. int count);
  1012. UV_EXTERN int uv_os_getenv(const char* name, char* buffer, size_t* size);
  1013. UV_EXTERN int uv_os_setenv(const char* name, const char* value);
  1014. UV_EXTERN int uv_os_unsetenv(const char* name);
  1015. #ifdef MAXHOSTNAMELEN
  1016. # define UV_MAXHOSTNAMESIZE (MAXHOSTNAMELEN + 1)
  1017. #else
  1018. /*
  1019. Fallback for the maximum hostname size, including the null terminator. The
  1020. Windows gethostname() documentation states that 256 bytes will always be
  1021. large enough to hold the null-terminated hostname.
  1022. */
  1023. # define UV_MAXHOSTNAMESIZE 256
  1024. #endif
  1025. UV_EXTERN int uv_os_gethostname(char* buffer, size_t* size);
  1026. UV_EXTERN int uv_os_uname(uv_utsname_t* buffer);
  1027. typedef enum {
  1028. UV_FS_UNKNOWN = -1,
  1029. UV_FS_CUSTOM,
  1030. UV_FS_OPEN,
  1031. UV_FS_CLOSE,
  1032. UV_FS_READ,
  1033. UV_FS_WRITE,
  1034. UV_FS_SENDFILE,
  1035. UV_FS_STAT,
  1036. UV_FS_LSTAT,
  1037. UV_FS_FSTAT,
  1038. UV_FS_FTRUNCATE,
  1039. UV_FS_UTIME,
  1040. UV_FS_FUTIME,
  1041. UV_FS_ACCESS,
  1042. UV_FS_CHMOD,
  1043. UV_FS_FCHMOD,
  1044. UV_FS_FSYNC,
  1045. UV_FS_FDATASYNC,
  1046. UV_FS_UNLINK,
  1047. UV_FS_RMDIR,
  1048. UV_FS_MKDIR,
  1049. UV_FS_MKDTEMP,
  1050. UV_FS_RENAME,
  1051. UV_FS_SCANDIR,
  1052. UV_FS_LINK,
  1053. UV_FS_SYMLINK,
  1054. UV_FS_READLINK,
  1055. UV_FS_CHOWN,
  1056. UV_FS_FCHOWN,
  1057. UV_FS_REALPATH,
  1058. UV_FS_COPYFILE,
  1059. UV_FS_LCHOWN,
  1060. UV_FS_OPENDIR,
  1061. UV_FS_READDIR,
  1062. UV_FS_CLOSEDIR
  1063. } uv_fs_type;
  1064. struct uv_dir_s {
  1065. uv_dirent_t* dirents;
  1066. size_t nentries;
  1067. void* reserved[4];
  1068. UV_DIR_PRIVATE_FIELDS
  1069. };
  1070. /* uv_fs_t is a subclass of uv_req_t. */
  1071. struct uv_fs_s {
  1072. UV_REQ_FIELDS
  1073. uv_fs_type fs_type;
  1074. uv_loop_t* loop;
  1075. uv_fs_cb cb;
  1076. ssize_t result;
  1077. void* ptr;
  1078. const char* path;
  1079. uv_stat_t statbuf; /* Stores the result of uv_fs_stat() and uv_fs_fstat(). */
  1080. UV_FS_PRIVATE_FIELDS
  1081. };
  1082. UV_EXTERN uv_fs_type uv_fs_get_type(const uv_fs_t*);
  1083. UV_EXTERN ssize_t uv_fs_get_result(const uv_fs_t*);
  1084. UV_EXTERN void* uv_fs_get_ptr(const uv_fs_t*);
  1085. UV_EXTERN const char* uv_fs_get_path(const uv_fs_t*);
  1086. UV_EXTERN uv_stat_t* uv_fs_get_statbuf(uv_fs_t*);
  1087. UV_EXTERN void uv_fs_req_cleanup(uv_fs_t* req);
  1088. UV_EXTERN int uv_fs_close(uv_loop_t* loop,
  1089. uv_fs_t* req,
  1090. uv_file file,
  1091. uv_fs_cb cb);
  1092. UV_EXTERN int uv_fs_open(uv_loop_t* loop,
  1093. uv_fs_t* req,
  1094. const char* path,
  1095. int flags,
  1096. int mode,
  1097. uv_fs_cb cb);
  1098. UV_EXTERN int uv_fs_read(uv_loop_t* loop,
  1099. uv_fs_t* req,
  1100. uv_file file,
  1101. const uv_buf_t bufs[],
  1102. unsigned int nbufs,
  1103. int64_t offset,
  1104. uv_fs_cb cb);
  1105. UV_EXTERN int uv_fs_unlink(uv_loop_t* loop,
  1106. uv_fs_t* req,
  1107. const char* path,
  1108. uv_fs_cb cb);
  1109. UV_EXTERN int uv_fs_write(uv_loop_t* loop,
  1110. uv_fs_t* req,
  1111. uv_file file,
  1112. const uv_buf_t bufs[],
  1113. unsigned int nbufs,
  1114. int64_t offset,
  1115. uv_fs_cb cb);
  1116. /*
  1117. * This flag can be used with uv_fs_copyfile() to return an error if the
  1118. * destination already exists.
  1119. */
  1120. #define UV_FS_COPYFILE_EXCL 0x0001
  1121. /*
  1122. * This flag can be used with uv_fs_copyfile() to attempt to create a reflink.
  1123. * If copy-on-write is not supported, a fallback copy mechanism is used.
  1124. */
  1125. #define UV_FS_COPYFILE_FICLONE 0x0002
  1126. /*
  1127. * This flag can be used with uv_fs_copyfile() to attempt to create a reflink.
  1128. * If copy-on-write is not supported, an error is returned.
  1129. */
  1130. #define UV_FS_COPYFILE_FICLONE_FORCE 0x0004
  1131. UV_EXTERN int uv_fs_copyfile(uv_loop_t* loop,
  1132. uv_fs_t* req,
  1133. const char* path,
  1134. const char* new_path,
  1135. int flags,
  1136. uv_fs_cb cb);
  1137. UV_EXTERN int uv_fs_mkdir(uv_loop_t* loop,
  1138. uv_fs_t* req,
  1139. const char* path,
  1140. int mode,
  1141. uv_fs_cb cb);
  1142. UV_EXTERN int uv_fs_mkdtemp(uv_loop_t* loop,
  1143. uv_fs_t* req,
  1144. const char* tpl,
  1145. uv_fs_cb cb);
  1146. UV_EXTERN int uv_fs_rmdir(uv_loop_t* loop,
  1147. uv_fs_t* req,
  1148. const char* path,
  1149. uv_fs_cb cb);
  1150. UV_EXTERN int uv_fs_scandir(uv_loop_t* loop,
  1151. uv_fs_t* req,
  1152. const char* path,
  1153. int flags,
  1154. uv_fs_cb cb);
  1155. UV_EXTERN int uv_fs_scandir_next(uv_fs_t* req,
  1156. uv_dirent_t* ent);
  1157. UV_EXTERN int uv_fs_opendir(uv_loop_t* loop,
  1158. uv_fs_t* req,
  1159. const char* path,
  1160. uv_fs_cb cb);
  1161. UV_EXTERN int uv_fs_readdir(uv_loop_t* loop,
  1162. uv_fs_t* req,
  1163. uv_dir_t* dir,
  1164. uv_fs_cb cb);
  1165. UV_EXTERN int uv_fs_closedir(uv_loop_t* loop,
  1166. uv_fs_t* req,
  1167. uv_dir_t* dir,
  1168. uv_fs_cb cb);
  1169. UV_EXTERN int uv_fs_stat(uv_loop_t* loop,
  1170. uv_fs_t* req,
  1171. const char* path,
  1172. uv_fs_cb cb);
  1173. UV_EXTERN int uv_fs_fstat(uv_loop_t* loop,
  1174. uv_fs_t* req,
  1175. uv_file file,
  1176. uv_fs_cb cb);
  1177. UV_EXTERN int uv_fs_rename(uv_loop_t* loop,
  1178. uv_fs_t* req,
  1179. const char* path,
  1180. const char* new_path,
  1181. uv_fs_cb cb);
  1182. UV_EXTERN int uv_fs_fsync(uv_loop_t* loop,
  1183. uv_fs_t* req,
  1184. uv_file file,
  1185. uv_fs_cb cb);
  1186. UV_EXTERN int uv_fs_fdatasync(uv_loop_t* loop,
  1187. uv_fs_t* req,
  1188. uv_file file,
  1189. uv_fs_cb cb);
  1190. UV_EXTERN int uv_fs_ftruncate(uv_loop_t* loop,
  1191. uv_fs_t* req,
  1192. uv_file file,
  1193. int64_t offset,
  1194. uv_fs_cb cb);
  1195. UV_EXTERN int uv_fs_sendfile(uv_loop_t* loop,
  1196. uv_fs_t* req,
  1197. uv_file out_fd,
  1198. uv_file in_fd,
  1199. int64_t in_offset,
  1200. size_t length,
  1201. uv_fs_cb cb);
  1202. UV_EXTERN int uv_fs_access(uv_loop_t* loop,
  1203. uv_fs_t* req,
  1204. const char* path,
  1205. int mode,
  1206. uv_fs_cb cb);
  1207. UV_EXTERN int uv_fs_chmod(uv_loop_t* loop,
  1208. uv_fs_t* req,
  1209. const char* path,
  1210. int mode,
  1211. uv_fs_cb cb);
  1212. UV_EXTERN int uv_fs_utime(uv_loop_t* loop,
  1213. uv_fs_t* req,
  1214. const char* path,
  1215. double atime,
  1216. double mtime,
  1217. uv_fs_cb cb);
  1218. UV_EXTERN int uv_fs_futime(uv_loop_t* loop,
  1219. uv_fs_t* req,
  1220. uv_file file,
  1221. double atime,
  1222. double mtime,
  1223. uv_fs_cb cb);
  1224. UV_EXTERN int uv_fs_lstat(uv_loop_t* loop,
  1225. uv_fs_t* req,
  1226. const char* path,
  1227. uv_fs_cb cb);
  1228. UV_EXTERN int uv_fs_link(uv_loop_t* loop,
  1229. uv_fs_t* req,
  1230. const char* path,
  1231. const char* new_path,
  1232. uv_fs_cb cb);
  1233. /*
  1234. * This flag can be used with uv_fs_symlink() on Windows to specify whether
  1235. * path argument points to a directory.
  1236. */
  1237. #define UV_FS_SYMLINK_DIR 0x0001
  1238. /*
  1239. * This flag can be used with uv_fs_symlink() on Windows to specify whether
  1240. * the symlink is to be created using junction points.
  1241. */
  1242. #define UV_FS_SYMLINK_JUNCTION 0x0002
  1243. UV_EXTERN int uv_fs_symlink(uv_loop_t* loop,
  1244. uv_fs_t* req,
  1245. const char* path,
  1246. const char* new_path,
  1247. int flags,
  1248. uv_fs_cb cb);
  1249. UV_EXTERN int uv_fs_readlink(uv_loop_t* loop,
  1250. uv_fs_t* req,
  1251. const char* path,
  1252. uv_fs_cb cb);
  1253. UV_EXTERN int uv_fs_realpath(uv_loop_t* loop,
  1254. uv_fs_t* req,
  1255. const char* path,
  1256. uv_fs_cb cb);
  1257. UV_EXTERN int uv_fs_fchmod(uv_loop_t* loop,
  1258. uv_fs_t* req,
  1259. uv_file file,
  1260. int mode,
  1261. uv_fs_cb cb);
  1262. UV_EXTERN int uv_fs_chown(uv_loop_t* loop,
  1263. uv_fs_t* req,
  1264. const char* path,
  1265. uv_uid_t uid,
  1266. uv_gid_t gid,
  1267. uv_fs_cb cb);
  1268. UV_EXTERN int uv_fs_fchown(uv_loop_t* loop,
  1269. uv_fs_t* req,
  1270. uv_file file,
  1271. uv_uid_t uid,
  1272. uv_gid_t gid,
  1273. uv_fs_cb cb);
  1274. UV_EXTERN int uv_fs_lchown(uv_loop_t* loop,
  1275. uv_fs_t* req,
  1276. const char* path,
  1277. uv_uid_t uid,
  1278. uv_gid_t gid,
  1279. uv_fs_cb cb);
  1280. enum uv_fs_event {
  1281. UV_RENAME = 1,
  1282. UV_CHANGE = 2
  1283. };
  1284. struct uv_fs_event_s {
  1285. UV_HANDLE_FIELDS
  1286. /* private */
  1287. char* path;
  1288. UV_FS_EVENT_PRIVATE_FIELDS
  1289. };
  1290. /*
  1291. * uv_fs_stat() based polling file watcher.
  1292. */
  1293. struct uv_fs_poll_s {
  1294. UV_HANDLE_FIELDS
  1295. /* Private, don't touch. */
  1296. void* poll_ctx;
  1297. };
  1298. UV_EXTERN int uv_fs_poll_init(uv_loop_t* loop, uv_fs_poll_t* handle);
  1299. UV_EXTERN int uv_fs_poll_start(uv_fs_poll_t* handle,
  1300. uv_fs_poll_cb poll_cb,
  1301. const char* path,
  1302. unsigned int interval);
  1303. UV_EXTERN int uv_fs_poll_stop(uv_fs_poll_t* handle);
  1304. UV_EXTERN int uv_fs_poll_getpath(uv_fs_poll_t* handle,
  1305. char* buffer,
  1306. size_t* size);
  1307. struct uv_signal_s {
  1308. UV_HANDLE_FIELDS
  1309. uv_signal_cb signal_cb;
  1310. int signum;
  1311. UV_SIGNAL_PRIVATE_FIELDS
  1312. };
  1313. UV_EXTERN int uv_signal_init(uv_loop_t* loop, uv_signal_t* handle);
  1314. UV_EXTERN int uv_signal_start(uv_signal_t* handle,
  1315. uv_signal_cb signal_cb,
  1316. int signum);
  1317. UV_EXTERN int uv_signal_start_oneshot(uv_signal_t* handle,
  1318. uv_signal_cb signal_cb,
  1319. int signum);
  1320. UV_EXTERN int uv_signal_stop(uv_signal_t* handle);
  1321. UV_EXTERN void uv_loadavg(double avg[3]);
  1322. /*
  1323. * Flags to be passed to uv_fs_event_start().
  1324. */
  1325. enum uv_fs_event_flags {
  1326. /*
  1327. * By default, if the fs event watcher is given a directory name, we will
  1328. * watch for all events in that directory. This flags overrides this behavior
  1329. * and makes fs_event report only changes to the directory entry itself. This
  1330. * flag does not affect individual files watched.
  1331. * This flag is currently not implemented yet on any backend.
  1332. */
  1333. UV_FS_EVENT_WATCH_ENTRY = 1,
  1334. /*
  1335. * By default uv_fs_event will try to use a kernel interface such as inotify
  1336. * or kqueue to detect events. This may not work on remote filesystems such
  1337. * as NFS mounts. This flag makes fs_event fall back to calling stat() on a
  1338. * regular interval.
  1339. * This flag is currently not implemented yet on any backend.
  1340. */
  1341. UV_FS_EVENT_STAT = 2,
  1342. /*
  1343. * By default, event watcher, when watching directory, is not registering
  1344. * (is ignoring) changes in it's subdirectories.
  1345. * This flag will override this behaviour on platforms that support it.
  1346. */
  1347. UV_FS_EVENT_RECURSIVE = 4
  1348. };
  1349. UV_EXTERN int uv_fs_event_init(uv_loop_t* loop, uv_fs_event_t* handle);
  1350. UV_EXTERN int uv_fs_event_start(uv_fs_event_t* handle,
  1351. uv_fs_event_cb cb,
  1352. const char* path,
  1353. unsigned int flags);
  1354. UV_EXTERN int uv_fs_event_stop(uv_fs_event_t* handle);
  1355. UV_EXTERN int uv_fs_event_getpath(uv_fs_event_t* handle,
  1356. char* buffer,
  1357. size_t* size);
  1358. UV_EXTERN int uv_ip4_addr(const char* ip, int port, struct sockaddr_in* addr);
  1359. UV_EXTERN int uv_ip6_addr(const char* ip, int port, struct sockaddr_in6* addr);
  1360. UV_EXTERN int uv_ip4_name(const struct sockaddr_in* src, char* dst, size_t size);
  1361. UV_EXTERN int uv_ip6_name(const struct sockaddr_in6* src, char* dst, size_t size);
  1362. UV_EXTERN int uv_inet_ntop(int af, const void* src, char* dst, size_t size);
  1363. UV_EXTERN int uv_inet_pton(int af, const char* src, void* dst);
  1364. #if defined(IF_NAMESIZE)
  1365. # define UV_IF_NAMESIZE (IF_NAMESIZE + 1)
  1366. #elif defined(IFNAMSIZ)
  1367. # define UV_IF_NAMESIZE (IFNAMSIZ + 1)
  1368. #else
  1369. # define UV_IF_NAMESIZE (16 + 1)
  1370. #endif
  1371. UV_EXTERN int uv_if_indextoname(unsigned int ifindex,
  1372. char* buffer,
  1373. size_t* size);
  1374. UV_EXTERN int uv_if_indextoiid(unsigned int ifindex,
  1375. char* buffer,
  1376. size_t* size);
  1377. UV_EXTERN int uv_exepath(char* buffer, size_t* size);
  1378. UV_EXTERN int uv_cwd(char* buffer, size_t* size);
  1379. UV_EXTERN int uv_chdir(const char* dir);
  1380. UV_EXTERN uint64_t uv_get_free_memory(void);
  1381. UV_EXTERN uint64_t uv_get_total_memory(void);
  1382. UV_EXTERN uint64_t uv_get_constrained_memory(void);
  1383. UV_EXTERN uint64_t uv_hrtime(void);
  1384. UV_EXTERN void uv_disable_stdio_inheritance(void);
  1385. UV_EXTERN int uv_dlopen(const char* filename, uv_lib_t* lib);
  1386. UV_EXTERN void uv_dlclose(uv_lib_t* lib);
  1387. UV_EXTERN int uv_dlsym(uv_lib_t* lib, const char* name, void** ptr);
  1388. UV_EXTERN const char* uv_dlerror(const uv_lib_t* lib);
  1389. UV_EXTERN int uv_mutex_init(uv_mutex_t* handle);
  1390. UV_EXTERN int uv_mutex_init_recursive(uv_mutex_t* handle);
  1391. UV_EXTERN void uv_mutex_destroy(uv_mutex_t* handle);
  1392. UV_EXTERN void uv_mutex_lock(uv_mutex_t* handle);
  1393. UV_EXTERN int uv_mutex_trylock(uv_mutex_t* handle);
  1394. UV_EXTERN void uv_mutex_unlock(uv_mutex_t* handle);
  1395. UV_EXTERN int uv_rwlock_init(uv_rwlock_t* rwlock);
  1396. UV_EXTERN void uv_rwlock_destroy(uv_rwlock_t* rwlock);
  1397. UV_EXTERN void uv_rwlock_rdlock(uv_rwlock_t* rwlock);
  1398. UV_EXTERN int uv_rwlock_tryrdlock(uv_rwlock_t* rwlock);
  1399. UV_EXTERN void uv_rwlock_rdunlock(uv_rwlock_t* rwlock);
  1400. UV_EXTERN void uv_rwlock_wrlock(uv_rwlock_t* rwlock);
  1401. UV_EXTERN int uv_rwlock_trywrlock(uv_rwlock_t* rwlock);
  1402. UV_EXTERN void uv_rwlock_wrunlock(uv_rwlock_t* rwlock);
  1403. UV_EXTERN int uv_sem_init(uv_sem_t* sem, unsigned int value);
  1404. UV_EXTERN void uv_sem_destroy(uv_sem_t* sem);
  1405. UV_EXTERN void uv_sem_post(uv_sem_t* sem);
  1406. UV_EXTERN void uv_sem_wait(uv_sem_t* sem);
  1407. UV_EXTERN int uv_sem_trywait(uv_sem_t* sem);
  1408. UV_EXTERN int uv_cond_init(uv_cond_t* cond);
  1409. UV_EXTERN void uv_cond_destroy(uv_cond_t* cond);
  1410. UV_EXTERN void uv_cond_signal(uv_cond_t* cond);
  1411. UV_EXTERN void uv_cond_broadcast(uv_cond_t* cond);
  1412. UV_EXTERN int uv_barrier_init(uv_barrier_t* barrier, unsigned int count);
  1413. UV_EXTERN void uv_barrier_destroy(uv_barrier_t* barrier);
  1414. UV_EXTERN int uv_barrier_wait(uv_barrier_t* barrier);
  1415. UV_EXTERN void uv_cond_wait(uv_cond_t* cond, uv_mutex_t* mutex);
  1416. UV_EXTERN int uv_cond_timedwait(uv_cond_t* cond,
  1417. uv_mutex_t* mutex,
  1418. uint64_t timeout);
  1419. UV_EXTERN void uv_once(uv_once_t* guard, void (*callback)(void));
  1420. UV_EXTERN int uv_key_create(uv_key_t* key);
  1421. UV_EXTERN void uv_key_delete(uv_key_t* key);
  1422. UV_EXTERN void* uv_key_get(uv_key_t* key);
  1423. UV_EXTERN void uv_key_set(uv_key_t* key, void* value);
  1424. UV_EXTERN int uv_gettimeofday(uv_timeval64_t* tv);
  1425. typedef void (*uv_thread_cb)(void* arg);
  1426. UV_EXTERN int uv_thread_create(uv_thread_t* tid, uv_thread_cb entry, void* arg);
  1427. typedef enum {
  1428. UV_THREAD_NO_FLAGS = 0x00,
  1429. UV_THREAD_HAS_STACK_SIZE = 0x01
  1430. } uv_thread_create_flags;
  1431. struct uv_thread_options_s {
  1432. unsigned int flags;
  1433. size_t stack_size;
  1434. /* More fields may be added at any time. */
  1435. };
  1436. typedef struct uv_thread_options_s uv_thread_options_t;
  1437. UV_EXTERN int uv_thread_create_ex(uv_thread_t* tid,
  1438. const uv_thread_options_t* params,
  1439. uv_thread_cb entry,
  1440. void* arg);
  1441. UV_EXTERN uv_thread_t uv_thread_self(void);
  1442. UV_EXTERN int uv_thread_join(uv_thread_t *tid);
  1443. UV_EXTERN int uv_thread_equal(const uv_thread_t* t1, const uv_thread_t* t2);
  1444. /* The presence of these unions force similar struct layout. */
  1445. #define XX(_, name) uv_ ## name ## _t name;
  1446. union uv_any_handle {
  1447. UV_HANDLE_TYPE_MAP(XX)
  1448. };
  1449. union uv_any_req {
  1450. UV_REQ_TYPE_MAP(XX)
  1451. };
  1452. #undef XX
  1453. struct uv_loop_s {
  1454. /* User data - use this for whatever. */
  1455. void* data;
  1456. /* Loop reference counting. */
  1457. unsigned int active_handles;
  1458. void* handle_queue[2];
  1459. union {
  1460. void* unused[2];
  1461. unsigned int count;
  1462. } active_reqs;
  1463. /* Internal flag to signal loop stop. */
  1464. unsigned int stop_flag;
  1465. UV_LOOP_PRIVATE_FIELDS
  1466. };
  1467. UV_EXTERN void* uv_loop_get_data(const uv_loop_t*);
  1468. UV_EXTERN void uv_loop_set_data(uv_loop_t*, void* data);
  1469. /* Don't export the private CPP symbols. */
  1470. #undef UV_HANDLE_TYPE_PRIVATE
  1471. #undef UV_REQ_TYPE_PRIVATE
  1472. #undef UV_REQ_PRIVATE_FIELDS
  1473. #undef UV_STREAM_PRIVATE_FIELDS
  1474. #undef UV_TCP_PRIVATE_FIELDS
  1475. #undef UV_PREPARE_PRIVATE_FIELDS
  1476. #undef UV_CHECK_PRIVATE_FIELDS
  1477. #undef UV_IDLE_PRIVATE_FIELDS
  1478. #undef UV_ASYNC_PRIVATE_FIELDS
  1479. #undef UV_TIMER_PRIVATE_FIELDS
  1480. #undef UV_GETADDRINFO_PRIVATE_FIELDS
  1481. #undef UV_GETNAMEINFO_PRIVATE_FIELDS
  1482. #undef UV_FS_REQ_PRIVATE_FIELDS
  1483. #undef UV_WORK_PRIVATE_FIELDS
  1484. #undef UV_FS_EVENT_PRIVATE_FIELDS
  1485. #undef UV_SIGNAL_PRIVATE_FIELDS
  1486. #undef UV_LOOP_PRIVATE_FIELDS
  1487. #undef UV_LOOP_PRIVATE_PLATFORM_FIELDS
  1488. #undef UV__ERR
  1489. #ifdef __cplusplus
  1490. }
  1491. #endif
  1492. #endif /* UV_H */