uv.h 53 KB

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