summaryrefslogtreecommitdiffstatshomepage
path: root/3rdparty/libuv/docs/src/misc.rst
diff options
context:
space:
mode:
author ImJezze <jezze@gmx.net>2016-02-21 11:48:45 +0100
committer ImJezze <jezze@gmx.net>2016-02-21 11:48:45 +0100
commitcc24a339d8c0517259084b5c178d784626ba965c (patch)
tree9868e9687b5802ae0a3733712a3bbeb3bc75c953 /3rdparty/libuv/docs/src/misc.rst
parentb5daabda5495dea5c50e17961ecfed2ea8619d76 (diff)
Merge remote-tracking branch 'refs/remotes/mamedev/master'
Second attempt
Diffstat (limited to '3rdparty/libuv/docs/src/misc.rst')
-rw-r--r--3rdparty/libuv/docs/src/misc.rst328
1 files changed, 328 insertions, 0 deletions
diff --git a/3rdparty/libuv/docs/src/misc.rst b/3rdparty/libuv/docs/src/misc.rst
new file mode 100644
index 00000000000..2ce0887db0c
--- /dev/null
+++ b/3rdparty/libuv/docs/src/misc.rst
@@ -0,0 +1,328 @@
+
+.. _misc:
+
+Miscellaneous utilities
+=======================
+
+This section contains miscellaneous functions that don't really belong in any
+other section.
+
+
+Data types
+----------
+
+.. c:type:: uv_buf_t
+
+ Buffer data type.
+
+ .. c:member:: char* uv_buf_t.base
+
+ Pointer to the base of the buffer. Readonly.
+
+ .. c:member:: size_t uv_buf_t.len
+
+ Total bytes in the buffer. Readonly.
+
+ .. note::
+ On Windows this field is ULONG.
+
+.. c:type:: void* (*uv_malloc_func)(size_t size)
+
+ Replacement function for :man:`malloc(3)`.
+ See :c:func:`uv_replace_allocator`.
+
+.. c:type:: void* (*uv_realloc_func)(void* ptr, size_t size)
+
+ Replacement function for :man:`realloc(3)`.
+ See :c:func:`uv_replace_allocator`.
+
+.. c:type:: void* (*uv_calloc_func)(size_t count, size_t size)
+
+ Replacement function for :man:`calloc(3)`.
+ See :c:func:`uv_replace_allocator`.
+
+.. c:type:: void (*uv_free_func)(void* ptr)
+
+ Replacement function for :man:`free(3)`.
+ See :c:func:`uv_replace_allocator`.
+
+.. c:type:: uv_file
+
+ Cross platform representation of a file handle.
+
+.. c:type:: uv_os_sock_t
+
+ Cross platform representation of a socket handle.
+
+.. c:type:: uv_os_fd_t
+
+ Abstract representation of a file descriptor. On Unix systems this is a
+ `typedef` of `int` and on Windows a `HANDLE`.
+
+.. c:type:: uv_rusage_t
+
+ Data type for resource usage results.
+
+ ::
+
+ typedef struct {
+ uv_timeval_t ru_utime; /* user CPU time used */
+ uv_timeval_t ru_stime; /* system CPU time used */
+ uint64_t ru_maxrss; /* maximum resident set size */
+ uint64_t ru_ixrss; /* integral shared memory size */
+ uint64_t ru_idrss; /* integral unshared data size */
+ uint64_t ru_isrss; /* integral unshared stack size */
+ uint64_t ru_minflt; /* page reclaims (soft page faults) */
+ uint64_t ru_majflt; /* page faults (hard page faults) */
+ uint64_t ru_nswap; /* swaps */
+ uint64_t ru_inblock; /* block input operations */
+ uint64_t ru_oublock; /* block output operations */
+ uint64_t ru_msgsnd; /* IPC messages sent */
+ uint64_t ru_msgrcv; /* IPC messages received */
+ uint64_t ru_nsignals; /* signals received */
+ uint64_t ru_nvcsw; /* voluntary context switches */
+ uint64_t ru_nivcsw; /* involuntary context switches */
+ } uv_rusage_t;
+
+.. c:type:: uv_cpu_info_t
+
+ Data type for CPU information.
+
+ ::
+
+ typedef struct uv_cpu_info_s {
+ char* model;
+ int speed;
+ struct uv_cpu_times_s {
+ uint64_t user;
+ uint64_t nice;
+ uint64_t sys;
+ uint64_t idle;
+ uint64_t irq;
+ } cpu_times;
+ } uv_cpu_info_t;
+
+.. c:type:: uv_interface_address_t
+
+ Data type for interface addresses.
+
+ ::
+
+ typedef struct uv_interface_address_s {
+ char* name;
+ char phys_addr[6];
+ int is_internal;
+ union {
+ struct sockaddr_in address4;
+ struct sockaddr_in6 address6;
+ } address;
+ union {
+ struct sockaddr_in netmask4;
+ struct sockaddr_in6 netmask6;
+ } netmask;
+ } uv_interface_address_t;
+
+
+API
+---
+
+.. c:function:: uv_handle_type uv_guess_handle(uv_file file)
+
+ Used to detect what type of stream should be used with a given file
+ descriptor. Usually this will be used during initialization to guess the
+ type of the stdio streams.
+
+ For :man:`isatty(3)` equivalent functionality use this function and test
+ for ``UV_TTY``.
+
+.. c:function:: int uv_replace_allocator(uv_malloc_func malloc_func, uv_realloc_func realloc_func, uv_calloc_func calloc_func, uv_free_func free_func)
+
+ .. versionadded:: 1.6.0
+
+ Override the use of the standard library's :man:`malloc(3)`,
+ :man:`calloc(3)`, :man:`realloc(3)`, :man:`free(3)`, memory allocation
+ functions.
+
+ This function must be called before any other libuv function is called or
+ after all resources have been freed and thus libuv doesn't reference
+ any allocated memory chunk.
+
+ On success, it returns 0, if any of the function pointers is NULL it
+ returns UV_EINVAL.
+
+ .. warning:: There is no protection against changing the allocator multiple
+ times. If the user changes it they are responsible for making
+ sure the allocator is changed while no memory was allocated with
+ the previous allocator, or that they are compatible.
+
+.. c:function:: uv_buf_t uv_buf_init(char* base, unsigned int len)
+
+ Constructor for :c:type:`uv_buf_t`.
+
+ Due to platform differences the user cannot rely on the ordering of the
+ `base` and `len` members of the uv_buf_t struct. The user is responsible for
+ freeing `base` after the uv_buf_t is done. Return struct passed by value.
+
+.. c:function:: char** uv_setup_args(int argc, char** argv)
+
+ Store the program arguments. Required for getting / setting the process title.
+
+.. c:function:: int uv_get_process_title(char* buffer, size_t size)
+
+ Gets the title of the current process.
+
+.. c:function:: int uv_set_process_title(const char* title)
+
+ Sets the current process title.
+
+.. c:function:: int uv_resident_set_memory(size_t* rss)
+
+ Gets the resident set size (RSS) for the current process.
+
+.. c:function:: int uv_uptime(double* uptime)
+
+ Gets the current system uptime.
+
+.. c:function:: int uv_getrusage(uv_rusage_t* rusage)
+
+ Gets the resource usage measures for the current process.
+
+ .. note::
+ On Windows not all fields are set, the unsupported fields are filled with zeroes.
+
+.. c:function:: int uv_cpu_info(uv_cpu_info_t** cpu_infos, int* count)
+
+ Gets information about the CPUs on the system. The `cpu_infos` array will
+ have `count` elements and needs to be freed with :c:func:`uv_free_cpu_info`.
+
+.. c:function:: void uv_free_cpu_info(uv_cpu_info_t* cpu_infos, int count)
+
+ Frees the `cpu_infos` array previously allocated with :c:func:`uv_cpu_info`.
+
+.. c:function:: int uv_interface_addresses(uv_interface_address_t** addresses, int* count)
+
+ Gets address information about the network interfaces on the system. An
+ array of `count` elements is allocated and returned in `addresses`. It must
+ be freed by the user, calling :c:func:`uv_free_interface_addresses`.
+
+.. c:function:: void uv_free_interface_addresses(uv_interface_address_t* addresses, int count)
+
+ Free an array of :c:type:`uv_interface_address_t` which was returned by
+ :c:func:`uv_interface_addresses`.
+
+.. c:function:: void uv_loadavg(double avg[3])
+
+ Gets the load average. See: `<http://en.wikipedia.org/wiki/Load_(computing)>`_
+
+ .. note::
+ Returns [0,0,0] on Windows (i.e., it's not implemented).
+
+.. c:function:: int uv_ip4_addr(const char* ip, int port, struct sockaddr_in* addr)
+
+ Convert a string containing an IPv4 addresses to a binary structure.
+
+.. c:function:: int uv_ip6_addr(const char* ip, int port, struct sockaddr_in6* addr)
+
+ Convert a string containing an IPv6 addresses to a binary structure.
+
+.. c:function:: int uv_ip4_name(const struct sockaddr_in* src, char* dst, size_t size)
+
+ Convert a binary structure containing an IPv4 address to a string.
+
+.. c:function:: int uv_ip6_name(const struct sockaddr_in6* src, char* dst, size_t size)
+
+ Convert a binary structure containing an IPv6 address to a string.
+
+.. c:function:: int uv_inet_ntop(int af, const void* src, char* dst, size_t size)
+.. c:function:: int uv_inet_pton(int af, const char* src, void* dst)
+
+ Cross-platform IPv6-capable implementation of :man:`inet_ntop(3)`
+ and :man:`inet_pton(3)`. On success they return 0. In case of error
+ the target `dst` pointer is unmodified.
+
+.. c:function:: int uv_exepath(char* buffer, size_t* size)
+
+ Gets the executable path.
+
+.. c:function:: int uv_cwd(char* buffer, size_t* size)
+
+ Gets the current working directory.
+
+ .. versionchanged:: 1.1.0
+
+ On Unix the path no longer ends in a slash.
+
+.. c:function:: int uv_chdir(const char* dir)
+
+ Changes the current working directory.
+
+.. c:function:: int uv_os_homedir(char* buffer, size_t* size)
+
+ Gets the current user's home directory. On Windows, `uv_os_homedir()` first
+ checks the `USERPROFILE` environment variable using
+ `GetEnvironmentVariableW()`. If `USERPROFILE` is not set,
+ `GetUserProfileDirectoryW()` is called. On all other operating systems,
+ `uv_os_homedir()` first checks the `HOME` environment variable using
+ :man:`getenv(3)`. If `HOME` is not set, :man:`getpwuid_r(3)` is called. The
+ user's home directory is stored in `buffer`. When `uv_os_homedir()` is
+ called, `size` indicates the maximum size of `buffer`. On success or
+ `UV_ENOBUFS` failure, `size` is set to the string length of `buffer`.
+
+ .. warning::
+ `uv_os_homedir()` is not thread safe.
+
+ .. versionadded:: 1.6.0
+
+.. uint64_t uv_get_free_memory(void)
+.. c:function:: uint64_t uv_get_total_memory(void)
+
+ Gets memory information (in bytes).
+
+.. c:function:: uint64_t uv_hrtime(void)
+
+ Returns the current high-resolution real time. This is expressed in
+ nanoseconds. It is relative to an arbitrary time in the past. It is not
+ related to the time of day and therefore not subject to clock drift. The
+ primary use is for measuring performance between intervals.
+
+ .. note::
+ Not every platform can support nanosecond resolution; however, this value will always
+ be in nanoseconds.
+
+.. c:function:: void uv_print_all_handles(uv_loop_t* loop, FILE* stream)
+
+ Prints all handles associated with the given `loop` to the given `stream`.
+
+ Example:
+
+ ::
+
+ uv_print_all_handles(uv_default_loop(), stderr);
+ /*
+ [--I] signal 0x1a25ea8
+ [-AI] async 0x1a25cf0
+ [R--] idle 0x1a7a8c8
+ */
+
+ The format is `[flags] handle-type handle-address`. For `flags`:
+
+ - `R` is printed for a handle that is referenced
+ - `A` is printed for a handle that is active
+ - `I` is printed for a handle that is internal
+
+ .. warning::
+ This function is meant for ad hoc debugging, there is no API/ABI
+ stability guarantees.
+
+ .. versionadded:: 1.8.0
+
+.. c:function:: void uv_print_active_handles(uv_loop_t* loop, FILE* stream)
+
+ This is the same as :c:func:`uv_print_all_handles` except only active handles
+ are printed.
+
+ .. warning::
+ This function is meant for ad hoc debugging, there is no API/ABI
+ stability guarantees.
+
+ .. versionadded:: 1.8.0