Turn audio into a shareable video. forked from nypublicradio/audiogram

uv.h 62KB

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